2017 © Pedro Peláez
 

library shape

Run-time type checks against plain old PHP arrays

image

leocavalcante/shape

Run-time type checks against plain old PHP arrays

  • Tuesday, May 9, 2017
  • by leocavalcante
  • Repository
  • 2 Watchers
  • 10 Stars
  • 3,383 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 1 Versions
  • 8 % Grown

The README.md

shape CircleCI

Run-time type checks against plain old PHP arrays., (*1)

composer require leocavalcante/shape dev-master

Why

Validate basic data structures

use function Shape\shape;
use const Shape\int;

$pointShape = shape([
    'x' => int,
    'y' => int,
]);

$validPoint = ['x' => 1, 'y' => 2];

$pointShape($validPoint); // Shape

$invalidPoint = ['x' => 1, 'y' => 'two'];

$pointShape($invalidPoint); // TypeError: Key y passed to shape() must be of the type integer, string given

Mimic tuples

use const Shape\string;
use const Shape\int;
use function Shape\shape;

function string_int_tuple(array $tuple)
{
    // assert it is a (String, Int) tuple
    shape([string, int])($tuple);

    return true;
}

var_dump(string_int_tuple(['one', 1])); // bool(true)

var_dump(string_int_tuple(['one', 'two'])); // TypeError: Key 1 passed to shape() must be of the type integer, string given

shape() function returns a Closure, so you can easily use it to assert vector arrays

use const Shape\int;
use function Shape\shape;

$points = [
    ['x' => 1, 'y' => 2],
    ['x' => 3, 'y' => 4],
];

array_map(shape(['x' => int, 'y' => int]), $points);

Inspiration

The Versions

09/05 2017

dev-master

9999999-dev

Run-time type checks against plain old PHP arrays

  Sources   Download

MIT

The Requires

  • php >=7.0

 

The Development Requires

by Avatar leocavalcante