Home

README

O que é o PhpMagic

PhpMagic é um simples mecanismo de validação de propriedades.

Como instalar?

Esse pacote foi desenvolvido de modo a ser instalado por meio da ferramenta de gerenciamento de dependências composer.

composer require solis/phpmagic

Como utilizar?

Primeiramente é necessário definir um schema, representando as propriedades e seus respectivos tipo/formatações formatos.

{
    "properties": [
        {
          "alias": "sNome",
          "property": "nome",
          "type": "string"
        },
        {
          "alias": "iCodigoIbge",
          "property": "codigoIbge",
          "type": "int"
        }
     ]
}

O schema é uma representação em Json de uma determinada class, e é criado pela class PhpSchema\Schema

Solis\PhpSchema\Classes\Schema;

$schema = Schema::make(
    file_get_contents("/path/to/schema.json")
);

É possível utilizar o mecanismo de validação para validar uma determinada propriedade contra um schema.

use Solis\PhpMagic\Classes\Validator;

try {

  $value = Validator::make($schema)->validate($property, $value);

} catch(\InvalidArgumentException $exception){
  $exception->getMessage();  
}

O mecanismo valida e retorna o valor como especificado no schema, lançando uma TException caso for inválido.