Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrself/php-options
Dependency injection without dependency injection
https://github.com/mrself/php-options
dependency-injection options package php
Last synced: about 1 month ago
JSON representation
Dependency injection without dependency injection
- Host: GitHub
- URL: https://github.com/mrself/php-options
- Owner: mrself
- License: mit
- Created: 2019-01-29T06:55:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T18:36:27.000Z (3 months ago)
- Last Synced: 2024-12-18T11:28:23.327Z (about 2 months ago)
- Topics: dependency-injection, options, package, php
- Language: PHP
- Homepage:
- Size: 217 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Demo
Add the trait to your class
```php
class ClassWithOptions
{
use \Mrself\Options\WithOptionsTrait;
}
```
Add the first option:
```php
use Mrself\Options\Annotation\Option;
class ClassWithOptions
{
use \Mrself\Options\WithOptionsTrait;
/**
* The required option to initialize the class
* @Option()
* @var array
*/
private $arrayOption;
public function getOption()
{
return $this->arrayOption;
}
}
```
Initialize the class:
```php
$instance = ClassWithOptions::make(['arrayOption' => ['key' => 'value']]);
// True
$instance->getOption()['key'] === 'value';
```
An exception is thrown if the option is of missed:
```php
// Exception \Symfony\Component\OptionsResolver\Exception\MissingOptionsException
$instance = ClassWithOptions::make();
```
## More examples
Type resolving:
```php
use Mrself\Options\Annotation\Option;
class ClassWithOptions
{
use \Mrself\Options\WithOptionsTrait;
/**
* @Option()
* @var array
*/
private $arrayOption;
public function getOption()
{
return $this->arrayOption;
}
}
$notArray = 1;
// Exception
ClassWithOptions::make(['arrayOption' => $notArray]);
```
```php
use Mrself\Options\Annotation\Option;
class ClassWithOptions
{
use \Mrself\Options\WithOptionsTrait;
/**
* @Option()
* @var \DateTime
*/
private $arrayOption;
public function getOption()
{
return $this->arrayOption;
}
}
$notDate = 1;
// Exception
ClassWithOptions::make(['arrayOption' => $notDate]);
```
## Using with container (see mrself/container)
```php
use Mrself\Options\Annotation\Option;
use Mrself\Container\Container;
use Mrself\Container\Registry\ContainerRegistry;
$service = new \stdClass();
$service->property = 'myProperty';
$container = Container::make();
$container->set('service', $service);
ContainerRegistry::add('App', $container);
class ClassWithOptions
{
use \Mrself\Options\WithOptionsTrait;
/**
* @Option()
* @var \stdClass
*/
private $service;
public function getService()
{
return $this->service;
}
}
$instance = ClassWithOptions::make();
// True
$instance->getService()->property === 'myProperty';
```
This trait can be used with Symfony or another framework with public services.
Suspend all errors:
```php
$object->init(['.silent' => true]);
```
---
If an annotated property has a non-primitive type, the property can be resolved only of that type:
```php
$object = new class {
/**
* @Option
* @var \Reflection
*/
public $option1;
};
// Throws since 'option1' expected a value of type '\Reflection'
$object->init(['option1' => 1]);
```
---
Primitive types are not processed so they should be declared in array schema:
```php
new class {
protected function getOptionsSchema()
{
return [
'allowedTypes' => ['option1' => \Reflection::class]
];
}
};
```
---
Array schema has a higher priority than an annotation schema
---
An option can be set as optional:
```php
$object = new class {
/**
* @Option(required=false)
* @var \Reflection
*/
public $option1;
};
```
---
Options can be preset by a specific key:
```php
$object = new class {
/**
* @Option()
* @var string
*/
public $option1;
};
$object::presetOptions('nameOfPreset', [
'option1' => 'value1'
]);
$object->init(['presetName' => 'nameOfPreset']);
$object->option1 === 'value1';
```