wiki.techinc.nl/includes/parser/PPNode_Hash_Text.php
Bartosz Dziewoński ccd423225f Add "implements Stringable" to every class with "function __toString()"
In PHP 8, but not in PHP 7.4, every class with a __toString() function
implicitly implements the Stringable interface. Therefore, the
behavior of checks like "instanceof Stringable" differs between these
PHP versions when such classes are involved. Make every such class
implement the interface so that the behavior will be consistent.

The PHP 7.4 fallback for the Stringable interface is provided by
symfony/polyfill-php80.

Change-Id: I3f0330c2555c7d3bf99b654ed3c0b0303e257ea1
2024-06-13 00:23:39 +00:00

97 lines
2.5 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 Stringable, 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 ) {
if ( !is_scalar( $store[$index] ) ) {
throw new InvalidArgumentException( __CLASS__ . ' given object instead of string' );
}
$this->value = $store[$index];
$this->store = $store;
$this->index = $index;
}
public function __toString() {
return htmlspecialchars( $this->value, ENT_COMPAT );
}
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 LogicException( __METHOD__ . ': not supported' );
}
public function splitExt() {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new LogicException( __METHOD__ . ': not supported' );
}
public function splitHeading() {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new LogicException( __METHOD__ . ': not supported' );
}
}