wiki.techinc.nl/includes/parser/PPNode_Hash_Text.php
Umherirrender 44fd53fee3 Using @return never documentation on always-throw-function
This helps phan to detect unreachable code and also impossible types
after the functions.
It helps phan to avoid false positives for array keys
when the keys are checked before

Bug: T240141
Change-Id: I895f70e82b3053a46cd44135b15437e6f82a07b2
2021-09-07 17:29:03 +02:00

97 lines
2.4 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
* @ingroup Parser
*/
/**
* @ingroup Parser
*/
// phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
class PPNode_Hash_Text implements PPNode {
/** @var string */
public $value;
/** @var array */
private $store;
/** @var int */
private $index;
/**
* Construct an object using the data from $store[$index]. The rest of the
* store array can be accessed via getNextSibling().
*
* @param array $store
* @param int $index
*/
public function __construct( array $store, $index ) {
$this->value = $store[$index];
if ( !is_scalar( $this->value ) ) {
throw new MWException( __CLASS__ . ' given object instead of string' );
}
$this->store = $store;
$this->index = $index;
}
public function __toString() {
return htmlspecialchars( $this->value );
}
public function getNextSibling() {
return PPNode_Hash_Tree::factory( $this->store, $this->index + 1 );
}
public function getChildren() {
return false;
}
public function getFirstChild() {
return false;
}
public function getChildrenOfType( $name ) {
return false;
}
public function getLength() {
return false;
}
public function item( $i ) {
return false;
}
public function getName() {
return '#text';
}
public function splitArg() {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new MWException( __METHOD__ . ': not supported' );
}
public function splitExt() {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new MWException( __METHOD__ . ': not supported' );
}
public function splitHeading() {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new MWException( __METHOD__ . ': not supported' );
}
}