4 * API for MediaWiki 1.14+
6 * Created on Sep 2, 2008
8 * Copyright © 2008 Chad Horohoe
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
28 if ( !defined( 'MEDIAWIKI' ) ) {
29 require_once( 'ApiBase.php' );
33 * API interface for page purging
36 class ApiPurge
extends ApiBase
{
38 public function __construct( $main, $action ) {
39 parent
::__construct( $main, $action );
43 * Purges the cache of a page
45 public function execute() {
47 $params = $this->extractRequestParams();
48 if ( !$wgUser->isAllowed( 'purge' ) && !$this->getMain()->isInternalMode() &&
49 !$this->getMain()->getRequest()->wasPosted() ) {
50 $this->dieUsageMsg( array( 'mustbeposted', $this->getModuleName() ) );
53 foreach ( $params['titles'] as $t ) {
55 $title = Title
::newFromText( $t );
56 if ( !$title instanceof Title
) {
62 ApiQueryBase
::addTitleInfo( $r, $title );
63 if ( !$title->exists() ) {
68 $article = MediaWiki
::articleFromTitle( $title );
69 $article->doPurge(); // Directly purge and skip the UI part of purge().
73 $this->getResult()->setIndexedTagName( $result, 'page' );
74 $this->getResult()->addValue( null, $this->getModuleName(), $result );
77 public function isWriteMode() {
81 public function getAllowedParams() {
84 ApiBase
::PARAM_ISMULTI
=> true,
85 ApiBase
::PARAM_REQUIRED
=> true
90 public function getParamDescription() {
92 'titles' => 'A list of titles',
96 public function getDescription() {
97 return array( 'Purge the cache for the given titles.',
98 'This module requires a POST request if the user is not logged in.'
102 public function getPossibleErrors() {
103 return array_merge( parent
::getPossibleErrors(), array(
104 array( 'cantpurge' ),
108 protected function getExamples() {
110 'api.php?action=purge&titles=Main_Page|API'
114 public function getVersion() {
115 return __CLASS__
. ': $Id$';