WikiPageFactory.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Page;
 
use DBAccessObjectUtils;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\Hook\WikiPageFactoryHook;
use stdClass;
use Title;
use TitleFactory;
use WikiCategoryPage;
use WikiFilePage;
use Wikimedia\Rdbms\ILoadBalancer;
use WikiPage;
 
class WikiPageFactory {
    private $titleFactory;
    private $wikiPageFactoryHookRunner;
    private $loadBalancer;
 
    public function __construct(
        TitleFactory $titleFactory,
        WikiPageFactoryHook $wikiPageFactoryHookRunner,
        ILoadBalancer $loadBalancer
    ) {
        $this->titleFactory = $titleFactory;
        $this->wikiPageFactoryHookRunner = $wikiPageFactoryHookRunner;
        $this->loadBalancer = $loadBalancer;
    }
 
    public function newFromTitle( PageIdentity $pageIdentity ): WikiPage {
        if ( $pageIdentity instanceof WikiPage ) {
            return $pageIdentity;
        }
 
        if ( !$pageIdentity->canExist() ) {
            // BC with the Title class
            throw new PageAssertionException(
                'The given PageIdentity {pageIdentity} does not represent a proper page',
                [ 'pageIdentity' => $pageIdentity ]
            );
        }
 
        $ns = $pageIdentity->getNamespace();
 
        // TODO: remove the need for casting to Title. We'll have to create a new hook to
        //       replace the WikiPageFactory hook.
        $title = Title::castFromPageIdentity( $pageIdentity );
        '@phan-var Title $title';
 
        $page = null;
        if ( !$this->wikiPageFactoryHookRunner->onWikiPageFactory( $title, $page ) ) {
            return $page;
        }
 
        switch ( $ns ) {
            case NS_FILE:
                $page = new WikiFilePage( $title );
                break;
            case NS_CATEGORY:
                $page = new WikiCategoryPage( $title );
                break;
            default:
                $page = new WikiPage( $title );
        }
 
        return $page;
    }
 
    public function newFromLinkTarget( LinkTarget $title ): WikiPage {
        return $this->newFromTitle( $this->titleFactory->newFromLinkTarget( $title ) );
    }
 
    public function newFromRow( $row, $from = 'fromdb' ) {
        $page = $this->newFromTitle( $this->titleFactory->newFromRow( $row ) );
        $page->loadFromRow( $row, $from );
        return $page;
    }
 
    public function newFromID( $id, $from = 'fromdb' ) {
        // page ids are never 0 or negative, see T63166
        if ( $id < 1 ) {
            return null;
        }
 
        $from = WikiPage::convertSelectType( $from );
        [ $index ] = DBAccessObjectUtils::getDBOptions( $from );
        $db = $this->loadBalancer->getMaintenanceConnectionRef( $index );
        $pageQuery = WikiPage::getQueryInfo();
        $row = $db->selectRow(
            $pageQuery['tables'], $pageQuery['fields'], [ 'page_id' => $id ], __METHOD__,
            [], $pageQuery['joins']
        );
        if ( !$row ) {
            return null;
        }
        return $this->newFromRow( $row, $from );
    }
 
}