MediaWikiSite.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Site;
 
use MediaWiki\Title\Title;
use RuntimeException;
 
class MediaWikiSite extends Site {
    public const PATH_FILE = 'file_path';
    public const PATH_PAGE = 'page_path';
 
    public function __construct( $type = self::TYPE_MEDIAWIKI ) {
        parent::__construct( $type );
    }
 
    public function toDBKey( $title ) {
        return str_replace( ' ', '_', $title );
    }
 
    public function normalizePageName( $pageName, $followRedirect = MediaWikiPageNameNormalizer::FOLLOW_REDIRECT ) {
        if ( defined( 'MW_PHPUNIT_TEST' ) || defined( 'MW_DEV_ENV' ) ) {
            // If the code is under test, don't call out to other sites, just
            // normalize locally.
            // Note: this may cause results to be inconsistent with the actual
            // normalization used by the respective remote site!
 
            $t = Title::newFromText( $pageName );
            return $t->getPrefixedText();
        } else {
            static $mediaWikiPageNameNormalizer = null;
            $mediaWikiPageNameNormalizer ??= new MediaWikiPageNameNormalizer();
 
            return $mediaWikiPageNameNormalizer->normalizePageName(
                $pageName,
                $this->getFileUrl( 'api.php' ),
                $followRedirect
            );
        }
    }
 
    public function getLinkPathType() {
        return self::PATH_PAGE;
    }
 
    public function getRelativePagePath() {
        return parse_url( $this->getPath( self::PATH_PAGE ), PHP_URL_PATH );
    }
 
    public function getRelativeFilePath() {
        return parse_url( $this->getPath( self::PATH_FILE ), PHP_URL_PATH );
    }
 
    public function setPagePath( $path ) {
        $this->setPath( self::PATH_PAGE, $path );
    }
 
    public function setFilePath( $path ) {
        $this->setPath( self::PATH_FILE, $path );
    }
 
    public function getPageUrl( $pageName = false ) {
        $url = $this->getLinkPath();
 
        if ( $url === null ) {
            return null;
        }
 
        if ( $pageName !== false ) {
            $pageName = $this->toDBKey( trim( $pageName ) );
            $url = str_replace( '$1', wfUrlencode( $pageName ), $url );
        }
 
        return $url;
    }
 
    public function getFileUrl( $path = false ) {
        $filePath = $this->getPath( self::PATH_FILE );
        if ( $filePath === null ) {
            throw new RuntimeException( "getFileUrl called for {$this->getGlobalId()} while PATH_FILE is unset" );
        }
 
        if ( $path !== false ) {
            $filePath = str_replace( '$1', $path, $filePath );
        } else {
            wfDeprecatedMsg( __METHOD__ . ': omitting $path is deprecated', '1.40' );
        }
 
        return $filePath;
    }
}
 
class_alias( MediaWikiSite::class, 'MediaWikiSite' );