TitleFormatter.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Title;
 
use InvalidArgumentException;
use MediaWiki\Cache\GenderCache;
use MediaWiki\Language\Language;
use MediaWiki\Page\PageReference;
use Wikimedia\Parsoid\Core\LinkTarget;
 
class TitleFormatter {
    protected Language $language;
    protected GenderCache $genderCache;
    protected NamespaceInfo $nsInfo;
 
    public function __construct(
        Language $language,
        GenderCache $genderCache,
        NamespaceInfo $nsInfo
    ) {
        $this->language = $language;
        $this->genderCache = $genderCache;
        $this->nsInfo = $nsInfo;
    }
 
    public function formatTitle( $namespace, $text, $fragment = '', $interwiki = '' ) {
        $out = '';
        if ( $interwiki !== '' ) {
            $out = $interwiki . ':';
        }
 
        if ( $namespace != 0 ) {
            try {
                $nsName = $this->getNamespaceName( $namespace, $text );
            } catch ( InvalidArgumentException $e ) {
                // See T165149. Awkward, but better than erroneously linking to the main namespace.
                $nsName = $this->language->getNsText( NS_SPECIAL ) . ":Badtitle/NS{$namespace}";
            }
 
            $out .= $nsName . ':';
        }
        $out .= $text;
 
        if ( $fragment !== '' ) {
            $out .= '#' . $fragment;
        }
 
        $out = str_replace( '_', ' ', $out );
 
        return $out;
    }
 
    public function getText( $title ) {
        if ( $title instanceof LinkTarget ) {
            return $title->getText();
        } elseif ( $title instanceof PageReference ) {
            return strtr( $title->getDBKey(), '_', ' ' );
        } else {
            throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $title ) );
        }
    }
 
    public function getPrefixedText( $title ) {
        if ( $title instanceof LinkTarget ) {
            if ( !isset( $title->prefixedText ) ) {
                $title->prefixedText = $this->formatTitle(
                    $title->getNamespace(),
                    $title->getText(),
                    '',
                    $title->getInterwiki()
                );
            }
            return $title->prefixedText;
        } elseif ( $title instanceof PageReference ) {
            $title->assertWiki( PageReference::LOCAL );
            return $this->formatTitle(
                $title->getNamespace(),
                $this->getText( $title )
            );
        } else {
            throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $title ) );
        }
    }
 
    public function getPrefixedDBkey( $target ) {
        if ( $target instanceof LinkTarget ) {
            return strtr( $this->formatTitle(
                $target->getNamespace(),
                $target->getDBkey(),
                '',
                $target->getInterwiki()
            ), ' ', '_' );
        } elseif ( $target instanceof PageReference ) {
            $target->assertWiki( PageReference::LOCAL );
            return strtr( $this->formatTitle(
                $target->getNamespace(),
                $target->getDBkey()
            ), ' ', '_' );
        } else {
            throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $target ) );
        }
    }
 
    public function getFullText( $title ) {
        if ( $title instanceof LinkTarget ) {
            return $this->formatTitle(
                $title->getNamespace(),
                $title->getText(),
                $title->getFragment(),
                $title->getInterwiki()
            );
        } elseif ( $title instanceof PageReference ) {
            $title->assertWiki( PageReference::LOCAL );
            return $this->formatTitle(
                $title->getNamespace(),
                $this->getText( $title )
            );
        } else {
            throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $title ) );
        }
    }
 
    public function getNamespaceName( $namespace, $text ) {
        if ( $this->language->needsGenderDistinction() &&
            $this->nsInfo->hasGenderDistinction( $namespace )
        ) {
            // NOTE: we are assuming here that the title text is a user name!
            $gender = $this->genderCache->getGenderOf( $text, __METHOD__ );
            $name = $this->language->getGenderNsText( $namespace, $gender );
        } else {
            $name = $this->language->getNsText( $namespace );
        }
 
        if ( $name === false ) {
            throw new InvalidArgumentException( 'Unknown namespace ID: ' . $namespace );
        }
 
        return $name;
    }
 
}
 
class_alias( TitleFormatter::class, 'TitleFormatter' );