Page MenuHomeWickedGov Phorge
Files F4055820

KV.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

KV.php
View Options

<?php
// phpcs:disable MediaWiki.Commenting.FunctionComment.DefaultNullTypeParam -- T218324, T218816
declare( strict_types = 1 );
namespace Wikimedia\Parsoid\Tokens;
/**
* Represents a Key-value pair.
*/
class KV implements \JsonSerializable {
/**
* Commonly a string, but where the key might be templated,
* this can be an array of tokens even.
*
* @var string|Token|array<Token|string>
*/
public $k;
/** @var string|Token|array<Token|string>|KV[] */
public $v;
/** @var KVSourceRange|null wikitext source offsets */
public $srcOffsets;
/** @var string|null wikitext source */
public $ksrc;
/** @var string|null wikitext source */
public $vsrc;
/**
* @param string|Token|array<Token|string> $k
* Commonly a string, but where the key might be templated,
* this can be an array of tokens even.
* @param string|Token|array<Token|string>|KV[] $v
* The value: string, token, of an array of tokens
* @param ?KVSourceRange $srcOffsets wikitext source offsets
* @param ?string $ksrc
* @param ?string $vsrc
*/
public function __construct(
$k, $v, ?KVSourceRange $srcOffsets = null, ?string $ksrc = null,
?string $vsrc = null
) {
$this->k = $k;
$this->v = $v;
$this->srcOffsets = $srcOffsets;
if ( isset( $ksrc ) ) {
$this->ksrc = $ksrc;
}
if ( isset( $vsrc ) ) {
$this->vsrc = $vsrc;
}
}
/**
* BUG: When there are multiple matching attributes, Sanitizer lets the last one win
* whereas this method is letting the first one win. This can introduce subtle bugs!
*
* Lookup a string key in a KV array and return the first matching KV object
*
* @param KV[]|null $kvs
* @param string $key
* @return ?KV
*/
public static function lookupKV( ?array $kvs, string $key ): ?KV {
if ( $kvs === null ) {
return null;
}
foreach ( $kvs as $kv ) {
// PORT-FIXME: JS trim() will remove non-ASCII spaces (such as NBSP) too,
// while PHP's won't. Does that matter?
if ( is_string( $kv->k ) && trim( $kv->k ) === $key ) {
return $kv;
}
}
return null;
}
/**
* Lookup a string key (first occurrence) in a KV array
* and return the value of the KV object
*
* @param KV[]|null $kvs
* @param string $key
* @return string|Token|array<Token|string>|null
*/
public static function lookup( ?array $kvs, string $key ) {
$kv = self::lookupKV( $kvs, $key );
// PORT_FIXME: Potential bug lurking here ... if $kv->v is an array
// this will return a copy, which if modified will not reflect
// in the original KV object.
return $kv->v ?? null;
}
/**
* Return the key portion of the KV's source offsets, or else null
* if no source offsets are known.
* @return SourceRange|null
*/
public function keyOffset(): ?SourceRange {
return $this->srcOffsets->key ?? null;
}
/**
* Return the value portion of the KV's source offsets, or else null
* if no source offsets are known.
* @return SourceRange|null
*/
public function valueOffset(): ?SourceRange {
return $this->srcOffsets->value ?? null;
}
/**
* @inheritDoc
*/
public function jsonSerialize(): array {
$ret = [ "k" => $this->k, "v" => $this->v ];
if ( $this->srcOffsets ) {
$ret["srcOffsets"] = $this->srcOffsets;
}
if ( isset( $this->ksrc ) ) {
$ret["ksrc"] = $this->ksrc;
}
if ( isset( $this->vsrc ) ) {
$ret["vsrc"] = $this->vsrc;
}
return $ret;
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 16 2026, 01:38 (12 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
d0/8b/5792efb3d77a23741376431b1066
Default Alt Text
KV.php (3 KB)

Event Timeline