diff options
Diffstat (limited to 'bin/wiki/vendor/addwiki/mediawiki-api/docs/page_purger.rst')
-rw-r--r-- | bin/wiki/vendor/addwiki/mediawiki-api/docs/page_purger.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/bin/wiki/vendor/addwiki/mediawiki-api/docs/page_purger.rst b/bin/wiki/vendor/addwiki/mediawiki-api/docs/page_purger.rst new file mode 100644 index 00000000..84cd7523 --- /dev/null +++ b/bin/wiki/vendor/addwiki/mediawiki-api/docs/page_purger.rst @@ -0,0 +1,34 @@ +Page Purger +=========== + +``PagePurger`` allows you to purge a single ``Page`` or multiple ``Pages``. +You can also check whether the ``Page`` or ``Pages`` have been purged successfully. + +To get started you need to create ``PagePurger`` object: + +.. code-block:: php + +$api = new \Mediawiki\Api\MediawikiApi( 'http://localhost/w/api.php' ); +$pagePurger = new \Mediawiki\Api\Service\PagePurger( $api ); + +Purge +----- + +Purge a single ``Page``. It will return a ``boolean`` that indicates if the purge operation was successful. + +Example: + +.. code-block:: php + +$page = new \Mediawiki\DataModel\Page(...); +$pagePurger->purge( $page ); + +PurgePages +---------- + +Purges every ``Page`` in the ``Pages`` object at once. It will return a new ``Pages`` object *with the purged ``Page``(s) only!* + +.. code-block:: php + +$pages = new \Mediawiki\DataModel\Pages(...); +$pagePurger->purgePages( $pages ); |