summaryrefslogtreecommitdiff
path: root/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php')
-rw-r--r--vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php32
1 files changed, 1 insertions, 31 deletions
diff --git a/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php b/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php
index 59cef6232..ddacccd29 100644
--- a/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php
+++ b/vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php
@@ -2,9 +2,7 @@
/**
* Interface SettingsContainerInterface
*
- * @filesource SettingsContainerInterface.php
* @created 28.08.2018
- * @package chillerlan\Settings
* @author Smiley <[email protected]>
* @copyright 2018 Smiley
* @license MIT
@@ -22,9 +20,7 @@ interface SettingsContainerInterface extends JsonSerializable{
/**
* Retrieve the value of $property
*
- * @param string $property
- *
- * @return mixed
+ * @return mixed|null
*/
public function __get(string $property);
@@ -33,69 +29,43 @@ interface SettingsContainerInterface extends JsonSerializable{
*
* @param string $property
* @param mixed $value
- *
- * @return void
*/
public function __set(string $property, $value):void;
/**
* Checks if $property is set (aka. not null), excluding private properties
- *
- * @param string $property
- *
- * @return bool
*/
public function __isset(string $property):bool;
/**
* Unsets $property while avoiding private and non-existing properties
- *
- * @param string $property
- *
- * @return void
*/
public function __unset(string $property):void;
/**
* @see SettingsContainerInterface::toJSON()
- *
- * @return string
*/
public function __toString():string;
/**
* Returns an array representation of the settings object
- *
- * @return array
*/
public function toArray():array;
/**
* Sets properties from a given iterable
- *
- * @param iterable $properties
- *
- * @return \chillerlan\Settings\SettingsContainerInterface
*/
public function fromIterable(iterable $properties):SettingsContainerInterface;
/**
* Returns a JSON representation of the settings object
* @see \json_encode()
- *
- * @param int|null $jsonOptions
- *
- * @return string
*/
public function toJSON(int $jsonOptions = null):string;
/**
* Sets properties from a given JSON string
*
- * @param string $json
- *
- * @return \chillerlan\Settings\SettingsContainerInterface
- *
* @throws \Exception
* @throws \JsonException
*/