wikimedia/mediawiki-extensions-Wikibase

<?php

declare( strict_types = 1 );

namespace Wikibase\Repo\Content;

use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Title\Title;
use OutOfBoundsException;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\EntityIdParsingException;
use Wikibase\Lib\Store\EntityIdLookup;
use Wikibase\Lib\Store\StorageException;

/**
 * Implementation of EntityIdLookup that uses content handler.
 *
 * @license GPL-2.0-or-later
 */
class ContentHandlerEntityIdLookup implements EntityIdLookup {
    /**
     * @var EntityContentFactory
     */
    private $entityContentFactory;

    /**
     * @var HookContainer
     */
    private $hookContainer;

    public function __construct(
        EntityContentFactory $entityContentFactory,
        HookContainer $hookContainer
    ) {
        $this->entityContentFactory = $entityContentFactory;
        $this->hookContainer = $hookContainer;
    }

    /**
     * Returns the ID of the entity associated with the given page title.
     *
     * @note There is no guarantee that the EntityId returned by this method refers to
     * an existing entity.
     */
    public function getEntityIdForTitle( Title $title ): ?EntityId {
        $contentModel = $title->getContentModel();

        $this->hookContainer->run( 'GetEntityContentModelForTitle', [ $title, &$contentModel ] );

        try {
            $handler = $this->entityContentFactory->getEntityHandlerForContentModel( $contentModel );
            return $handler->getIdForTitle( $title );
        } catch ( OutOfBoundsException $ex ) {
            // Not an entity content model
        } catch ( EntityIdParsingException $ex ) {
            // @phan-suppress-previous-line PhanPluginDuplicateCatchStatementBody
            // Not a valid entity page title.
        }

        return null;
    }

    /**
     * @see EntityIdLookup::getEntityIds
     *
     * @note the current implementation skips non-existing entities, but there is no guarantee
     * that this will always be the case.
     *
     * @param Title[] $titles
     *
     * @throws StorageException
     * @return EntityId[] Entity IDs, keyed by page IDs.
     */
    public function getEntityIds( array $titles ): array {
        $entityIds = [];

        foreach ( $titles as $title ) {
            $pageId = $title->getArticleID();

            if ( $pageId > 0 ) {
                $entityId = $this->getEntityIdForTitle( $title );

                if ( $entityId !== null ) {
                    $entityIds[$pageId] = $entityId;
                }
            }
        }

        return $entityIds;
    }

}