new-inventor/data-structure

Data structure transformers and validators config

Property bag

This utility provide to you data structure metadata and some useful classes., _(*1)

With this packet you can transform arrays to needed format and load it to objects recursive., _(*2)

Objects to load MUST implement Loadable or DataStructureInterface interface., _(*3)

Installation

composer require new-inventor/data-structure, _(*4)

Examples

Metadata config

namespace: DataStructure\Namespace
validation:
  constraints:
    - Callback: ['Some\Existing\Class', 'GetTrue']
  getters:
    prop1:
      - GreaterThan: 0
  properties:
    prop0:
      - GreaterThan: 0
properties:
  prop1: NewInventor\DataStructure\Transformer\ToInt
  prop2:
    transformers:
      - ToInt: ~
    validation:
      - GreaterThan: 5
      - LessThanOrEqual: 1000
  prop3:
    transformers:
      - ToBool:
          - ['Some\Existing\Class', 'GetTrue']
  prop4:
    transformers:
      - ToBool:
          - groups: forward
      - BoolToMixed:
          - static: ['Some\Existing\Class', 'bbb']
          - const: ['Some\Existing\Class', 'AAA']
          - groups: backward
  prop5: ~
  prop6:
    transformers:
      - ChainTransformer:
          - ToString: ~
          - CsvStringToArray: ~
          - NewInventor\DataStructure\Transformer\InnerTransformer:
              - ToInt: ~
          - groups: forward
      - ArrayToCsvString:
          - groups: backward
  prop7:
    default: 2222
    transformers:
      - ToString: ~
      - StringToDateTime:
          - 'd.m.Y'
          - groups: forward
  prop8:
    transformers:
      - ToArray:
          - groups: forward
  prop9:
    nested:
      class: DataStructure\Namespace\Structure

Recursive loading

You can load properties recursive by using RecursiveConstructor., _(*5)

To use this you shoul add nested parameter to property like this, _(*6)

prop:
  nested:
    class: DataStructure\Namespace\Structure

or, _(*7)

prop:
  nested:
    metadata:
      path: some/config
      baseNamespace: Some\Namespace
    class: DataStructure\Namespace\Structure

or, _(*8)

prop:
  nested:
    metadata:
      path: some/config/path.yml
    class: DataStructure\Namespace\Structure

Namespace

It is the namespace for data structure class for recursive loading., _(*9)

Validation

It is the symfony class validation config. You can pass it directly into property, _(*10)

Properties

It is properties of your data structure., _(*11)

Property has this parameters: * default * transformers * validation * nested, _(*12)

If property === null(~) then default = null and no transformers and validators If property is string then default = null and default transformers = this string, _(*13)

transformers

Transformers is array of arrays., _(*14)

In yml like this:, _(*15)

key:
  - name: value 

So you can set transformer like this:, _(*16)

transformers:
  - ToInt: ~

By default transformer is inner transformer, but you can create you own and pass full class name to transformer config, _(*17)

Transformer can receive array or parameters and parameter can be array(1) with reserved word as key; Reserved words: * static - interpret as static property of class ['class', 'propertyName'] * const - interpret as constant can be array like static or string * groups - transformer groups, by default groups = ['default']., _(*18)

If in transformers section more than 1 transformer in same group then this transformers will be wrapped by ChainTransformer, so this identical:, _(*19)

transformers:
  - ToInt:
      - groups: group1
  - ToRange:
      - 1
      - 10
      - groups: group1

and, _(*20)

transformers:
  - ChainTransformer:
      - groups: group1
      - ToInt:
      - ToRange:
          - 1
          - 10

Validation

It is the getters part of symfony validation config for given property, _(*21)

Default

Default can be any value and have same reserved keys as transformer parameters, but group., _(*22)

Nested

It is described in Recursive loading section., _(*23)

PropertiesTransformer

$metadata = (new Metadata\Loader($path))->loadMetadata();
$transformer = $metadata->getTransformer($groupName);
$resArray = $transformer->transform($someArray);

or you can compose PropertiesTransformer by yourself, _(*24)

RecursiveConstructor

This constructor construct class with metadata by recursive loading it nested classes., _(*25)

Links

• To use only transformers use https://github.com/new-inventor/transformers
• To implement property bags use https://github.com/new-inventor/property-bag