Mediawiki\Api\Service\PagePurger

Complexity

Total Complexity

9

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

85.71%

Importance

Changes	7
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	purge()	0	10	1
B	purgePages()	0	43	6
A	purgeGenerator()	0	7	1

<?php

namespace Mediawiki\Api\Service;

use Mediawiki\Api\Generator\ApiGenerator;
use Mediawiki\Api\MediawikiApi;
use Mediawiki\Api\SimpleRequest;
use Mediawiki\DataModel\Pages;
use Mediawiki\DataModel\Page;

/**
 * @access private
 *
 * @author Addshore
 * @author Thomas Arrow
 */
class PagePurger {

	/**
	 * @var MediawikiApi
	 */
	private $api;

	/**
	 * @param MediawikiApi $api
	 */
	public function __construct( MediawikiApi $api ) {
		$this->api = $api;
	}

	/**
	 * @since 0.3
	 *
	 * @brief Purge a single page
	 *
	 * Purges a single page by submitting a
	 * 'purge' action to the mediawiki api
	 * with the parameter 'pageids' set to
	 * the singe page id
	 *
	 * @param Page $page the page that is going to be purged
	 *
	 * @return bool return true if the purge was successful
	 */
	public function purge( Page $page ) {
		$responseArray = $this->api->postRequest(
			new SimpleRequest( 'purge', [ 'pageids' => $page->getId() ] )

The method Mediawiki\DataModel\Page::getId() has been deprecated with message: since 0.5

		);

		// the purge response for the page
		$purgeResponse = $responseArray['purge'][0];

		return array_key_exists( 'purged', $purgeResponse );
	}

	/**
	 * @since 0.7
	 *
	 * @brief Purge multiple pages
	 *
	 * Purges all the pages of the Pages object
	 * by submitting a 'purge' action to the mediawiki
	 * api with the parameter 'pageids' set to be the
	 * pages ids in multiple-value seperation.
	 *
	 * @param Pages $pages the pages that are going to be purged
	 *
	 * @return Pages the pages that have been purged successfully
	 */
	public function purgePages( Pages $pages ) {
		$pagesArray = $pages->toArray();
		$pagesIds = [];

		foreach ( $pagesArray as $page ) {
			array_push( $pagesIds, $page->getId() );

The method Mediawiki\DataModel\Page::getId() has been deprecated with message: since 0.5

		}

		// convert an array to multiple-value format
		// because the mediawiki api require multiple
		// values to be seperated like the example
		// ex: [111, 222, 333] => "111|222|333"
		$pageIdsMultiple = implode( '|', $pagesIds );

		$responseArray = $this->api->postRequest(
			new SimpleRequest( 'purge', [ 'pageids' => $pageIdsMultiple ] )
		);

		// array that will hold the successfully purged pages
		$purgedPages = new Pages();

		// for every purge result
		foreach ( $responseArray['purge'] as $purgeResponse ) {
			// if the purge for the page was successful
			if ( array_key_exists( 'purged', $purgeResponse ) ) {
				// we iterate all the input pages
				foreach ( $pagesArray as $page ) {
					// and if the page from the input was successfully purged
					if ( $purgeResponse['title'] === $page->getTitle()->getText() ) {

The method Mediawiki\DataModel\Page::getTitle() has been deprecated with message: since 0.5

						// add it in the purgedPages object
						$purgedPages->addPage( $page );

						break;
					}

				}

			}

		}

		return $purgedPages;
	}

	/**
	 * @since 0.6
	 *
	 * @param ApiGenerator $generator
	 *
	 * @return bool
	 */
	public function purgeGenerator( ApiGenerator $generator ) {
		$this->api->postRequest(
			new SimpleRequest( 'purge', $generator->getParams() )
		);

		return true;
	}

}