chillerlan / php-settings-container
A container class for immutable settings objects. Not a DI container.
Fund package maintenance!
Ko Fi
www.paypal.com/donate?hosted_button_id=WLYUNAT9ZTJZ4
Installs: 12 255 047
Dependents: 24
Suggesters: 0
Security: 0
Stars: 27
Watchers: 3
Forks: 5
Open Issues: 0
Requires
- php: ^8.1
- ext-json: *
Requires (Dev)
- phpmd/phpmd: ^2.15
- phpstan/phpstan: ^1.11
- phpstan/phpstan-deprecation-rules: ^1.2
- phpunit/phpunit: ^10.5
- squizlabs/php_codesniffer: ^3.10
README
A container class for settings objects - decouple configuration logic from your application! Not a DI container.
SettingsContainerInterface
provides immutable properties with magic getter & setter and some fancy.
Documentation
Installation
requires composer
composer.json (note: replace dev-main
with a version constraint, e.g. ^3.0
- see releases for valid versions)
{ "require": { "php": "^8.1", "chillerlan/php-settings-container": "dev-main" } }
Profit!
Usage
The SettingsContainerInterface
(wrapped inSettingsContainerAbstract
) 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
class MyContainer extends SettingsContainerAbstract{ protected string $foo; protected string $bar; }
// use it just like a \stdClass (except the properties are fixed) $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
// from library 1 trait SomeOptions{ protected string $foo; protected string $what; // this method will be called in SettingsContainerAbstract::construct() // after the properties have been set 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):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 string $bar = 'whatever'; // provide default values }
$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); // -> hash: 5946210c9e93ae37891dfe96c3e39614 (custom getter added "hash: ")
API
SettingsContainerAbstract
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.