<?php

[0] Fix | Delete

[1] Fix | Delete

// SPDX-FileCopyrightText: 2004-2023 Ryan Parman, Sam Sneddon, Ryan McCue

[2] Fix | Delete

// SPDX-License-Identifier: BSD-3-Clause

[3] Fix | Delete

[4] Fix | Delete

declare(strict_types=1);

[5] Fix | Delete

[6] Fix | Delete

namespace SimplePie;

[7] Fix | Delete

[8] Fix | Delete

use InvalidArgumentException;

[9] Fix | Delete

use SimplePie\Content\Type\Sniffer;

[10] Fix | Delete

use SimplePie\Parse\Date;

[11] Fix | Delete

use SimplePie\XML\Declaration\Parser as DeclarationParser;

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Handles creating objects and calling methods

[15] Fix | Delete

*

[16] Fix | Delete

* Access this via {@see \SimplePie\SimplePie::get_registry()}

[17] Fix | Delete

*/

[18] Fix | Delete

class Registry

[19] Fix | Delete

{

[20] Fix | Delete

/**

[21] Fix | Delete

* Default class mapping

[22] Fix | Delete

*

[23] Fix | Delete

* Overriding classes *must* subclass these.

[24] Fix | Delete

*

[25] Fix | Delete

* @var array<class-string, class-string>

[26] Fix | Delete

*/

[27] Fix | Delete

protected $default = [

[28] Fix | Delete

Cache::class => Cache::class,

[29] Fix | Delete

Locator::class => Locator::class,

[30] Fix | Delete

Parser::class => Parser::class,

[31] Fix | Delete

File::class => File::class,

[32] Fix | Delete

Sanitize::class => Sanitize::class,

[33] Fix | Delete

Item::class => Item::class,

[34] Fix | Delete

Author::class => Author::class,

[35] Fix | Delete

Category::class => Category::class,

[36] Fix | Delete

Enclosure::class => Enclosure::class,

[37] Fix | Delete

Caption::class => Caption::class,

[38] Fix | Delete

Copyright::class => Copyright::class,

[39] Fix | Delete

Credit::class => Credit::class,

[40] Fix | Delete

Rating::class => Rating::class,

[41] Fix | Delete

Restriction::class => Restriction::class,

[42] Fix | Delete

Sniffer::class => Sniffer::class,

[43] Fix | Delete

Source::class => Source::class,

[44] Fix | Delete

Misc::class => Misc::class,

[45] Fix | Delete

DeclarationParser::class => DeclarationParser::class,

[46] Fix | Delete

Date::class => Date::class,

[47] Fix | Delete

];

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Class mapping

[51] Fix | Delete

*

[52] Fix | Delete

* @see register()

[53] Fix | Delete

* @var array<string, class-string>

[54] Fix | Delete

*/

[55] Fix | Delete

protected $classes = [];

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Legacy classes

[59] Fix | Delete

*

[60] Fix | Delete

* @see register()

[61] Fix | Delete

* @var array<class-string>

[62] Fix | Delete

*/

[63] Fix | Delete

protected $legacy = [];

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Legacy types

[67] Fix | Delete

*

[68] Fix | Delete

* @see register()

[69] Fix | Delete

* @var array<string, class-string>

[70] Fix | Delete

*/

[71] Fix | Delete

private $legacyTypes = [

[72] Fix | Delete

'Cache' => Cache::class,

[73] Fix | Delete

'Locator' => Locator::class,

[74] Fix | Delete

'Parser' => Parser::class,

[75] Fix | Delete

'File' => File::class,

[76] Fix | Delete

'Sanitize' => Sanitize::class,

[77] Fix | Delete

'Item' => Item::class,

[78] Fix | Delete

'Author' => Author::class,

[79] Fix | Delete

'Category' => Category::class,

[80] Fix | Delete

'Enclosure' => Enclosure::class,

[81] Fix | Delete

'Caption' => Caption::class,

[82] Fix | Delete

'Copyright' => Copyright::class,

[83] Fix | Delete

'Credit' => Credit::class,

[84] Fix | Delete

'Rating' => Rating::class,

[85] Fix | Delete

'Restriction' => Restriction::class,

[86] Fix | Delete

'Content_Type_Sniffer' => Sniffer::class,

[87] Fix | Delete

'Source' => Source::class,

[88] Fix | Delete

'Misc' => Misc::class,

[89] Fix | Delete

'XML_Declaration_Parser' => DeclarationParser::class,

[90] Fix | Delete

'Parse_Date' => Date::class,

[91] Fix | Delete

];

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Constructor

[95] Fix | Delete

*

[96] Fix | Delete

* No-op

[97] Fix | Delete

*/

[98] Fix | Delete

public function __construct()

[99] Fix | Delete

{

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Register a class

[104] Fix | Delete

*

[105] Fix | Delete

* @param string $type See {@see $default} for names

[106] Fix | Delete

* @param class-string $class Class name, must subclass the corresponding default

[107] Fix | Delete

* @param bool $legacy Whether to enable legacy support for this class

[108] Fix | Delete

* @return bool Successfulness

[109] Fix | Delete

*/

[110] Fix | Delete

public function register(string $type, $class, bool $legacy = false)

[111] Fix | Delete

{

[112] Fix | Delete

if (array_key_exists($type, $this->legacyTypes)) {

[113] Fix | Delete

// trigger_error(sprintf('"%s"(): Using argument #1 ($type) with value "%s" is deprecated since SimplePie 1.8.0, use class-string "%s" instead.', __METHOD__, $type, $this->legacyTypes[$type]), \E_USER_DEPRECATED);

[114] Fix | Delete

[115] Fix | Delete

$type = $this->legacyTypes[$type];

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

if (!array_key_exists($type, $this->default)) {

[119] Fix | Delete

return false;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

if (!class_exists($class)) {

[123] Fix | Delete

return false;

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

/** @var string */

[127] Fix | Delete

$base_class = $this->default[$type];

[128] Fix | Delete

[129] Fix | Delete

if (!is_subclass_of($class, $base_class)) {

[130] Fix | Delete

return false;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

$this->classes[$type] = $class;

[134] Fix | Delete

[135] Fix | Delete

if ($legacy) {

[136] Fix | Delete

$this->legacy[] = $class;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

return true;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

/**

[143] Fix | Delete

* Get the class registered for a type

[144] Fix | Delete

*

[145] Fix | Delete

* Where possible, use {@see create()} or {@see call()} instead

[146] Fix | Delete

*

[147] Fix | Delete

* @template T

[148] Fix | Delete

* @param class-string<T> $type

[149] Fix | Delete

* @return class-string<T>|null

[150] Fix | Delete

*/

[151] Fix | Delete

public function get_class($type)

[152] Fix | Delete

{

[153] Fix | Delete

if (array_key_exists($type, $this->legacyTypes)) {

[154] Fix | Delete

// trigger_error(sprintf('"%s"(): Using argument #1 ($type) with value "%s" is deprecated since SimplePie 1.8.0, use class-string "%s" instead.', __METHOD__, $type, $this->legacyTypes[$type]), \E_USER_DEPRECATED);

[155] Fix | Delete

[156] Fix | Delete

$type = $this->legacyTypes[$type];

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

if (!array_key_exists($type, $this->default)) {

[160] Fix | Delete

return null;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

// For PHPStan: values in $default should be subtypes of keys.

[164] Fix | Delete

/** @var class-string<T> */

[165] Fix | Delete

$class = $this->default[$type];

[166] Fix | Delete

[167] Fix | Delete

if (array_key_exists($type, $this->classes)) {

[168] Fix | Delete

// For PHPStan: values in $classes should be subtypes of keys.

[169] Fix | Delete

/** @var class-string<T> */

[170] Fix | Delete

$class = $this->classes[$type];

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

return $class;

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Create a new instance of a given type

[178] Fix | Delete

*

[179] Fix | Delete

* @template T class-string $type

[180] Fix | Delete

* @param class-string<T> $type

[181] Fix | Delete

* @param array<mixed> $parameters Parameters to pass to the constructor

[182] Fix | Delete

* @return T Instance of class

[183] Fix | Delete

*/

[184] Fix | Delete

public function &create($type, array $parameters = [])

[185] Fix | Delete

{

[186] Fix | Delete

$class = $this->get_class($type);

[187] Fix | Delete

if ($class === null) {

[188] Fix | Delete

throw new InvalidArgumentException(sprintf(

[189] Fix | Delete

'%s(): Argument #1 ($type) "%s" not found in class list.',

[190] Fix | Delete

__METHOD__,

[191] Fix | Delete

$type

[192] Fix | Delete

), 1);

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

if (!method_exists($class, '__construct')) {

[196] Fix | Delete

$instance = new $class();

[197] Fix | Delete

} else {

[198] Fix | Delete

$reflector = new \ReflectionClass($class);

[199] Fix | Delete

// For PHPStan: $class is T.

[200] Fix | Delete

/** @var T */

[201] Fix | Delete

$instance = $reflector->newInstanceArgs($parameters);

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

if ($instance instanceof RegistryAware) {

[205] Fix | Delete

$instance->set_registry($this);

[206] Fix | Delete

} elseif (method_exists($instance, 'set_registry')) {

[207] Fix | Delete

trigger_error(sprintf('Using the method "set_registry()" without implementing "%s" is deprecated since SimplePie 1.8.0, implement "%s" in "%s".', RegistryAware::class, RegistryAware::class, $class), \E_USER_DEPRECATED);

[208] Fix | Delete

$instance->set_registry($this);

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

return $instance;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

/**

[215] Fix | Delete

* Call a static method for a type

[216] Fix | Delete

*

[217] Fix | Delete

* @param class-string $type

[218] Fix | Delete

* @param string $method

[219] Fix | Delete

* @param array<mixed> $parameters

[220] Fix | Delete

* @return mixed

[221] Fix | Delete

*/

[222] Fix | Delete

public function &call($type, string $method, array $parameters = [])

[223] Fix | Delete

{

[224] Fix | Delete

$class = $this->get_class($type);

[225] Fix | Delete

if ($class === null) {

[226] Fix | Delete

throw new InvalidArgumentException(sprintf(

[227] Fix | Delete

'%s(): Argument #1 ($type) "%s" not found in class list.',

[228] Fix | Delete

__METHOD__,

[229] Fix | Delete

$type

[230] Fix | Delete

), 1);

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

if (in_array($class, $this->legacy)) {

[234] Fix | Delete

switch ($type) {

[235] Fix | Delete

case Cache::class:

[236] Fix | Delete

// For backwards compatibility with old non-static

[237] Fix | Delete

// Cache::create() methods in PHP < 8.0.

[238] Fix | Delete

// No longer supported as of PHP 8.0.

[239] Fix | Delete

if ($method === 'get_handler') {

[240] Fix | Delete

// Fixing this PHPStan error breaks CacheTest::testDirectOverrideLegacy()

[241] Fix | Delete

/** @phpstan-ignore argument.type */

[242] Fix | Delete

$result = @call_user_func_array([$class, 'create'], $parameters);

[243] Fix | Delete

return $result;

[244] Fix | Delete

}

[245] Fix | Delete

break;

[246] Fix | Delete

}

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

$callable = [$class, $method];

[250] Fix | Delete

assert(is_callable($callable), 'For PHPstan');

[251] Fix | Delete

$result = call_user_func_array($callable, $parameters);

[252] Fix | Delete

return $result;

[253] Fix | Delete

}

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

class_alias('SimplePie\Registry', 'SimplePie_Registry');

[257] Fix | Delete

[258] Fix | Delete