mirror of
https://github.com/diocloid/LinkTitles.git
synced 2025-10-22 05:42:32 +02:00
127 lines
3.8 KiB
PHP
127 lines
3.8 KiB
PHP
<?php
|
|
/**
|
|
* The LinkTitles\Config class holds configuration for the LinkTitles extension.
|
|
*
|
|
* Copyright 2012-2017 Daniel Kraus <bovender@bovender.de> ('bovender')
|
|
* 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.
|
|
*
|
|
* @author Daniel Kraus <bovender@bovender.de>
|
|
*/
|
|
namespace LinkTitles;
|
|
|
|
/**
|
|
* Holds LinkTitles configuration.
|
|
*
|
|
* This class encapsulates the global configuration variables so we do not have
|
|
* to pull those globals into scope in the individual LinkTitles classes.
|
|
*
|
|
* Using a dedicated configuration class also facilitates overriding certain
|
|
* options, i.e. in a maintenance script that is invoked with flags from the
|
|
* command line.
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
class Config {
|
|
/**
|
|
* Whether to add links to a page when the page is edited/saved.
|
|
* @var bool $parseOnEdit
|
|
*/
|
|
public $parseOnEdit;
|
|
|
|
/**
|
|
* Whether to add links to a page when the page is rendered.
|
|
* @var bool $parseOnRender
|
|
*/
|
|
public $parseOnRender;
|
|
|
|
/**
|
|
* Indicates whether to prioritize short over long titles.
|
|
* @var bool $preferShortTitles
|
|
*/
|
|
public $preferShortTitles;
|
|
|
|
/**
|
|
* Minimum length of a page title for it to qualify as a potential link target.
|
|
* @var int $minimumTitleLength
|
|
*/
|
|
public $minimumTitleLength;
|
|
|
|
/**
|
|
* Array of page titles that must never be link targets.
|
|
*
|
|
* This may be useful to exclude common abbreviations or acronyms from
|
|
* automatic linking.
|
|
* @var Array $blackList
|
|
*/
|
|
public $blackList;
|
|
|
|
/**
|
|
* Array of those name spaces (integer constants) whose pages may be linked.
|
|
* @var Array $nameSpaces
|
|
*/
|
|
public $nameSpaces;
|
|
|
|
/**
|
|
* Indicates whether to add a link to the first occurrence of a page title
|
|
* only (true), or add links to all occurrences on the source page (false).
|
|
* @var bool $firstOnly;
|
|
*/
|
|
public $firstOnly;
|
|
|
|
/**
|
|
* Indicates whether to operate in smart mode, i.e. link to pages even if the
|
|
* case does not match. Without smart mode, pages are linked to only if the
|
|
* exact title appears on the source page.
|
|
* @var bool $smartMode;
|
|
*/
|
|
public $smartMode;
|
|
|
|
/**
|
|
* Mirrors the global MediaWiki variable $wgCapitalLinks that indicates
|
|
* whether or not page titles are fully case sensitive
|
|
* @var bool $capitalLinks;
|
|
*/
|
|
public $capitalLinks;
|
|
|
|
/**
|
|
* Constructs a new Config object.
|
|
*
|
|
* The object's member variables will automatically be set with the values
|
|
* from the corresponding global variables.
|
|
*/
|
|
public function __construct() {
|
|
global $wgLinkTitlesParseOnEdit;
|
|
global $wgLinkTitlesParseOnRender;
|
|
global $wgLinkTitlesPreferShortTitles;
|
|
global $wgLinkTitlesMinimumTitleLength;
|
|
global $wgLinkTitlesBlackList;
|
|
global $wgLinkTitlesNamespaces;
|
|
global $wgLinkTitlesFirstOnly;
|
|
global $wgLinkTitlesSmartMode;
|
|
global $wgCapitalLinks;
|
|
$this->parseOnEdit = $wgLinkTitlesParseOnEdit;
|
|
$this->parseOnRender = $wgLinkTitlesParseOnRender;
|
|
$this->preferShortTitles = $wgLinkTitlesPreferShortTitles;
|
|
$this->minimumTitleLength = $wgLinkTitlesMinimumTitleLength;
|
|
$this->blackList = $wgLinkTitlesBlackList;
|
|
$this->nameSpaces = $wgLinkTitlesNamespaces;
|
|
$this->firstOnly = $wgLinkTitlesFirstOnly;
|
|
$this->smartMode = $wgLinkTitlesSmartMode;
|
|
$this->capitalLinks = $wgCapitalLinks; // MediaWiki global variable
|
|
}
|
|
|
|
}
|