Improve return types in class MagicWordArray

Change-Id: I63ff4f52d8459ab19dd774ef1dee8435f1eb5cae
This commit is contained in:
Umherirrender 2019-06-03 17:52:47 +02:00
parent 75cffa0b99
commit e3c1f72bc9

View file

@ -30,7 +30,7 @@ use MediaWiki\MediaWikiServices;
* @ingroup Parser
*/
class MagicWordArray {
/** @var array */
/** @var string[] */
public $names = [];
/** @var MagicWordFactory */
@ -44,7 +44,7 @@ class MagicWordArray {
private $regex;
/**
* @param array $names
* @param string[] $names
* @param MagicWordFactory|null $factory
*/
public function __construct( $names = [], MagicWordFactory $factory = null ) {
@ -65,7 +65,7 @@ class MagicWordArray {
/**
* Add a number of magic words by name
*
* @param array $names
* @param string[] $names
*/
public function addArray( $names ) {
$this->names = array_merge( $this->names, array_values( $names ) );
@ -95,7 +95,7 @@ class MagicWordArray {
/**
* Get the base regex
* @return array
* @return string[]
*/
public function getBaseRegex() {
if ( is_null( $this->baseRegex ) ) {
@ -129,7 +129,7 @@ class MagicWordArray {
/**
* Get an unanchored regex that does not match parameters
* @return array
* @return string[]
*/
public function getRegex() {
if ( is_null( $this->regex ) ) {
@ -148,7 +148,7 @@ class MagicWordArray {
/**
* Get a regex for matching variables with parameters
*
* @return string
* @return string[]
*/
public function getVariableRegex() {
return str_replace( "\\$1", "(.*?)", $this->getRegex() );
@ -157,7 +157,7 @@ class MagicWordArray {
/**
* Get a regex anchored to the start of the string that does not match parameters
*
* @return array
* @return string[]
*/
public function getRegexStart() {
$base = $this->getBaseRegex();
@ -174,7 +174,7 @@ class MagicWordArray {
/**
* Get an anchored regex for matching variables with parameters
*
* @return array
* @return string[]
*/
public function getVariableStartToEndRegex() {
$base = $this->getBaseRegex();
@ -190,7 +190,7 @@ class MagicWordArray {
/**
* @since 1.20
* @return array
* @return string[]
*/
public function getNames() {
return $this->names;