Feature: Labelprint für Kistenetiketten hinzugefügt
This commit is contained in:
@@ -19,23 +19,23 @@ A container class for settings objects - decouple configuration logic from your
|
||||
[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
|
||||
[codacy-badge]: https://img.shields.io/codacy/grade/bd2467799e2943d2853ce3ebad5af490/main?logo=codacy
|
||||
[codacy]: https://www.codacy.com/gh/chillerlan/php-settings-container/dashboard?branch=main
|
||||
[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
|
||||
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-settings-container/ci.yml?branch=main&logo=github
|
||||
[gh-action]: https://github.com/chillerlan/php-settings-container/actions/workflows/ci.yml?query=branch%3Amain
|
||||
|
||||
## 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)
|
||||
*composer.json* (note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^3.0` - see [releases](https://github.com/chillerlan/php-settings-container/releases) for valid versions)
|
||||
```json
|
||||
{
|
||||
"require": {
|
||||
"php": "^7.4 || ^8.0",
|
||||
"php": "^8.1",
|
||||
"chillerlan/php-settings-container": "dev-main"
|
||||
}
|
||||
}
|
||||
@@ -45,18 +45,14 @@ 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.
|
||||
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.
|
||||
|
||||
A PHPStan ruleset to exclude errors generated by accessing magic properties on `SettingsContainerInterface` can be found in `rules-magic-access.neon`.
|
||||
|
||||
|
||||
### 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;
|
||||
@@ -64,12 +60,12 @@ class MyContainer extends SettingsContainerAbstract{
|
||||
```
|
||||
|
||||
```php
|
||||
// use it just like a \stdClass
|
||||
// use it just like a \stdClass (except the properties are fixed)
|
||||
$container = new MyContainer;
|
||||
$container->foo = 'what';
|
||||
$container->bar = 'foo';
|
||||
|
||||
// which is equivalent to
|
||||
// which is equivalent to
|
||||
$container = new MyContainer(['bar' => 'foo', 'foo' => 'what']);
|
||||
// ...or try
|
||||
$container->fromJSON('{"foo": "what", "bar": "foo"}');
|
||||
@@ -90,37 +86,48 @@ var_dump($container->nope); // -> null
|
||||
|
||||
### Advanced usage
|
||||
```php
|
||||
// from library 1
|
||||
trait SomeOptions{
|
||||
protected $foo;
|
||||
protected $what;
|
||||
|
||||
protected string $foo;
|
||||
protected string $what;
|
||||
|
||||
// this method will be called in SettingsContainerAbstract::construct()
|
||||
// after the properties have been set
|
||||
protected function SomeOptions(){
|
||||
protected function SomeOptions():void{
|
||||
// just some constructor stuff...
|
||||
$this->foo = strtoupper($this->foo);
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* special prefixed magic setters & getters
|
||||
*/
|
||||
|
||||
// this method will be called from __set() when property $what is set
|
||||
protected function set_what(string $value){
|
||||
protected function set_what(string $value):void{
|
||||
$this->what = md5($value);
|
||||
}
|
||||
|
||||
// this method is called on __get() for the property $what
|
||||
protected function get_what():string{
|
||||
return 'hash: '.$this->what;
|
||||
}
|
||||
}
|
||||
|
||||
// from library 2
|
||||
trait MoreOptions{
|
||||
protected $bar = 'whatever'; // provide default values
|
||||
protected string $bar = 'whatever'; // provide default values
|
||||
}
|
||||
```
|
||||
|
||||
```php
|
||||
$commonOptions = [
|
||||
// SomeOptions
|
||||
'foo' => 'whatever',
|
||||
'foo' => 'whatever',
|
||||
// MoreOptions
|
||||
'bar' => 'nothing',
|
||||
];
|
||||
|
||||
// now plug the several library options together to a single object
|
||||
// now plug the several library options together to a single object
|
||||
$container = new class ($commonOptions) extends SettingsContainerAbstract{
|
||||
use SomeOptions, MoreOptions;
|
||||
};
|
||||
@@ -129,27 +136,31 @@ var_dump($container->foo); // -> WHATEVER (constructor ran strtoupper on the val
|
||||
var_dump($container->bar); // -> nothing
|
||||
|
||||
$container->what = 'some value';
|
||||
var_dump($container->what); // -> md5 hash of "some value"
|
||||
var_dump($container->what); // -> hash: 5946210c9e93ae37891dfe96c3e39614 (custom getter added "hash: ")
|
||||
```
|
||||
|
||||
### 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
|
||||
| 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 |
|
||||
| `serialize()` | string | implements the [`Serializable`](https://www.php.net/manual/en/serializable.serialize.php) interface |
|
||||
| `unserialize(string $data)` | void | implements the [`Serializable`](https://www.php.net/manual/en/serializable.unserialize.php) interface |
|
||||
| `__serialize()` | array | implements the [`Serializable`](https://www.php.net/manual/en/language.oop5.magic.php#object.serialize) interface |
|
||||
| `__unserialize(array $data)` | void | implements the [`Serializable`](https://www.php.net/manual/en/language.oop5.magic.php#object.unserialize) interface |
|
||||
|
||||
## Disclaimer
|
||||
This might be either an utterly genius or completely stupid idea - you decide. However, i like it and it works.
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "chillerlan/php-settings-container",
|
||||
"description": "A container class for immutable settings objects. Not a DI container. PHP 7.4+",
|
||||
"description": "A container class for immutable settings objects. Not a DI container.",
|
||||
"homepage": "https://github.com/chillerlan/php-settings-container",
|
||||
"license": "MIT",
|
||||
"type": "library",
|
||||
"minimum-stability": "stable",
|
||||
"keywords": [
|
||||
"php7", "helper", "container", "settings", "configuration"
|
||||
"helper", "container", "settings", "configuration"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
@@ -20,28 +20,29 @@
|
||||
"source": "https://github.com/chillerlan/php-settings-container"
|
||||
},
|
||||
"require": {
|
||||
"php": "^7.4 || ^8.0",
|
||||
"php": "^8.1",
|
||||
"ext-json": "*"
|
||||
},
|
||||
"require-dev": {
|
||||
"phan/phan": "^5.4",
|
||||
"phpmd/phpmd": "^2.13",
|
||||
"phpunit/phpunit": "^9.6",
|
||||
"phpcsstandards/php_codesniffer": "^3.8"
|
||||
"phpmd/phpmd": "^2.15",
|
||||
"phpstan/phpstan": "^1.11",
|
||||
"phpstan/phpstan-deprecation-rules": "^1.2",
|
||||
"phpunit/phpunit": "^10.5",
|
||||
"squizlabs/php_codesniffer": "^3.10"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"chillerlan\\Settings\\": "src/"
|
||||
"chillerlan\\Settings\\": "src"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"chillerlan\\SettingsTest\\": "tests/"
|
||||
"chillerlan\\SettingsTest\\": "tests"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"phpunit": "@php vendor/bin/phpunit",
|
||||
"phan": "@php vendor/bin/phan"
|
||||
"phpstan": "@php vendor/bin/phpstan"
|
||||
},
|
||||
"config": {
|
||||
"lock": false,
|
||||
|
||||
4
vendor/chillerlan/php-settings-container/rules-magic-access.neon
vendored
Normal file
4
vendor/chillerlan/php-settings-container/rules-magic-access.neon
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
parameters:
|
||||
ignoreErrors:
|
||||
# yes, these are magic
|
||||
- message: "#^Access to an undefined property chillerlan\\\\Settings\\\\SettingsContainerInterface\\:\\:\\$[\\w]+\\.$#"
|
||||
@@ -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,11 +169,84 @@ abstract class SettingsContainerAbstract implements SettingsContainerInterface{
|
||||
|
||||
/**
|
||||
* @inheritdoc
|
||||
* @phan-suppress PhanUndeclaredClassAttribute
|
||||
* @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;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -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;
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user