diff options
Diffstat (limited to 'vendor/chillerlan/php-settings-container/src')
-rw-r--r-- | vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php | 114 | ||||
-rw-r--r-- | vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php | 34 |
2 files changed, 125 insertions, 23 deletions
diff --git a/vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php b/vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php index 6b7a1ecc2..826faaf25 100644 --- a/vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php +++ b/vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php @@ -7,20 +7,23 @@ * @copyright 2018 Smiley * @license MIT */ +declare(strict_types=1); namespace chillerlan\Settings; -use ReflectionClass, ReflectionProperty; - -use function get_object_vars, json_decode, json_encode, method_exists, property_exists; +use InvalidArgumentException, JsonException, ReflectionClass, ReflectionProperty; +use function array_keys, get_object_vars, is_object, json_decode, json_encode, + json_last_error_msg, method_exists, property_exists, serialize, unserialize; use const JSON_THROW_ON_ERROR; abstract class SettingsContainerAbstract implements SettingsContainerInterface{ /** * SettingsContainerAbstract constructor. + * + * @phpstan-param array<string, mixed> $properties */ - public function __construct(iterable $properties = null){ + public function __construct(iterable|null $properties = null){ if(!empty($properties)){ $this->fromIterable($properties); @@ -49,7 +52,7 @@ abstract class SettingsContainerAbstract implements SettingsContainerInterface{ /** * @inheritdoc */ - public function __get(string $property){ + public function __get(string $property):mixed{ if(!property_exists($this, $property) || $this->isPrivate($property)){ return null; @@ -67,7 +70,7 @@ abstract class SettingsContainerAbstract implements SettingsContainerInterface{ /** * @inheritdoc */ - public function __set(string $property, $value):void{ + public function __set(string $property, mixed $value):void{ if(!property_exists($this, $property) || $this->isPrivate($property)){ return; @@ -120,13 +123,19 @@ abstract class SettingsContainerAbstract implements SettingsContainerInterface{ * @inheritdoc */ public function toArray():array{ - return get_object_vars($this); + $properties = []; + + foreach(array_keys(get_object_vars($this)) as $key){ + $properties[$key] = $this->__get($key); + } + + return $properties; } /** * @inheritdoc */ - public function fromIterable(iterable $properties):SettingsContainerInterface{ + public function fromIterable(iterable $properties):static{ foreach($properties as $key => $value){ $this->__set($key, $value); @@ -138,14 +147,21 @@ abstract class SettingsContainerAbstract implements SettingsContainerInterface{ /** * @inheritdoc */ - public function toJSON(int $jsonOptions = null):string{ - return json_encode($this, $jsonOptions ?? 0); + public function toJSON(int|null $jsonOptions = null):string{ + $json = json_encode($this, ($jsonOptions ?? 0)); + + if($json === false){ + throw new JsonException(json_last_error_msg()); + } + + return $json; } /** * @inheritdoc */ - public function fromJSON(string $json):SettingsContainerInterface{ + public function fromJSON(string $json):static{ + /** @phpstan-var array<string, mixed> $data */ $data = json_decode($json, true, 512, JSON_THROW_ON_ERROR); return $this->fromIterable($data); @@ -153,10 +169,84 @@ abstract class SettingsContainerAbstract implements SettingsContainerInterface{ /** * @inheritdoc + * @return array<string, mixed> */ - #[\ReturnTypeWillChange] public function jsonSerialize():array{ return $this->toArray(); } + /** + * Returns a serialized string representation of the object in its current state (except static/readonly properties) + * + * @inheritdoc + * @see \chillerlan\Settings\SettingsContainerInterface::toArray() + */ + public function serialize():string{ + return serialize($this); + } + + /** + * Restores the data (except static/readonly properties) from the given serialized object to the current instance + * + * @inheritdoc + * @see \chillerlan\Settings\SettingsContainerInterface::fromIterable() + */ + public function unserialize(string $data):void{ + $obj = unserialize($data); + + if($obj === false || !is_object($obj)){ + throw new InvalidArgumentException('The given serialized string is invalid'); + } + + $reflection = new ReflectionClass($obj); + + if(!$reflection->isInstance($this)){ + throw new InvalidArgumentException('The unserialized object does not match the class of this container'); + } + + $properties = $reflection->getProperties(~(ReflectionProperty::IS_STATIC | ReflectionProperty::IS_READONLY)); + + foreach($properties as $reflectionProperty){ + $this->{$reflectionProperty->name} = $reflectionProperty->getValue($obj); + } + + } + + /** + * Returns a serialized string representation of the object in its current state (except static/readonly properties) + * + * @inheritdoc + * @see \chillerlan\Settings\SettingsContainerInterface::toArray() + */ + public function __serialize():array{ + + $properties = (new ReflectionClass($this)) + ->getProperties(~(ReflectionProperty::IS_STATIC | ReflectionProperty::IS_READONLY)) + ; + + $data = []; + + foreach($properties as $reflectionProperty){ + $data[$reflectionProperty->name] = $reflectionProperty->getValue($this); + } + + return $data; + } + + /** + * Restores the data from the given array to the current instance + * + * @inheritdoc + * @see \chillerlan\Settings\SettingsContainerInterface::fromIterable() + * + * @param array<string, mixed> $data + */ + public function __unserialize(array $data):void{ + + foreach($data as $key => $value){ + $this->{$key} = $value; + } + + } + } diff --git a/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php b/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php index ddacccd29..6f3cc1a4d 100644 --- a/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php +++ b/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php @@ -7,30 +7,28 @@ * @copyright 2018 Smiley * @license MIT */ +declare(strict_types=1); namespace chillerlan\Settings; -use JsonSerializable; +use JsonSerializable, Serializable; /** * a generic container with magic getter and setter */ -interface SettingsContainerInterface extends JsonSerializable{ +interface SettingsContainerInterface extends JsonSerializable, Serializable{ /** * Retrieve the value of $property * * @return mixed|null */ - public function __get(string $property); + public function __get(string $property):mixed; /** * Set $property to $value while avoiding private and non-existing properties - * - * @param string $property - * @param mixed $value */ - public function __set(string $property, $value):void; + public function __set(string $property, mixed $value):void; /** * Checks if $property is set (aka. not null), excluding private properties @@ -43,32 +41,46 @@ interface SettingsContainerInterface extends JsonSerializable{ public function __unset(string $property):void; /** - * @see SettingsContainerInterface::toJSON() + * @see \chillerlan\Settings\SettingsContainerInterface::toJSON() */ public function __toString():string; /** * Returns an array representation of the settings object + * + * The values will be run through the magic __get(), which may also call custom getters. + * + * @return array<string, mixed> */ public function toArray():array; /** * Sets properties from a given iterable + * + * The values will be run through the magic __set(), which may also call custom setters. + * + * @phpstan-param array<string, mixed> $properties */ - public function fromIterable(iterable $properties):SettingsContainerInterface; + public function fromIterable(iterable $properties):static; /** * Returns a JSON representation of the settings object + * * @see \json_encode() + * @see \chillerlan\Settings\SettingsContainerInterface::toArray() + * + * @throws \JsonException */ - public function toJSON(int $jsonOptions = null):string; + public function toJSON(int|null $jsonOptions = null):string; /** * Sets properties from a given JSON string * + * @see \chillerlan\Settings\SettingsContainerInterface::fromIterable() + * * @throws \Exception * @throws \JsonException */ - public function fromJSON(string $json):SettingsContainerInterface; + public function fromJSON(string $json):static; } |