Mediawiki\Api\Service\PagePurger

Complexity

Total Complexity

5

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

42.11%

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	purge()	0	7	1
A	purgePages()	0	9	2
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
	 *
	 * @param Page $page
	 *
	 * @return bool
	 */
	public function purge( Page $page ) {
		$this->api->postRequest(
			new SimpleRequest( 'purge', [ 'pageids' => $page->getId() ] )

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

		);

		return true;
	}

	/**
	 * @since 0.x
	 *
	 * @param Pages $pages
	 *
	 * @return bool
	 *
	 */
	public function purgePages( Pages $pages ) {
		$pagesArray = $pages->toArray();

		foreach ( $pagesArray as $page ) {
			$this->purge( $page );
		}

		return true;
	}

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

		return true;
	}

}