README

A typical PHP app is constantly dealing with a shitload of if-clauses to determine, wether or not an entity is compliant with the constraint the developers had in mind, when creating their software.

Dry offers a simple way to eleminate overhead validation clauses and centers constraints for any type of entity in one file. Just call validate on an instance of this class and it will validate the parameter you provide.

Wether Array or Object Dry::PHP doesn't care

You may validate an entity multiple times:

when passed to an endpoint
before storing in the database
after deserializing from a file or similiar

With Dry::PHP you just define one single file of constraints and call it on the data. Dry::PHP supports associative arrays in form of [property => value] and standard PHP Objects. The Object itself will be casted to an array during the validation process and then checked.

be careful: private properties or properties inherited from the parent class will also be included in the checking process!

Example

# ExampleSchema.php
<?php
use Dry\DryStruct;

class ExampleSchema extends DryStruct 
{
  public function __construct() {
    parent::__construct();
    self::required('name')->filled('string');
    self::optional('age')->filled('integer')->min(6);
    self::required_object('book')->do(function($book) {
      $book->required('title')->filled('string');
    });
    $this->required_array('buyers')->each(function($buyer) {
       $buyer->type('object')->do(function($buyer) {
         $buyer->required('name')->filled('string');
       });
     });
  }
}

# index.php
<?php
# validate expected schema
(new ExampleSchema())->validate(['name' => 'Richard', 'age' => 7, 'book' => (object) [
  'title' => 'Richard'
  ],
  "buyers" =>[
    (object)[
      "name" => "Richard"
    ],
    (object)[
      "name" => "Lorenz"
    ]
  ]
 ]);
# validate faulty schema => method call returns array with affected fields + violations
$result = (new ExampleSchema())->validate(['name' => 'Richard', 'age' => 4, 'book' => (object) [
'title' => 'Richard'
  ]
]);

print_r($result);
##
# output
# Array(
#   [buyers] => Array(
#     missing 
#   ) 
# )

supported constraints

filled: datatype of the property, depending on the expected datatype, further evaluation will be executed
min: Minimum value for a number property
max: Maximum value for a number property
minLength: Minimum length for a string property
maxLength: Maximum length for a string property
minSize: Minimum size for an array property
maxSize: Maximum size for an array property
required_object: Adds a object property to the target schema. This object needs to have it's own validation configured as well!

funcke / dry_php

Maintainers

Details

README

Wether Array or Object Dry::PHP doesn't care

Example

supported constraints