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\Registry
Mediawiki options object.- client
\Joomla\Mediawiki\Http
The HTTP client object.
Response
mixed
buildParameter
Method to build request parameters from a string array.
buildParameter(array params) : string
since |
1.0 |
---|
Arguments
- params
array
string array that contains the parameters
Response
string
request 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
string
Title of the page you want to (un)protect.- protections
string
Pipe-separated list of protection levels.- expiry
string
Expiry timestamps.- reason
string
Reason for (un)protecting (optional).- cascade
string
Enable cascading protection.- watchlist
string
Unconditionally 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
string
Page ID of the page you want to delete.- reason
string
Reason for the deletion.- watchlist
string
Unconditionally add or remove the page from your watchlist.- oldimage
string
The 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
string
Title of the page you want to delete.- reason
string
Reason for the deletion.- watchlist
string
Unconditionally add or remove the page from your watchlist.- oldimage
string
The 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
string
Page title.- section
int
Section number.- sectiontitle
string
The title for a new section.- text
string
Page content.- summary
string
Title 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
string
URL to inflect
Response
string
The 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
string
Title to search.- blpageid
int
Pageid to search.- blcontinue
bool
When more results are available, use this to continue.- blnamespace
array
The namespace to enumerate.- blfilterredirect
string
How to filter for redirects..- bllimit
int
How many total pages to return.- blredirect
bool
If 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
string
Interwiki link to search for. Must be used with iwblprefix.- iwblprefix
string
Prefix for the interwiki.- iwblcontinue
bool
When more results are available, use this to continue.- iwbllimit
int
How many total pages to return.- iwblprop
array
Which 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
array
Page titles to retrieve info.- inprop
array
Which additional properties to get.- intoken
array
Request a token to perform a data-modifying action on a page- incontinue
bool
When 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
array
Page titles to retrieve properties.- ppcontinue
bool
When more results are available, use this to continue.- ppprop
string
Page 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
array
Page titles to retrieve templates.- tlnamespace
array
Show templates in this namespace(s) only.- tllimit
int
How many templates to return.- tlcontinue
bool
When more results are available, use this to continue.- tltemplates
string
Only list these templates.- tldir
string
The 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
array
Page titles to retrieve revisions.- rvprop
array
Which properties to get for each revision.- rvparse
bool
Parse revision content.- rvlimit
int
Limit 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
string
The User to get token.- intoken
string
The 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
int
Page ID of the page you want to move.- to
string
Title you want to rename the page to.- reason
string
Reason for the move (optional).- movetalk
string
Move the talk page, if it exists.- movesubpages
string
Move subpages, if applicable.- noredirect
bool
Don't create a redirect.- watchlist
string
Unconditionally add or remove the page from your watchlist.- ignorewarnings
bool
Ignore 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
string
Title of the page you want to move.- to
string
Title you want to rename the page to.- reason
string
Reason for the move (optional).- movetalk
string
Move the talk page, if it exists.- movesubpages
string
Move subpages, if applicable.- noredirect
bool
Don't create a redirect.- watchlist
string
Unconditionally add or remove the page from your watchlist.- ignorewarnings
bool
Ignore 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
string
Title of the page you want to rollback.- user
string
Name of the user whose edits are to be rolled back.- summary
string
Custom edit summary. If not set, default summary will be used.- markbot
string
Mark the reverted edits and the revert as bot edits.- watchlist
string
Unconditionally 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
string
Title of the page you want to restore.- reason
string
Reason for restoring (optional).- timestamp
string
Timestamps of the revisions to restore.- watchlist
string
Unconditionally 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\Response
The 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