Pages
Extends AbstractMediawikiObjectMediaWiki API Pages class.
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : mixed
| since |
1.0 |
|---|
Arguments
- options
\Joomla\Registry\RegistryMediawiki options object.- client
\Joomla\Mediawiki\HttpThe HTTP client object.
Response
mixed
buildParameter
Method to build request parameters from a string array.
buildParameter(array params) : string
| since |
1.0 |
|---|
Arguments
- params
arraystring array that contains the parameters
Response
stringrequest parameter
changeProtection
Method to change the protection level of a page.
changeProtection(string title, string protections, string expiry = null, string reason = null, string cascade = null, string watchlist = null) : object
| since |
1.0 |
|---|
Arguments
- title
stringTitle of the page you want to (un)protect.- protections
stringPipe-separated list of protection levels.- expiry
stringExpiry timestamps.- reason
stringReason for (un)protecting (optional).- cascade
stringEnable cascading protection.- watchlist
stringUnconditionally add or remove the page from your watchlist.
Response
object
deletePageByID
Method to delete a page.
deletePageByID(string pageid, string reason = null, string watchlist = null, string oldimage = null) : object
| since |
1.0 |
|---|
Arguments
- pageid
stringPage ID of the page you want to delete.- reason
stringReason for the deletion.- watchlist
stringUnconditionally add or remove the page from your watchlist.- oldimage
stringThe name of the old image to delete.
Response
object
deletePageByName
Method to delete a page.
deletePageByName(string title, string reason = null, string watchlist = null, string oldimage = null) : object
| since |
1.0 |
|---|
Arguments
- title
stringTitle of the page you want to delete.- reason
stringReason for the deletion.- watchlist
stringUnconditionally add or remove the page from your watchlist.- oldimage
stringThe name of the old image to delete.
Response
object
editPage
Method to edit a page.
editPage(string title, int section = null, string sectiontitle = null, string text = null, string summary = null) : object
| since |
1.0 |
|---|
Arguments
- title
stringPage title.- section
intSection number.- sectiontitle
stringThe title for a new section.- text
stringPage content.- summary
stringTitle of the page you want to delete.
Response
object
fetchUrl
Method to build and return a full request URL for the request.
fetchUrl(string path) : string
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect
Response
stringThe request URL.
getBackLinks
Method to get all pages that link to the given page.
getBackLinks(string bltitle, int blpageid = null, bool blcontinue = null, array blnamespace = null, string blfilterredirect = null, int bllimit = null, bool blredirect = null) : object
| since |
1.0 |
|---|
Arguments
- bltitle
stringTitle to search.- blpageid
intPageid to search.- blcontinue
boolWhen more results are available, use this to continue.- blnamespace
arrayThe namespace to enumerate.- blfilterredirect
stringHow to filter for redirects..- bllimit
intHow many total pages to return.- blredirect
boolIf linking page is a redirect, find all pages that link to that redirect as well.
Response
object
getIWBackLinks
Method to get all pages that link to the given interwiki link.
getIWBackLinks(string iwbltitle, string iwblprefix = null, bool iwblcontinue = null, int iwbllimit = null, array iwblprop = null) : object
| since |
1.0 |
|---|
Arguments
- iwbltitle
stringInterwiki link to search for. Must be used with iwblprefix.- iwblprefix
stringPrefix for the interwiki.- iwblcontinue
boolWhen more results are available, use this to continue.- iwbllimit
intHow many total pages to return.- iwblprop
arrayWhich properties to get.
Response
object
getPageInfo
Method to get basic page information.
getPageInfo(array titles, array inprop = null, array intoken = null, bool incontinue = null) : object
| since |
1.0 |
|---|
Arguments
- titles
arrayPage titles to retrieve info.- inprop
arrayWhich additional properties to get.- intoken
arrayRequest a token to perform a data-modifying action on a page- incontinue
boolWhen more results are available, use this to continue.
Response
object
getPageProperties
Method to get various properties defined in the page content.
getPageProperties(array titles, bool ppcontinue = null, string ppprop = null) : object
| since |
1.0 |
|---|
Arguments
- titles
arrayPage titles to retrieve properties.- ppcontinue
boolWhen more results are available, use this to continue.- ppprop
stringPage prop to look on the page for.
Response
object
getPageTemplates
Method to get all page templates from the given page.
getPageTemplates(array titles, array tlnamespace = null, int tllimit = null, bool tlcontinue = null, string tltemplates = null, string tldir = null) : object
| since |
1.0 |
|---|
Arguments
- titles
arrayPage titles to retrieve templates.- tlnamespace
arrayShow templates in this namespace(s) only.- tllimit
intHow many templates to return.- tlcontinue
boolWhen more results are available, use this to continue.- tltemplates
stringOnly list these templates.- tldir
stringThe direction in which to list.
Response
object
getRevisions
Method to get a list of revisions.
getRevisions(array titles, array rvprop = null, bool rvparse = null, int rvlimit = null) : object
| since |
1.0 |
|---|
Arguments
- titles
arrayPage titles to retrieve revisions.- rvprop
arrayWhich properties to get for each revision.- rvparse
boolParse revision content.- rvlimit
intLimit how many revisions will be returned.
Response
object
getToken
Method to get access token.
getToken(string user, string intoken) : object
| since |
1.0 |
|---|
Arguments
- user
stringThe User to get token.- intoken
stringThe type of token.
Response
object
movePageByID
Method to move a page.
movePageByID(int fromid, string to, string reason = null, string movetalk = null, string movesubpages = null, bool noredirect = null, string watchlist = null, bool ignorewarnings = null) : object
| since |
1.0 |
|---|
Arguments
- fromid
intPage ID of the page you want to move.- to
stringTitle you want to rename the page to.- reason
stringReason for the move (optional).- movetalk
stringMove the talk page, if it exists.- movesubpages
stringMove subpages, if applicable.- noredirect
boolDon't create a redirect.- watchlist
stringUnconditionally add or remove the page from your watchlist.- ignorewarnings
boolIgnore any warnings.
Response
object
movePageByName
Method to move a page.
movePageByName(string from, string to, string reason = null, string movetalk = null, string movesubpages = null, bool noredirect = null, string watchlist = null, bool ignorewarnings = null) : object
| since |
1.0 |
|---|
Arguments
- from
stringTitle of the page you want to move.- to
stringTitle you want to rename the page to.- reason
stringReason for the move (optional).- movetalk
stringMove the talk page, if it exists.- movesubpages
stringMove subpages, if applicable.- noredirect
boolDon't create a redirect.- watchlist
stringUnconditionally add or remove the page from your watchlist.- ignorewarnings
boolIgnore any warnings.
Response
object
rollback
Method to undo the last edit to the page.
rollback(string title, string user, string summary = null, string markbot = null, string watchlist = null) : object
| since |
1.0 |
|---|
Arguments
- title
stringTitle of the page you want to rollback.- user
stringName of the user whose edits are to be rolled back.- summary
stringCustom edit summary. If not set, default summary will be used.- markbot
stringMark the reverted edits and the revert as bot edits.- watchlist
stringUnconditionally add or remove the page from your watchlist.
Response
object
undeletePage
Method to restore certain revisions of a deleted page.
undeletePage(string title, string reason = null, string timestamp = null, string watchlist = null) : object
| since |
1.0 |
|---|
Arguments
- title
stringTitle of the page you want to restore.- reason
stringReason for restoring (optional).- timestamp
stringTimestamps of the revisions to restore.- watchlist
stringUnconditionally add or remove the page from your watchlist.
Response
object
validateResponse
Method to validate response for errors
validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- response
\Joomla\Http\ResponseThe response from the mediawiki server.
Response
\SimpleXMLElement
Properties
options
Options for the Mediawiki object.
| since |
1.0 |
|---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Http