wikimedia/mediawiki-core

<?php
/**
 * Factory to create LinkBatch objects for querying page existence.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Cache
 */

namespace MediaWiki\Cache;

use MediaWiki\Language\Language;
use MediaWiki\Linker\LinksMigration;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\PageReference;
use MediaWiki\Title\TitleFormatter;
use Psr\Log\LoggerInterface;
use Wikimedia\Rdbms\IConnectionProvider;

/**
 * @ingroup Cache
 * @since 1.35
 */
class LinkBatchFactory {

    /**
     * @var LinkCache
     */
    private $linkCache;

    /**
     * @var TitleFormatter
     */
    private $titleFormatter;

    /**
     * @var Language
     */
    private $contentLanguage;

    /**
     * @var GenderCache
     */
    private $genderCache;

    /**
     * @var IConnectionProvider
     */
    private $dbProvider;

    /** @var LinksMigration */
    private $linksMigration;

    /** @var LoggerInterface */
    private $logger;

    public function __construct(
        LinkCache $linkCache,
        TitleFormatter $titleFormatter,
        Language $contentLanguage,
        GenderCache $genderCache,
        IConnectionProvider $dbProvider,
        LinksMigration $linksMigration,
        LoggerInterface $logger
    ) {
        $this->linkCache = $linkCache;
        $this->titleFormatter = $titleFormatter;
        $this->contentLanguage = $contentLanguage;
        $this->genderCache = $genderCache;
        $this->dbProvider = $dbProvider;
        $this->linksMigration = $linksMigration;
        $this->logger = $logger;
    }

    /**
     * @param iterable<LinkTarget>|iterable<PageReference> $initialItems items to be added
     *
     * @return LinkBatch
     */
    public function newLinkBatch( iterable $initialItems = [] ): LinkBatch {
        return new LinkBatch(
            $initialItems,
            $this->linkCache,
            $this->titleFormatter,
            $this->contentLanguage,
            $this->genderCache,
            $this->dbProvider,
            $this->linksMigration,
            $this->logger
        );
    }
}