commit message

vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php

@@ -0,0 +1,163 @@
+<?php
+/**
+ * Class SettingsContainerAbstract
+ *
+ * @created      28.08.2018
+ * @author       Smiley <smiley@chillerlan.net>
+ * @copyright    2018 Smiley
+ * @license      MIT
+ */
+
+namespace chillerlan\Settings;
+
+use ReflectionClass, ReflectionProperty;
+
+use function get_object_vars, json_decode, json_encode, method_exists, property_exists;
+use const JSON_THROW_ON_ERROR;
+
+abstract class SettingsContainerAbstract implements SettingsContainerInterface{
+
+	/**
+	 * SettingsContainerAbstract constructor.
+	 */
+	public function __construct(iterable $properties = null){
+
+		if(!empty($properties)){
+			$this->fromIterable($properties);
+		}
+
+		$this->construct();
+	}
+
+	/**
+	 * calls a method with trait name as replacement constructor for each used trait
+	 * (remember pre-php5 classname constructors? yeah, basically this.)
+	 */
+	protected function construct():void{
+		$traits = (new ReflectionClass($this))->getTraits();
+
+		foreach($traits as $trait){
+			$method = $trait->getShortName();
+
+			if(method_exists($this, $method)){
+				$this->{$method}();
+			}
+		}
+
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function __get(string $property){
+
+		if(!property_exists($this, $property) || $this->isPrivate($property)){
+			return null;
+		}
+
+		$method = 'get_'.$property;
+
+		if(method_exists($this, $method)){
+			return $this->{$method}();
+		}
+
+		return $this->{$property};
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function __set(string $property, $value):void{
+
+		if(!property_exists($this, $property) || $this->isPrivate($property)){
+			return;
+		}
+
+		$method = 'set_'.$property;
+
+		if(method_exists($this, $method)){
+			$this->{$method}($value);
+
+			return;
+		}
+
+		$this->{$property} = $value;
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function __isset(string $property):bool{
+		return isset($this->{$property}) && !$this->isPrivate($property);
+	}
+
+	/**
+	 * @internal Checks if a property is private
+	 */
+	protected function isPrivate(string $property):bool{
+		return (new ReflectionProperty($this, $property))->isPrivate();
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function __unset(string $property):void{
+
+		if($this->__isset($property)){
+			unset($this->{$property});
+		}
+
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function __toString():string{
+		return $this->toJSON();
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function toArray():array{
+		return get_object_vars($this);
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function fromIterable(iterable $properties):SettingsContainerInterface{
+
+		foreach($properties as $key => $value){
+			$this->__set($key, $value);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function toJSON(int $jsonOptions = null):string{
+		return json_encode($this, ($jsonOptions ?? 0));
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function fromJSON(string $json):SettingsContainerInterface{
+		$data = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
+
+		return $this->fromIterable($data);
+	}
+
+	/**
+	 * @inheritdoc
+	 * @phan-suppress PhanUndeclaredClassAttribute
+	 */
+	#[\ReturnTypeWillChange]
+	public function jsonSerialize():array{
+		return $this->toArray();
+	}
+
+}

vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php

@@ -0,0 +1,74 @@
+<?php
+/**
+ * Interface SettingsContainerInterface
+ *
+ * @created      28.08.2018
+ * @author       Smiley <smiley@chillerlan.net>
+ * @copyright    2018 Smiley
+ * @license      MIT
+ */
+
+namespace chillerlan\Settings;
+
+use JsonSerializable;
+
+/**
+ * a generic container with magic getter and setter
+ */
+interface SettingsContainerInterface extends JsonSerializable{
+
+	/**
+	 * Retrieve the value of $property
+	 *
+	 * @return mixed|null
+	 */
+	public function __get(string $property);
+
+	/**
+	 * Set $property to $value while avoiding private and non-existing properties
+	 *
+	 * @param string $property
+	 * @param mixed  $value
+	 */
+	public function __set(string $property, $value):void;
+
+	/**
+	 * Checks if $property is set (aka. not null), excluding private properties
+	 */
+	public function __isset(string $property):bool;
+
+	/**
+	 * Unsets $property while avoiding private and non-existing properties
+	 */
+	public function __unset(string $property):void;
+
+	/**
+	 * @see SettingsContainerInterface::toJSON()
+	 */
+	public function __toString():string;
+
+	/**
+	 * Returns an array representation of the settings object
+	 */
+	public function toArray():array;
+
+	/**
+	 * Sets properties from a given iterable
+	 */
+	public function fromIterable(iterable $properties):SettingsContainerInterface;
+
+	/**
+	 * Returns a JSON representation of the settings object
+	 * @see \json_encode()
+	 */
+	public function toJSON(int $jsonOptions = null):string;
+
+	/**
+	 * Sets properties from a given JSON string
+	 *
+	 * @throws \Exception
+	 * @throws \JsonException
+	 */
+	public function fromJSON(string $json):SettingsContainerInterface;
+
+}