addwiki / wikibase-api

src/Api/Service/RevisionsGetter.php

<?php

namespace Wikibase\Api\Service;

use Deserializers\Deserializer;
use InvalidArgumentException;
use Mediawiki\Api\MediawikiApi;
use Mediawiki\Api\SimpleRequest;
use Mediawiki\DataModel\PageIdentifier;
use Mediawiki\DataModel\Revision;
use Mediawiki\DataModel\Revisions;
use RuntimeException;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\Item;
use Wikibase\DataModel\Entity\Property;
use Wikibase\DataModel\ItemContent;
use Wikibase\DataModel\PropertyContent;
use Wikibase\DataModel\SiteLink;

/**
 * @access private
 *
 * @author Addshore
 */
class RevisionsGetter {

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

	/**
	 * @var Deserializer
	 */
	private $entityDeserializer;

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

	/**
	 * Get revisions for the entities identified using as few requests as possible.
	 *
	 * @param array $identifyingInfoArray Can include the following:
	 *     EntityId EntityId objects
	 *     SiteLink SiteLink objects
	 *     string Serialized entity ids (these are not validated before passing to the api)
	 *
	 * @since 0.4
	 *
	 * @return Revisions
	 */
	public function getRevisions( array $identifyingInfoArray ) {
		$entityIdStrings = array();
		$siteLinksStringMapping = array();

		foreach( $identifyingInfoArray as $someInfo ) {
			if( $someInfo instanceof EntityId ) {
				$entityIdStrings[] = $someInfo->getSerialization();
			} elseif ( $someInfo instanceof SiteLink ) {
				$siteLinksStringMapping[ $someInfo->getSiteId() ][] = $someInfo->getPageName();
			} elseif( is_string( $someInfo ) ) {
				$entityIdStrings[] = $someInfo;
			} else {
				throw new InvalidArgumentException( 'Unexpected $identifyingInfoArray in RevisionsGetter::getRevisions' );
			}
		}

		// The below makes as few requests as possible to get the Revisions required!
		$gotRevisionsFromIds = false;
		$revisions = new Revisions();
		if( !empty( $siteLinksStringMapping ) ) {
			foreach( $siteLinksStringMapping as $site => $siteLinkStrings ) {
				$params = array( 'sites' => $site );
				if( !$gotRevisionsFromIds && !empty( $entityIdStrings ) ) {
					$params['ids'] = implode( '|', $entityIdStrings );
					$gotRevisionsFromIds = true;
				}
				$params['titles'] = implode( '|', $siteLinkStrings );
				$result = $this->api->getRequest( new SimpleRequest( 'wbgetentities', $params ) );
				$resultRevisions = $this->newRevisionsFromResult( $result['entities'] );
				$revisions->addRevisions( $resultRevisions );

			}
		} else {
			$params = array( 'ids' => implode( '|', $entityIdStrings ) );
			$result = $this->api->getRequest( new SimpleRequest( 'wbgetentities', $params ) );
			$resultRevisions = $this->newRevisionsFromResult( $result['entities'] );
			$revisions->addRevisions( $resultRevisions );
		}

		return $revisions;
	}

	/**
	 * @param array $entitiesResult
	 * @returns Revisions
	 * @todo this could be factored into a different class?
	 */
	private function newRevisionsFromResult( array $entitiesResult ) {
		$revisions = new Revisions();
		foreach( $entitiesResult as $entityResult ) {
			if( array_key_exists( 'missing', $entityResult ) ) {
				continue;
			}
			$revisions->addRevision( new Revision(
				$this->getContentFromEntity( $this->entityDeserializer->deserialize( $entityResult ) ),
				new PageIdentifier( null, $entityResult['pageid'] ),
				$entityResult['lastrevid'],
				null,
				null,
				$entityResult['modified']
			) );
		}
		return $revisions;
	}

	/**
	 * @param Item|Property $entity
	 *
	 * @throws RuntimeException
	 * @return ItemContent|PropertyContent
	 * @todo this could be factored into a different class?
	 */
	private function getContentFromEntity( $entity ) {
		switch ( $entity->getType() ) {
			case Item::ENTITY_TYPE:
				return new ItemContent( $entity );

It seems like $entity defined by parameter $entity on line 130 can also be of type object<Wikibase\DataModel\Entity\Property>; however, Wikibase\DataModel\ItemContent::__construct() does only seem to accept object<Wikibase\DataModel\Entity\Item>, maybe add an additional type check?

			case Property::ENTITY_TYPE:
				return new PropertyContent( $entity );

It seems like $entity defined by parameter $entity on line 130 can also be of type object<Wikibase\DataModel\Entity\Item>; however, Wikibase\DataModel\PropertyContent::__construct() does only seem to accept object<Wikibase\DataModel\Entity\Property>, maybe add an additional type check?

			default:
				throw new RuntimeException( 'I cant get a content for this type of entity' );
		}
	}

}