hgg/parameter-validator

Framework for specifying and enforcing rules on key/value pairs

Installs: 11 703

Dependents: 1

Stars: 2

Watchers: 1

Forks: 1

Open Issues: 1

Language: PHP

v0.1.2 2014-05-20 14:18 UTC

README

Framework for specifying and enforcing rules on key/value pairs

Build Status Latest Stable Version Total Downloads License

Using Composer:

{
    "require": {
        "hgg/parameter-validator": "dev-master"
    }
}

Use Cases

Url Query String Parameters

A framework like Symfony 2 provides the Request object from which one can obtain the query string parameters either one by one

$param = $request->query->get('name-of-parameter');

or all at once

$params = $request->query->all();

This is really convenient but the validation of these parameters is still left to the developer and becomes really tedious. You still have to ensure that all required parameters are present and that the values for them are of the correct type, etc.

This framework allows the definition of rules for the parameters and can even validate the values for these parameters.

Example - Url Query String Parameter Validation in Symfony 2

SomeApiMethod.php

<?php

namespace HGG\ParameterValidator\Test;

use HGG\ParameterValidator\Parameter\NumberParameter;
use HGG\ParameterValidator\ParameterDefinition;
use HGG\ParameterValidator\Input;

class SomeApiMethod
{
    protected $def;

    public function __construct()
    {
        $this->def = new ParameterDefinition();
        $this->def
            ->addParameter(
                new NumberParameter(
                    'id',
                    Parameter::REQUIRED,
                    'This is a required numeric parameter',
                    'Some more details could go here'
                )
            );
    }

    public function execute($parameters)
    {
        $input = new Input($parameters, $this->def);

        $validatedParameters = $input->getParameters();

        // Do some work here and create a result

        return $result;
    }
}

SomeController.php

<?php

class SomeController
{
    public function someAction()
    {
        $method = new SomeApiMethod();

        return $method->execute($this->getRequest()->query->all());
    }
}