Formal

A simple and versatile (Form) Data validation framework based on Rules for PHP, JavaScript, Python

version 1.3.1

Contents

1. Example
2. API Reference

Example

<formmethod="post">
Foo: <inputname="foo" type="text" value="" />
Moo:
<inputname="moo[0][choo]" type="text" value="1" /><inputname="moo[1][choo]" type="text" value="2" /><inputname="moo[2][choo]" type="text" value="3" />
Koo:
<inputname="koo[]" type="text" value="" /><inputname="koo[]" type="text" value="" /><inputname="koo[]" type="text" value="" />
Nums:
<inputname="num[]" type="text" value="0.1" /><inputname="num[]" type="text" value="1.2" />
Dates:
<inputname="date[]" type="text" value="2012-11-02" /><inputname="date[]" type="text" value="20-11-02" /><buttontype="submit">Submit</button></form>

$formal = (newFormal())
->option('WILDCARD', '*') // default
->option('SEPARATOR', '.') // default
->option('break_on_first_error', false) // default
->option('defaults', [
'foo' => 'bar',
'moo.*.foo' => 'bar',
'koo.*' => 'bar'
])
->option('typecasters', [
'num.*' => Formal::typecast('composite', [Formal::typecast('float'), Formal::typecast('clamp', [0.0, 1.0])])
])
->option('validators', [
'date.*' => Formal::validate('match', Formal::datetime('Y-m-d'), '"{key}" should match {args} !'),
'date.0' => Formal::validate('eq', Formal::field('date.1'))
])
;
$data = $formal->process($_POST);
$err = $formal->getErrors();
print_r($data);
echoimplode("\n", $err) . PHP_EOL;
echo$err[0]->getMsg() . PHP_EOL;
echoimplode('.', $err[0]->getKey()) . PHP_EOL;
/* outputArray( [foo] => bar [moo] => Array ( [0] => Array ( [choo] => 1 [foo] => bar ) [1] => Array ( [choo] => 2 [foo] => bar ) [2] => Array ( [choo] => 3 [foo] => bar ) ) [koo] => Array ( [0] => bar [1] => bar [2] => bar ) [num] => Array ( [0] => 0.1 [1] => 1 ) [date] => Array ( [0] => 2012-11-02 [1] => 20-11-02 ))"date.1" should match Y-m-d !"date.0" must be equal to "date.1"!"date.1" should match Y-m-d !date.1*/

API Reference

Typecasters

// composite typecaster
Formal::typecast('composite', [$typecaster1, $typecaster2/*, ..*/]);
// boolean typecaster
Formal::typecast('bool');
// int typecaster
Formal::typecast('int');
// float typecaster
Formal::typecast('float');
// string typecaster
Formal::typecast('str');
// min value typecaster
Formal::typecast('min', $minValueOrField);
// max value typecaster
Formal::typecast('max', $maxValueOrField);
// clamp typecaster
Formal::typecast('clamp', [$minValueOrField, $maxValueOrField]);
// trim typecaster
Formal::typecast('trim');
// lowercase typecaster
Formal::typecast('lower');
// uppercase typecaster
Formal::typecast('upper');
// custom typecaster
Formal::typecast(function($val, $args, $key, $formalInstance) {
// typecast and return new $valreturn$val;
}, $args = null);

Validators

// optional validator, only if value is not missing
Formal::validate('optional', $requiredValidator);
// required validator, fails if value is missing or null
Formal::validate('required');
// is numeric validator
Formal::validate('numeric');
// is object validator
Formal::validate('object');
// is array validator
Formal::validate('array';
// is file validator
Formal::validate('file');
// is empty validator
Formal::validate('empty');
// max items validator
Formal::validate('maxitems', $maxCountOrField);
// min items validator
Formal::validate('minitems', $minCountOrField);
// max chars validator
Formal::validate('maxchars', $maxLenOrField);
// min chars validator
Formal::validate('minchars', $minLenOrField);
// max file size validator
Formal::validate('maxsize', $maxSizeOrField);
// min file size validator
Formal::validate('minsize', $minSizeOrField);
// equals validator
Formal::validate('eq', $otherValueOrField);
// not equals validator
Formal::validate('neq', $otherValueOrField);
// greater than validator
Formal::validate('gt', $otherValueOrField);
// greater than or equal validator
Formal::validate('gte', $otherValueOrField);
// less than validator
Formal::validate('lt', $otherValueOrField);
// less than or equal validator
Formal::validate('lte', $otherValueOrField);
// between values (included) validator
Formal::validate('between', [$minValueOrField, $maxValueOrField]);
// in array of values validator
Formal::validate('in', [$val1, $val2/*, ..*/]/*or field*/);
// not in array of values validator
Formal::validate('not_in', [$val1, $val2/*, ..*/]/*or field*/);
// match pattern validator
Formal::validate('match', $patternOrField);
// match valid email pattern validator
Formal::validate('email');
// match valid url pattern validator
Formal::validate('url');
// not validator$validator->_not_($errMsg = null);
// $validator1 and $validator2$validator1->_and_($validator2);
// $validator1 or $validator2$validator1->_or_($validator2);
// custom validator
Formal::validate(function($val, $args, $key, $formalInstance, $missingValue, $errMsg) {
// validate and return true or false// optionally you can throw FormalException with custom error messagethrownewFormalException('my custom error message');
returnfalse;
}, $args = null, $errMsg = null);

see also:

• ModelView a simple, fast, powerful and flexible MVVM framework for JavaScript
• tico a tiny, super-simple MVC framework for PHP
• LoginManager a simple, barebones agnostic login manager for PHP, JavaScript, Python
• SimpleCaptcha a simple, image-based, mathematical captcha with increasing levels of difficulty for PHP, JavaScript, Python
• Dromeo a flexible, and powerful agnostic router for PHP, JavaScript, Python
• PublishSubscribe a simple and flexible publish-subscribe pattern implementation for PHP, JavaScript, Python
• Localizer a simple and versatile localization class (l10n) for PHP, JavaScript, Python
• Importer simple class & dependency manager and loader for PHP, JavaScript, Python
• EazyHttp, easy, simple and fast HTTP requests for PHP, JavaScript, Python
• Contemplate a fast and versatile isomorphic template engine for PHP, JavaScript, Python
• HtmlWidget html widgets, made as simple as possible, both client and server, both desktop and mobile, can be used as (template) plugins and/or standalone for PHP, JavaScript, Python (can be used as plugins for Contemplate)
• Paginator simple and flexible pagination controls generator for PHP, JavaScript, Python
• Formal a simple and versatile (Form) Data validation framework based on Rules for PHP, JavaScript, Python
• Dialect a cross-vendor & cross-platform SQL Query Builder, based on GrammarTemplate, for PHP, JavaScript, Python
• DialectORM an Object-Relational-Mapper (ORM) and Object-Document-Mapper (ODM), based on Dialect, for PHP, JavaScript, Python
• Unicache a simple and flexible agnostic caching framework, supporting various platforms, for PHP, JavaScript, Python
• Xpresion a simple and flexible eXpression parser engine (with custom functions and variables support), based on GrammarTemplate, for PHP, JavaScript, Python
• Regex Analyzer/Composer Regular Expression Analyzer and Composer for PHP, JavaScript, Python