https://github.com/sasha-bo/yaml-to-object
PHP package for reading yaml files to given class and validating them
https://github.com/sasha-bo/yaml-to-object
Last synced: 2 months ago
JSON representation
PHP package for reading yaml files to given class and validating them
- Host: GitHub
- URL: https://github.com/sasha-bo/yaml-to-object
- Owner: sasha-bo
- Created: 2024-01-08T20:09:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-10T08:56:09.000Z (over 1 year ago)
- Last Synced: 2025-01-26T14:48:52.080Z (4 months ago)
- Language: PHP
- Size: 12.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Yaml Reader
Validates YAML file using given class and, if matches, creates
an object. Understands PhpDoc, converts values if necessary.
Works recursively, so the YAML file may have complicated
structure, and the given class may have properties of other
classes.
## Installation
```composer require unicon/yarn```
## Usage
```php
$reader = new Yaml(MyClass::class);
$object = $reader->read('my_yaml.yml');
```
## Example
```php
class Simple
{
public int $integerParameter = 1;
/** @var positive-int */
public int $positiveIntegerParameter;
public ?bool $booleanOrNullParameter;
public string $stringParameter = 'default';
}
```
### Success example
```yaml
integer_parameter: '777'
positive_integer_parameter: 666
boolean_or_null_parameter: null
string_parameter: 888
```
### Failures
```YamlException``` is thrown if the YAML file doesn't match
the class:
``` Yaml parameter positive_integer_parameter must be greater or equal to 1, "-1" given```
```yaml
integer_parameter: '777'
positive_integer_parameter: '-1'
boolean_or_null_parameter: null
string_parameter: 888
```
```Can't convert integer_parameter 777.777 to int```
```yaml
integer_parameter: 777.777
positive_integer_parameter: 666
boolean_or_null_parameter: null
string_parameter: 888
```
```Can't convert integer_parameter "xxx" to int```
```yaml
integer_parameter: 'xxx'
positive_integer_parameter: 666
boolean_or_null_parameter: null
string_parameter: 888
```
```Yaml parameter positive_integer_parameter is missed```
(```integer_parameter``` and ```boolean_or_null_parameter``` are missed too,
but one has default values, another is nullable)
```yaml
string_parameter: 'aaa'
```
```Yaml parameter extra_parameter with value true is unexpected```
(this exception is never thrown for ```stdClass``` or
`````\AllowDynamicProperties````` classes)
```yaml
extra_parameter: true
integer_parameter: '777'
positive_integer_parameter: 666
boolean_or_null_parameter: null
string_parameter: 888
```
You can find more examples in the
[test directory](https://github.com/sasha-bo/yaml-to-object/tree/master/tests/examples)
including dates, complicated structures and trees
(classes with ```array``` properties).