TitleValue.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkTarget;
use Wikimedia\Assert\Assert;
use Wikimedia\Assert\ParameterTypeException;
 
class TitleValue implements LinkTarget {
 
    protected $namespace;
 
    protected $dbkey;
 
    protected $fragment;
 
    protected $interwiki;
 
    public $prefixedText = null;
 
    public function __construct( $namespace, $dbkey, $fragment = '', $interwiki = '' ) {
        if ( !is_int( $namespace ) ) {
            throw new ParameterTypeException( '$namespace', 'int' );
        }
        if ( !is_string( $dbkey ) ) {
            throw new ParameterTypeException( '$dbkey', 'string' );
        }
        if ( !is_string( $fragment ) ) {
            throw new ParameterTypeException( '$fragment', 'string' );
        }
        if ( !is_string( $interwiki ) ) {
            throw new ParameterTypeException( '$interwiki', 'string' );
        }
 
        // Sanity check, no full validation or normalization applied here!
        Assert::parameter( !preg_match( '/^_|[ \r\n\t]|_$/', $dbkey ), '$dbkey',
            "invalid DB key '$dbkey'" );
        Assert::parameter( $dbkey !== '', '$dbkey', 'should not be empty' );
 
        $this->namespace = $namespace;
        $this->dbkey = $dbkey;
        $this->fragment = $fragment;
        $this->interwiki = $interwiki;
    }
 
    public function getNamespace() {
        return $this->namespace;
    }
 
    public function inNamespace( $ns ) {
        return $this->namespace == $ns;
    }
 
    public function getFragment() {
        return $this->fragment;
    }
 
    public function hasFragment() {
        return $this->fragment !== '';
    }
 
    public function getDBkey() {
        return $this->dbkey;
    }
 
    public function getText() {
        return str_replace( '_', ' ', $this->dbkey );
    }
 
    public function createFragmentTarget( $fragment ) {
        return new TitleValue(
            $this->namespace,
            $this->dbkey,
            $fragment,
            $this->interwiki
        );
    }
 
    public function isExternal() {
        return $this->interwiki !== '';
    }
 
    public function getInterwiki() {
        return $this->interwiki;
    }
 
    public function __toString() {
        $name = $this->namespace . ':' . $this->dbkey;
 
        if ( $this->fragment !== '' ) {
            $name .= '#' . $this->fragment;
        }
 
        if ( $this->interwiki !== '' ) {
            $name = $this->interwiki . ':' . $name;
        }
 
        return $name;
    }
}