added dependencies
This commit is contained in:
21
vendor/chillerlan/php-settings-container/LICENSE
vendored
Normal file
21
vendor/chillerlan/php-settings-container/LICENSE
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Smiley <smiley@chillerlan.net>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
156
vendor/chillerlan/php-settings-container/README.md
vendored
Normal file
156
vendor/chillerlan/php-settings-container/README.md
vendored
Normal file
@@ -0,0 +1,156 @@
|
||||
# chillerlan/php-settings-container
|
||||
|
||||
A container class for settings objects - decouple configuration logic from your application! Not a DI container.
|
||||
- [`SettingsContainerInterface`](https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerInterface.php) provides immutable properties with magic getter & setter and some fancy.
|
||||
|
||||
[![PHP Version Support][php-badge]][php]
|
||||
[![version][packagist-badge]][packagist]
|
||||
[![license][license-badge]][license]
|
||||
[![Continuous Integration][gh-action-badge]][gh-action]
|
||||
[![Coverage][coverage-badge]][coverage]
|
||||
[![Codacy][codacy-badge]][codacy]
|
||||
[![Packagist downloads][downloads-badge]][downloads]
|
||||
|
||||
[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-settings-container?logo=php&color=8892BF
|
||||
[php]: https://www.php.net/supported-versions.php
|
||||
[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-settings-container.svg?logo=packagist
|
||||
[packagist]: https://packagist.org/packages/chillerlan/php-settings-container
|
||||
[license-badge]: https://img.shields.io/github/license/chillerlan/php-settings-container.svg
|
||||
[license]: https://github.com/chillerlan/php-settings-container/blob/main/LICENSE
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-settings-container.svg?logo=codecov
|
||||
[coverage]: https://codecov.io/github/chillerlan/php-settings-container
|
||||
[codacy-badge]: https://img.shields.io/codacy/grade/bd2467799e2943d2853ce3ebad5af490/v2.x-php7.4?logo=codacy
|
||||
[codacy]: https://app.codacy.com/gh/chillerlan/php-settings-container/dashboard?branch=v2.x-php7.4
|
||||
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-settings-container.svg?logo=packagist
|
||||
[downloads]: https://packagist.org/packages/chillerlan/php-settings-container/stats
|
||||
[gh-action-badge]: https://github.com/chillerlan/php-settings-container/workflows/CI/badge.svg
|
||||
[gh-action]: https://github.com/chillerlan/php-settings-container/actions?query=workflow%3A%22CI%22
|
||||
|
||||
## Documentation
|
||||
|
||||
### Installation
|
||||
**requires [composer](https://getcomposer.org)**
|
||||
|
||||
*composer.json* (note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^2.1` - see [releases](https://github.com/chillerlan/php-settings-container/releases) for valid versions)
|
||||
```json
|
||||
{
|
||||
"require": {
|
||||
"php": "^7.4 || ^8.0",
|
||||
"chillerlan/php-settings-container": "dev-main"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Profit!
|
||||
|
||||
## Usage
|
||||
|
||||
The `SettingsContainerInterface` (wrapped in`SettingsContainerAbstract` ) provides plug-in functionality for immutable object properties and adds some fancy, like loading/saving JSON, arrays etc.
|
||||
It takes an `iterable` as the only constructor argument and calls a method with the trait's name on invocation (`MyTrait::MyTrait()`) for each used trait.
|
||||
|
||||
### Simple usage
|
||||
```php
|
||||
class MyContainer extends SettingsContainerAbstract{
|
||||
protected $foo;
|
||||
protected $bar;
|
||||
}
|
||||
```
|
||||
Typed properties in PHP 7.4+:
|
||||
```php
|
||||
class MyContainer extends SettingsContainerAbstract{
|
||||
protected string $foo;
|
||||
protected string $bar;
|
||||
}
|
||||
```
|
||||
|
||||
```php
|
||||
// use it just like a \stdClass
|
||||
$container = new MyContainer;
|
||||
$container->foo = 'what';
|
||||
$container->bar = 'foo';
|
||||
|
||||
// which is equivalent to
|
||||
$container = new MyContainer(['bar' => 'foo', 'foo' => 'what']);
|
||||
// ...or try
|
||||
$container->fromJSON('{"foo": "what", "bar": "foo"}');
|
||||
|
||||
|
||||
// fetch all properties as array
|
||||
$container->toArray(); // -> ['foo' => 'what', 'bar' => 'foo']
|
||||
// or JSON
|
||||
$container->toJSON(); // -> {"foo": "what", "bar": "foo"}
|
||||
// JSON via JsonSerializable
|
||||
$json = json_encode($container); // -> {"foo": "what", "bar": "foo"}
|
||||
|
||||
//non-existing properties will be ignored:
|
||||
$container->nope = 'what';
|
||||
|
||||
var_dump($container->nope); // -> null
|
||||
```
|
||||
|
||||
### Advanced usage
|
||||
```php
|
||||
trait SomeOptions{
|
||||
protected $foo;
|
||||
protected $what;
|
||||
|
||||
// this method will be called in SettingsContainerAbstract::construct()
|
||||
// after the properties have been set
|
||||
protected function SomeOptions(){
|
||||
// just some constructor stuff...
|
||||
$this->foo = strtoupper($this->foo);
|
||||
}
|
||||
|
||||
// this method will be called from __set() when property $what is set
|
||||
protected function set_what(string $value){
|
||||
$this->what = md5($value);
|
||||
}
|
||||
}
|
||||
|
||||
trait MoreOptions{
|
||||
protected $bar = 'whatever'; // provide default values
|
||||
}
|
||||
```
|
||||
|
||||
```php
|
||||
$commonOptions = [
|
||||
// SomeOptions
|
||||
'foo' => 'whatever',
|
||||
// MoreOptions
|
||||
'bar' => 'nothing',
|
||||
];
|
||||
|
||||
// now plug the several library options together to a single object
|
||||
$container = new class ($commonOptions) extends SettingsContainerAbstract{
|
||||
use SomeOptions, MoreOptions;
|
||||
};
|
||||
|
||||
var_dump($container->foo); // -> WHATEVER (constructor ran strtoupper on the value)
|
||||
var_dump($container->bar); // -> nothing
|
||||
|
||||
$container->what = 'some value';
|
||||
var_dump($container->what); // -> md5 hash of "some value"
|
||||
```
|
||||
|
||||
### API
|
||||
|
||||
#### [`SettingsContainerAbstract`](https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerAbstract.php)
|
||||
|
||||
method | return | info
|
||||
-------- | ---- | -----------
|
||||
`__construct(iterable $properties = null)` | - | calls `construct()` internally after the properties have been set
|
||||
(protected) `construct()` | void | calls a method with trait name as replacement constructor for each used trait
|
||||
`__get(string $property)` | mixed | calls `$this->{'get_'.$property}()` if such a method exists
|
||||
`__set(string $property, $value)` | void | calls `$this->{'set_'.$property}($value)` if such a method exists
|
||||
`__isset(string $property)` | bool |
|
||||
`__unset(string $property)` | void |
|
||||
`__toString()` | string | a JSON string
|
||||
`toArray()` | array |
|
||||
`fromIterable(iterable $properties)` | `SettingsContainerInterface` |
|
||||
`toJSON(int $jsonOptions = null)` | string | accepts [JSON options constants](http://php.net/manual/json.constants.php)
|
||||
`fromJSON(string $json)` | `SettingsContainerInterface` |
|
||||
`jsonSerialize()` | mixed | implements the [`JsonSerializable`](https://www.php.net/manual/en/jsonserializable.jsonserialize.php) interface
|
||||
|
||||
## Disclaimer
|
||||
This might be either an utterly genius or completely stupid idea - you decide. However, i like it and it works.
|
||||
Also, this is not a dependency injection container. Stop using DI containers FFS.
|
||||
51
vendor/chillerlan/php-settings-container/composer.json
vendored
Normal file
51
vendor/chillerlan/php-settings-container/composer.json
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
{
|
||||
"name": "chillerlan/php-settings-container",
|
||||
"description": "A container class for immutable settings objects. Not a DI container. PHP 7.4+",
|
||||
"homepage": "https://github.com/chillerlan/php-settings-container",
|
||||
"license": "MIT",
|
||||
"type": "library",
|
||||
"minimum-stability": "stable",
|
||||
"keywords": [
|
||||
"php7", "helper", "container", "settings", "configuration"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Smiley",
|
||||
"email": "smiley@chillerlan.net",
|
||||
"homepage": "https://github.com/codemasher"
|
||||
}
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/chillerlan/php-settings-container/issues",
|
||||
"source": "https://github.com/chillerlan/php-settings-container"
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.4 || ^8.0",
|
||||
"ext-json": "*"
|
||||
},
|
||||
"require-dev": {
|
||||
"phan/phan": "^5.4",
|
||||
"phpmd/phpmd": "^2.13",
|
||||
"phpunit/phpunit": "^9.6",
|
||||
"phpcsstandards/php_codesniffer": "^3.8"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"chillerlan\\Settings\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"chillerlan\\SettingsTest\\": "tests/"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"phpunit": "@php vendor/bin/phpunit",
|
||||
"phan": "@php vendor/bin/phan"
|
||||
},
|
||||
"config": {
|
||||
"lock": false,
|
||||
"sort-packages": true,
|
||||
"platform-check": true
|
||||
}
|
||||
}
|
||||
163
vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php
vendored
Normal file
163
vendor/chillerlan/php-settings-container/src/SettingsContainerAbstract.php
vendored
Normal file
@@ -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();
|
||||
}
|
||||
|
||||
}
|
||||
74
vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php
vendored
Normal file
74
vendor/chillerlan/php-settings-container/src/SettingsContainerInterface.php
vendored
Normal file
@@ -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;
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user