TitleValue.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkTarget;
use Wikimedia\Assert\Assert;

class TitleValue implements LinkTarget {
    protected $namespace;

    protected $dbkey;

    protected $fragment;

    protected $interwiki;

    public function __construct( $namespace, $dbkey, $fragment = '', $interwiki = '' ) {
        Assert::parameterType( 'integer', $namespace, '$namespace' );
        Assert::parameterType( 'string', $dbkey, '$dbkey' );
        Assert::parameterType( 'string', $fragment, '$fragment' );
        Assert::parameterType( 'string', $interwiki, '$interwiki' );

        // Sanity check, no full validation or normalization applied here!
        Assert::parameter( !preg_match( '/^_|[ \r\n\t]|_$/', $dbkey ), '$dbkey', 'invalid DB key' );
        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->getDBkey() );
    }

    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;
    }
}