wiki.techinc.nl/includes/linker/LinkRendererFactory.php
James D. Forrester 35b2542895 Namespace includes/cache
Bug: T353458
Change-Id: Ic3f3168ef17113f5fb3ec11e0a47f52d65eefba9
2024-02-20 10:28:03 -05:00

109 lines
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 MediaWiki\Cache\LinkCache;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\SpecialPage\SpecialPageFactory;
use MediaWiki\Title\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 )
);
}
/**
* @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;
}
}