<?php
// SPDX-FileCopyrightText: 2004-2023 Ryan Parman, Sam Sneddon, Ryan McCue
// SPDX-License-Identifier: BSD-3-Clause
declare(strict_types=1);
namespace SimplePie;
use InvalidArgumentException;
use SimplePie\Content\Type\Sniffer;
use SimplePie\Parse\Date;
use SimplePie\XML\Declaration\Parser as DeclarationParser;
/**
* Handles creating objects and calling methods
*
* Access this via {@see \SimplePie\SimplePie::get_registry()}
*/
class Registry
{
/**
* Default class mapping
*
* Overriding classes *must* subclass these.
*
* @var array<class-string, class-string>
*/
protected $default = [
Cache::class => Cache::class,
Locator::class => Locator::class,
Parser::class => Parser::class,
File::class => File::class,
Sanitize::class => Sanitize::class,
Item::class => Item::class,
Author::class => Author::class,
Category::class => Category::class,
Enclosure::class => Enclosure::class,
Caption::class => Caption::class,
Copyright::class => Copyright::class,
Credit::class => Credit::class,
Rating::class => Rating::class,
Restriction::class => Restriction::class,
Sniffer::class => Sniffer::class,
Source::class => Source::class,
Misc::class => Misc::class,
DeclarationParser::class => DeclarationParser::class,
Date::class => Date::class,
];
/**
* Class mapping
*
* @see register()
* @var array<string, class-string>
*/
protected $classes = [];
/**
* Legacy classes
*
* @see register()
* @var array<class-string>
*/
protected $legacy = [];
/**
* Legacy types
*
* @see register()
* @var array<string, class-string>
*/
private $legacyTypes = [
'Cache' => Cache::class,
'Locator' => Locator::class,
'Parser' => Parser::class,
'File' => File::class,
'Sanitize' => Sanitize::class,
'Item' => Item::class,
'Author' => Author::class,
'Category' => Category::class,
'Enclosure' => Enclosure::class,
'Caption' => Caption::class,
'Copyright' => Copyright::class,
'Credit' => Credit::class,
'Rating' => Rating::class,
'Restriction' => Restriction::class,
'Content_Type_Sniffer' => Sniffer::class,
'Source' => Source::class,
'Misc' => Misc::class,
'XML_Declaration_Parser' => DeclarationParser::class,
'Parse_Date' => Date::class,
];
/**
* Constructor
*
* No-op
*/
public function __construct()
{
}
/**
* Register a class
*
* @param string $type See {@see $default} for names
* @param class-string $class Class name, must subclass the corresponding default
* @param bool $legacy Whether to enable legacy support for this class
* @return bool Successfulness
*/
public function register(string $type, $class, bool $legacy = false)
{
if (array_key_exists($type, $this->legacyTypes)) {
// 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);
$type = $this->legacyTypes[$type];
}
if (!array_key_exists($type, $this->default)) {
return false;
}
if (!class_exists($class)) {
return false;
}
/** @var string */
$base_class = $this->default[$type];
if (!is_subclass_of($class, $base_class)) {
return false;
}
$this->classes[$type] = $class;
if ($legacy) {
$this->legacy[] = $class;
}
return true;
}
/**
* Get the class registered for a type
*
* Where possible, use {@see create()} or {@see call()} instead
*
* @template T
* @param class-string<T> $type
* @return class-string<T>|null
*/
public function get_class($type)
{
if (array_key_exists($type, $this->legacyTypes)) {
// 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);
$type = $this->legacyTypes[$type];
}
if (!array_key_exists($type, $this->default)) {
return null;
}
// For PHPStan: values in $default should be subtypes of keys.
/** @var class-string<T> */
$class = $this->default[$type];
if (array_key_exists($type, $this->classes)) {
// For PHPStan: values in $classes should be subtypes of keys.
/** @var class-string<T> */
$class = $this->classes[$type];
}
return $class;
}
/**
* Create a new instance of a given type
*
* @template T class-string $type
* @param class-string<T> $type
* @param array<mixed> $parameters Parameters to pass to the constructor
* @return T Instance of class
*/
public function &create($type, array $parameters = [])
{
$class = $this->get_class($type);
if ($class === null) {
throw new InvalidArgumentException(sprintf(
'%s(): Argument #1 ($type) "%s" not found in class list.',
__METHOD__,
$type
), 1);
}
if (!method_exists($class, '__construct')) {
$instance = new $class();
} else {
$reflector = new \ReflectionClass($class);
// For PHPStan: $class is T.
/** @var T */
$instance = $reflector->newInstanceArgs($parameters);
}
if ($instance instanceof RegistryAware) {
$instance->set_registry($this);
} elseif (method_exists($instance, 'set_registry')) {
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);
$instance->set_registry($this);
}
return $instance;
}
/**
* Call a static method for a type
*
* @param class-string $type
* @param string $method
* @param array<mixed> $parameters
* @return mixed
*/
public function &call($type, string $method, array $parameters = [])
{
$class = $this->get_class($type);
if ($class === null) {
throw new InvalidArgumentException(sprintf(
'%s(): Argument #1 ($type) "%s" not found in class list.',
__METHOD__,
$type
), 1);
}
if (in_array($class, $this->legacy)) {
switch ($type) {
case Cache::class:
// For backwards compatibility with old non-static
// Cache::create() methods in PHP < 8.0.
// No longer supported as of PHP 8.0.
if ($method === 'get_handler') {
// Fixing this PHPStan error breaks CacheTest::testDirectOverrideLegacy()
/** @phpstan-ignore argument.type */
$result = @call_user_func_array([$class, 'create'], $parameters);
return $result;
}
break;
}
}
$callable = [$class, $method];
assert(is_callable($callable), 'For PHPstan');
$result = call_user_func_array($callable, $parameters);
return $result;
}
}
class_alias('SimplePie\Registry', 'SimplePie_Registry');