diff options
Diffstat (limited to 'www/wiki/includes/title/TitleValue.php')
| -rw-r--r-- | www/wiki/includes/title/TitleValue.php | 213 |
1 files changed, 213 insertions, 0 deletions
diff --git a/www/wiki/includes/title/TitleValue.php b/www/wiki/includes/title/TitleValue.php new file mode 100644 index 00000000..3e133006 --- /dev/null +++ b/www/wiki/includes/title/TitleValue.php @@ -0,0 +1,213 @@ +<?php +/** + * Representation of a page title within MediaWiki. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + * @author Daniel Kinzler + */ +use MediaWiki\Linker\LinkTarget; +use Wikimedia\Assert\Assert; + +/** + * Represents a page (or page fragment) title within MediaWiki. + * + * @note In contrast to Title, this is designed to be a plain value object. That is, + * it is immutable, does not use global state, and causes no side effects. + * + * @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue + * @since 1.23 + */ +class TitleValue implements LinkTarget { + + /** + * @deprecated in 1.31. This class is immutable. Use the getter for access. + * @var int + */ + protected $namespace; + + /** + * @deprecated in 1.31. This class is immutable. Use the getter for access. + * @var string + */ + protected $dbkey; + + /** + * @deprecated in 1.31. This class is immutable. Use the getter for access. + * @var string + */ + protected $fragment; + + /** + * @deprecated in 1.31. This class is immutable. Use the getter for access. + * @var string + */ + protected $interwiki; + + /** + * Constructs a TitleValue. + * + * @note TitleValue expects a valid DB key; typically, a TitleValue is constructed either + * from a database entry, or by a TitleParser. We could apply "some" normalization here, + * such as substituting spaces by underscores, but that would encourage the use of + * un-normalized text when constructing TitleValues. For constructing a TitleValue from + * user input or external sources, use a TitleParser. + * + * @param int $namespace The namespace ID. This is not validated. + * @param string $dbkey The page title in valid DBkey form. No normalization is applied. + * @param string $fragment The fragment title. Use '' to represent the whole page. + * No validation or normalization is applied. + * @param string $interwiki The interwiki component + * + * @throws InvalidArgumentException + */ + 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 '$dbkey'" ); + Assert::parameter( $dbkey !== '', '$dbkey', 'should not be empty' ); + + $this->namespace = $namespace; + $this->dbkey = $dbkey; + $this->fragment = $fragment; + $this->interwiki = $interwiki; + } + + /** + * @since 1.23 + * @return int + */ + public function getNamespace() { + return $this->namespace; + } + + /** + * @since 1.27 + * @param int $ns + * @return bool + */ + public function inNamespace( $ns ) { + return $this->namespace == $ns; + } + + /** + * @since 1.23 + * @return string + */ + public function getFragment() { + return $this->fragment; + } + + /** + * @since 1.27 + * @return bool + */ + public function hasFragment() { + return $this->fragment !== ''; + } + + /** + * Returns the title's DB key, as supplied to the constructor, + * without namespace prefix or fragment. + * @since 1.23 + * + * @return string + */ + public function getDBkey() { + return $this->dbkey; + } + + /** + * Returns the title in text form, + * without namespace prefix or fragment. + * @since 1.23 + * + * This is computed from the DB key by replacing any underscores with spaces. + * + * @note To get a title string that includes the namespace and/or fragment, + * use a TitleFormatter. + * + * @return string + */ + public function getText() { + return str_replace( '_', ' ', $this->getDBkey() ); + } + + /** + * Creates a new TitleValue for a different fragment of the same page. + * + * @since 1.27 + * @param string $fragment The fragment name, or "" for the entire page. + * + * @return TitleValue + */ + public function createFragmentTarget( $fragment ) { + return new TitleValue( + $this->namespace, + $this->dbkey, + $fragment, + $this->interwiki + ); + } + + /** + * Whether it has an interwiki part + * + * @since 1.27 + * @return bool + */ + public function isExternal() { + return $this->interwiki !== ''; + } + + /** + * Returns the interwiki part + * + * @since 1.27 + * @return string + */ + public function getInterwiki() { + return $this->interwiki; + } + + /** + * Returns a string representation of the title, for logging. This is purely informative + * and must not be used programmatically. Use the appropriate TitleFormatter to generate + * the correct string representation for a given use. + * @since 1.23 + * + * @return string + */ + public function __toString() { + $name = $this->namespace . ':' . $this->dbkey; + + if ( $this->fragment !== '' ) { + $name .= '#' . $this->fragment; + } + + if ( $this->interwiki !== '' ) { + $name = $this->interwiki . ':' . $name; + } + + return $name; + } +} |