{"id":19214202,"url":"https://github.com/igniphp/validation","last_synced_at":"2025-05-12T22:20:23.332Z","repository":{"id":56989381,"uuid":"123489757","full_name":"igniphp/validation","owner":"igniphp","description":"Validation library for igni framework","archived":false,"fork":false,"pushed_at":"2019-02-17T09:55:00.000Z","size":61,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T19:36:49.964Z","etag":null,"topics":["framework","igni","library","php","validation"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/igniphp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-01T20:39:36.000Z","updated_at":"2024-12-25T03:30:24.000Z","dependencies_parsed_at":"2022-08-21T12:50:37.568Z","dependency_job_id":null,"html_url":"https://github.com/igniphp/validation","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniphp%2Fvalidation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniphp%2Fvalidation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniphp%2Fvalidation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniphp%2Fvalidation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/igniphp","download_url":"https://codeload.github.com/igniphp/validation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253831143,"owners_count":21971036,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","igni","library","php","validation"],"created_at":"2024-11-09T14:09:27.792Z","updated_at":"2025-05-12T22:20:23.304Z","avatar_url":"https://github.com/igniphp.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![Igni logo](https://github.com/igniphp/common/blob/master/logo/full.svg)![Build Status](https://travis-ci.org/igniphp/validation.svg?branch=master)\n\n## Igni Validation\nLicensed under MIT License.\n\n**Igni** validation is simple, lightweight and extensible validation library.\n\n## Installation\n\n```\ncomposer install igniphp/validation\n```\n\n## Introduction\n\n### Basic example\n\n```php\n\u003c?php\n\nuse Igni\\Validation\\Assertion;\n\n$numberValidator = Assertion::number($min = 0);\n\n$numberValidator-\u003evalidate(1);// true\n$numberValidator-\u003evalidate(-1);// false\n$numberValidator-\u003evalidate(1.0);// true\n$numberValidator-\u003evalidate('a'); // false\n```\n\n### Getting error information\n\nAllows to validate complex arrays \n\n```php\n\u003c?php\n\nuse Igni\\Validation\\Assertion;\nuse Igni\\Validation\\Error;\n\n$userValidator = Assertion::group([\n    'name' =\u003e Assertion::alnum(),\n    'age' =\u003e Assertion::number(1, 200),\n    'email' =\u003e Assertion::email(),\n    'address' =\u003e Assertion::text(),\n]);\n\n$userValidator-\u003evalidate([\n    'name' =\u003e 'John',\n    'age' =\u003e 233,\n    'email' =\u003e 'johnmail',\n]);// false\n\n\n$errors = $userValidator-\u003egetErrors();\n\n$errors[0] instanceof Error\\OutOfRangeError;// true\n$errors[0]-\u003egetContext()-\u003egetName();//age\n\n$errors[1] instanceof Error\\EmptyValueError;// true\n$errors[1]-\u003egetContext()-\u003egetName();//address\n\n// Exception can also be factored out of failure instance\nthrow $errors[0]-\u003etoException();\n```\n\n## API\n\n### Validation list\n - [alnum](#assertionalnumint-min--null-int-max--null)\n - [alpha](#assertionalphaint-min--null-int-max--null)\n - [boolean](#assertionboolean)\n - [chain](#assertionchainrule-rules)\n - [contains](#assertioncontainsstring-value)\n - [date](#assertiondatestring-format--null-min--null-max--null)\n - [email](#assertionemail)\n - [each](#assertioneachvalidator-validator)\n - [falsy](#assertionfalsy)\n - [group](#assertiongrouparray-validatorshash)\n - [in](#assertioninvalues)\n - [integer](#assertionintegerint-min--null-int-max--null)\n - [ip](#assertionip)\n - [ipv4](#assertionipv4)\n - [ipv6](#assertionipv6)\n - [number](#assertionnumberint-min--null-int-max--null)\n - [regex](#assertionregexstring-pattern)\n - [text](#assertiontextint-minlength--null-int-maxlength--null)\n - [truthy](#assertiontruthy)\n - [uri](#assertionuri)\n - [url](#assertionurl)\n - [uuid](#assertionuuid)\n\n### `Assertion::alnum(int $min = null, int $max = null)`\n\nCreates validator that checks if passed value contains only digits and letters. \n\n#### Parameters\n- `$min` defines minimum length \n- `$max` defines maximum length\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n\n$validator = Assertion::alnum($minLength = 2);\nvar_dump($validator-\u003evalidate('a1')); // true\n```\n\n### `Assertion::alpha(int $min = null, int $max = null)`\n\nCreates validator that checks if passed value contains only letters.\n\n#### Parameters\n- `$min` defines minimum length \n- `$max` defines maximum length\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n\n$validator = Assertion::alpha($minLength = 2);\nvar_dump($validator-\u003evalidate('aaa')); // true\n```\n\n### `Assertion::boolean()`\n\nCreates validator that checks if passed value is valid boolean expression.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n\n$validator = Assertion::boolean();\nvar_dump($validator-\u003evalidate(false)); // true\n```\n\n### `Assertion::chain(Rule ...$rules)`\n\nCreates validator that uses other validators to perform multiple validations on passed value.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n\n$validator = Assertion::chain(Assertion::text(), Assertion::date());\nvar_dump($validator-\u003evalidate('2018-09-10')); // true\n```\n\n### `Assertion::contains(string $value)`\n\nCreates validator that checks if passed string is contained in the validated string.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n\n$validator = Assertion::contains('example');\nvar_dump($validator-\u003evalidate('Test example')); // true\n```\n\n### `Assertion::date(string $format = null, $min = null, $max = null)`\n\nCreates validator that checks if passed value is valid date. \n\n#### Parameters\n - `$format` restricts format of passed value\n - `$min` defines minimum date range \n - `$max` defines maximum date range\n \n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::date('Y-m-d');\nvar_dump($validator-\u003evalidate('2018-09-10')); // true\n```\n     \n### `Assertion::email()`\n\nCreates validator that checks if passed value is valid email address.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::email();\nvar_dump($validator-\u003evalidate('test@test.com')); // true\n```\n\n### `Assertion::each(Validator $validator)`\n\nCreates validator that checks if each item in passed set can be successfully validated against `$validator`.\n\n#### Parameters\n - `$validator` validator used for each item of the passed set.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::each(Assertion::date('Y-m-d'));\nvar_dump($validator-\u003evalidate(['2019-01-01', '2018-10-11'])); // true\n```\n\n### `Assertion::falsy()`\n\nCreates validator that checks if passed value is valid falsy expression;\n- `off`\n- `no`\n- `false`\n- 0\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::falsy();\nvar_dump($validator-\u003evalidate('no')); // true\n```\n\n### `Assertion::group(array $validatorsHash)`\n\nCreates validator with key/value hash that validates other hashes.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::group([\n    'email' =\u003e Assertion::email(),\n    'password' =\u003e Assertion::text(),\n    'date_of_birth' =\u003e Assertion::date('Y-m-d'),\n]);\nvar_dump($validator-\u003evalidate([\n    'email' =\u003e 'test@domain.com',\n    'password' =\u003e 'secret',\n    'date_of_birth' =\u003e '2019-01-01',\n])); // true\n```\n\n### `Assertion::regex(string $pattern)`\n\nCreates validator that checks if passed string matches the pattern.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n\n$validator = Assertion::regex('^-[a-z]+$');\nvar_dump($validator-\u003evalidate('-aa')); // true\n```\n\n### `Assertion::truthy()`\n\nCreates validator that checks if passed value is valid truthy expression;\n- `on`\n- `true`\n- 1\n- `yes`\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::truthy();\nvar_dump($validator-\u003evalidate('yes')); // true\n```\n\n### `Assertion::text(int $minLength = null, int $maxLength = null)`\n\nCreates validator that checks if passed value is string.\n\n#### Parameters\n- `$minLength` defines minimum length \n- `$maxLength` defines maximum length\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n\n$validator = Assertion::text($minLength = 2);\nvar_dump($validator-\u003evalidate('aaa')); // true\n```\n\n### `Assertion::in(...$values)`\n\nCreates validator that checks if passed value exists in defined list of values.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::in('no', 'yes', 'test');\nvar_dump($validator-\u003evalidate('no')); // true\n```\n\n### `Assertion::integer(int $min = null, int $max = null)`\n\nCreates validator that checks if passed value is valid integer expression.\n\n#### Parameters\n - `$min` defines minimum value\n - `$max` defines maximum value\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::integer(10, 100);\nvar_dump($validator-\u003evalidate(11)); // true\n ```\n\n### `Assertion::ip()`\n\nCreates validator that checks if passed value is valid ip address.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::ip();\nvar_dump($validator-\u003evalidate('123.123.123.123')); // true\n```\n\n### `Assertion::ipv4()`\n\nCreates validator that checks if passed value is valid ip v4 address.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::ipv4();\nvar_dump($validator-\u003evalidate('123.123.123.123')); // true\n```\n\n### `Assertion::ipv6()`\n\nCreates validator that checks if passed value is valid ip v6 address.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::ipv6();\nvar_dump($validator-\u003evalidate('2001:0db8:85a3:0000:0000:8a2e:0370:7334')); // true\n```\n \n\n### `Assertion::number(int $min = null, int $max = null)`\n\nCreates validator that checks if passed value is valid number expression.\n\n#### Parameters\n - `$min` defines minimum value\n - `$max` defines maximum value\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::number(10, 100);\nvar_dump($validator-\u003evalidate('11.2')); // true\n```\n \n### `Assertion::uuid()`\n\nCreates validator that checks if passed value is valid uuid.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::uuid();\nvar_dump($validator-\u003evalidate('1ff60619-81cc-4d8e-88ac-a3ae36a97dce')); // true\n```\n\n### `Assertion::uri()`\n\nCreates validator that checks if passed value is valid uri string.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::uri();\nvar_dump($validator-\u003evalidate('/some/uri')); // true\n```\n\n### `Assertion::url()`\n\nCreates validator that checks if passed value is valid url string.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::uri();\nvar_dump($validator-\u003evalidate('http://domain.com/some/uri')); // true\n```\n\n### `Assertion::text()`\n\nCreates validator that accepts every non empty string.\n\n### `Assertion::group(array $validators)`\n\nCreates validator that validates passed value by group of defined validators.\n\n#### Example\n```php\n\u003c?php\nuse Igni\\Validation\\Assertion;\n \n$validator = Assertion::group([\n    'name' =\u003e Assertion::text(),\n    'age' =\u003e Assertion::integer(1, 200),\n    'email' =\u003e Assertion::email(),\n]);\nvar_dump($validator-\u003evalidate(['name' =\u003e 'John Doe', 'age' =\u003e 29, 'email' =\u003e 'john@gmail.com'])); // true\n```\n\n## Creating custom validator\n\nTo create custom validator we have to simply extend `\\Igni\\Validation\\Assertion` class, please consider following example:\n\n```php\n\u003c?php declare(strict_types=1);\n\nuse Igni\\Validation\\Assertion;\n\nclass ValidateIn extends Assertion\n{\n    public function __construct(...$values)\n    {\n        $this-\u003eattributes['valid_values'] = $values;\n    }\n\n    protected function assert($input): bool\n    {\n        return in_array($input, $this-\u003eattributes['valid_values'], $strict = true);\n    }\n}\n\n```\n\nThat's all folks!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniphp%2Fvalidation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figniphp%2Fvalidation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniphp%2Fvalidation/lists"}