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
121 lines
3.3 KiB
PHP
121 lines
3.3 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 Kunal Mehta <legoktm@debian.org>
|
|
*/
|
|
namespace MediaWiki\Linker;
|
|
|
|
use LinkCache;
|
|
use MediaWiki\Config\ServiceOptions;
|
|
use MediaWiki\HookContainer\HookContainer;
|
|
use MediaWiki\SpecialPage\SpecialPageFactory;
|
|
use MediaWiki\User\UserIdentity;
|
|
use TitleFormatter;
|
|
|
|
/**
|
|
* Factory to create LinkRender objects
|
|
* @since 1.28
|
|
*/
|
|
class LinkRendererFactory {
|
|
|
|
/**
|
|
* @var TitleFormatter
|
|
*/
|
|
private $titleFormatter;
|
|
|
|
/**
|
|
* @var LinkCache
|
|
*/
|
|
private $linkCache;
|
|
|
|
/**
|
|
* @var HookContainer
|
|
*/
|
|
private $hookContainer;
|
|
|
|
/**
|
|
* @var SpecialPageFactory
|
|
*/
|
|
private $specialPageFactory;
|
|
|
|
/**
|
|
* @internal For use by core ServiceWiring
|
|
* @param TitleFormatter $titleFormatter
|
|
* @param LinkCache $linkCache
|
|
* @param SpecialPageFactory $specialPageFactory
|
|
* @param HookContainer $hookContainer
|
|
*/
|
|
public function __construct(
|
|
TitleFormatter $titleFormatter,
|
|
LinkCache $linkCache,
|
|
SpecialPageFactory $specialPageFactory,
|
|
HookContainer $hookContainer
|
|
) {
|
|
$this->titleFormatter = $titleFormatter;
|
|
$this->linkCache = $linkCache;
|
|
$this->specialPageFactory = $specialPageFactory;
|
|
$this->hookContainer = $hookContainer;
|
|
}
|
|
|
|
/**
|
|
* @param array $options optional flags for rendering
|
|
* - 'renderForComment': set to true if the created LinkRenderer will be used for
|
|
* links in an edit summary or log comments. An instance with renderForComment
|
|
* enabled must not be used for other links.
|
|
*
|
|
* @return LinkRenderer
|
|
*/
|
|
public function create( array $options = [ 'renderForComment' => false ] ) {
|
|
return new LinkRenderer(
|
|
$this->titleFormatter, $this->linkCache, $this->specialPageFactory,
|
|
$this->hookContainer,
|
|
new ServiceOptions( LinkRenderer::CONSTRUCTOR_OPTIONS, $options )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @deprecated since 1.37. LinkRenderer does not depend on the user any longer,
|
|
* so calling ::create is sufficient.
|
|
* @param UserIdentity $user
|
|
* @return LinkRenderer
|
|
*/
|
|
public function createForUser( UserIdentity $user ) {
|
|
wfDeprecated( __METHOD__, '1.37' );
|
|
return $this->create();
|
|
}
|
|
|
|
/**
|
|
* @param array $options
|
|
* @return LinkRenderer
|
|
*/
|
|
public function createFromLegacyOptions( array $options ) {
|
|
$linkRenderer = $this->create();
|
|
|
|
if ( in_array( 'forcearticlepath', $options, true ) ) {
|
|
$linkRenderer->setForceArticlePath( true );
|
|
}
|
|
|
|
if ( in_array( 'http', $options, true ) ) {
|
|
$linkRenderer->setExpandURLs( PROTO_HTTP );
|
|
} elseif ( in_array( 'https', $options, true ) ) {
|
|
$linkRenderer->setExpandURLs( PROTO_HTTPS );
|
|
}
|
|
|
|
return $linkRenderer;
|
|
}
|
|
}
|