1f34ac4526
* The Title::inNamespace() method discouraged use of getNamespace()
for comparison.
This was added 10 years ago in r103893 (commit 3414e91bae),
however no such "change" has been made, and the new LinkTarget
stable interface and TitleValue class contains the same getNamespace()
method, and no warning against its use.
My main reason for removing this comment is so that avoid fear
against using `in_array()` with TitleValue->getNamespace() which
this comment seems to discourage. While Title has plural
inNamespaces(), TitleValue does not. This seems fine, as one can
simply use in_array for more complex use cases where a range or
list is compared against.
* Fix Doxygen warnings about invalid or unsupported XML tags
such as `<a>`, `<siteinfo>` etc. Rephase or use backtics,.
* Fix useless IDE tooltips and Doxygen output by removing empty stubs
from method overrides that add no new information, yet obscured
the otherwise inherited parent destination which does have useful
information.
* Clarify that `renderForComment` must not be mixed with other ones.
This seems to be how it is intended. Upon realizing that, I think
this is unreasonable and should perhaps be removed. For now, I've
documented the hack that it seems to exist for.
* Consistently use imperative mood when phrasing method docs, and
consistently use a brief first line description, and
consistently separate it from other paragraphs and annotations
with one line break.
Change-Id: I7e1819a5d7124c635de84bc64d2371a122195928
137 lines
3.5 KiB
PHP
137 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* 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 Addshore
|
|
*/
|
|
namespace MediaWiki\Linker;
|
|
|
|
/**
|
|
* @since 1.27
|
|
*/
|
|
interface LinkTarget {
|
|
|
|
/**
|
|
* Get the namespace index.
|
|
*
|
|
* @since 1.27
|
|
* @return int Namespace index
|
|
*/
|
|
public function getNamespace(): int;
|
|
|
|
/**
|
|
* Convenience function to check if the target is in a given namespace.
|
|
*
|
|
* @since 1.27
|
|
* @param int $ns
|
|
* @return bool
|
|
*/
|
|
public function inNamespace( int $ns ): bool;
|
|
|
|
/**
|
|
* Get the link fragment in text form (i.e. the bit after the hash `#`).
|
|
*
|
|
* @since 1.27
|
|
* @return string link fragment
|
|
*/
|
|
public function getFragment(): string;
|
|
|
|
/**
|
|
* Whether the link target has a fragment.
|
|
*
|
|
* @since 1.27
|
|
* @return bool
|
|
*/
|
|
public function hasFragment(): bool;
|
|
|
|
/**
|
|
* Get the main part of the link target, in canonical database form.
|
|
*
|
|
* The main part is the link target without namespace prefix or hash fragment.
|
|
* The database form means that spaces become underscores, this is also
|
|
* used for URLs.
|
|
*
|
|
* @since 1.27
|
|
* @return string
|
|
*/
|
|
public function getDBkey(): string;
|
|
|
|
/**
|
|
* Get the main part of the link target, in text form.
|
|
*
|
|
* The main part is the link target without namespace prefix or hash fragment.
|
|
* The text form is used for display purposes.
|
|
*
|
|
* 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.
|
|
*
|
|
* @since 1.27
|
|
* @return string
|
|
*/
|
|
public function getText(): string;
|
|
|
|
/**
|
|
* Create a new LinkTarget with a different fragment on the same page.
|
|
*
|
|
* It is expected that the same type of object will be returned, but the
|
|
* only requirement is that it is a LinkTarget.
|
|
*
|
|
* @since 1.27
|
|
* @param string $fragment The fragment override, or "" to remove it.
|
|
* @return LinkTarget
|
|
*/
|
|
public function createFragmentTarget( string $fragment );
|
|
|
|
/**
|
|
* Whether this LinkTarget has an interwiki component.
|
|
*
|
|
* @since 1.27
|
|
* @return bool
|
|
*/
|
|
public function isExternal(): bool;
|
|
|
|
/**
|
|
* The interwiki component of this LinkTarget.
|
|
*
|
|
* @since 1.27
|
|
* @return string
|
|
*/
|
|
public function getInterwiki(): string;
|
|
|
|
/**
|
|
* Check whether the given LinkTarget refers to the same target as this LinkTarget.
|
|
*
|
|
* Two link targets are considered the same if they have the same interwiki prefix,
|
|
* are in the same namespace, have the same main part, and the same fragment.
|
|
*
|
|
* @since 1.36
|
|
* @param LinkTarget $other
|
|
* @return bool
|
|
*/
|
|
public function isSameLinkAs( LinkTarget $other ): bool;
|
|
|
|
/**
|
|
* Return an informative human-readable representation of the link target,
|
|
* for use in logging and debugging.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString(): string;
|
|
|
|
}
|