{"id":18319421,"url":"https://github.com/kariricode-framework/kariricode-validator","last_synced_at":"2026-02-15T22:06:25.994Z","repository":{"id":259293451,"uuid":"872102222","full_name":"KaririCode-Framework/kariricode-validator","owner":"KaririCode-Framework","description":"A powerful content validation component for the KaririCode framework. Features attribute-based validation for entities, custom validators, and a pipeline for complex validation tasks. Ideal for data integrity, input validation, and ensuring data consistency across your application","archived":false,"fork":false,"pushed_at":"2024-10-26T14:13:26.000Z","size":120,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-10T16:34:21.298Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KaririCode-Framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-13T19:29:57.000Z","updated_at":"2024-10-25T22:13:25.000Z","dependencies_parsed_at":"2025-04-12T21:44:21.128Z","dependency_job_id":"3cf25f85-2a12-4397-9bd0-bc29e35e82cc","html_url":"https://github.com/KaririCode-Framework/kariricode-validator","commit_stats":null,"previous_names":["kariricode-framework/kariricode-validator"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/KaririCode-Framework/kariricode-validator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaririCode-Framework%2Fkariricode-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaririCode-Framework%2Fkariricode-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaririCode-Framework%2Fkariricode-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaririCode-Framework%2Fkariricode-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KaririCode-Framework","download_url":"https://codeload.github.com/KaririCode-Framework/kariricode-validator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaririCode-Framework%2Fkariricode-validator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29490360,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T19:29:10.908Z","status":"ssl_error","status_checked_at":"2026-02-15T19:29:10.419Z","response_time":118,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-05T18:13:18.688Z","updated_at":"2026-02-15T22:06:25.971Z","avatar_url":"https://github.com/KaririCode-Framework.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KaririCode Framework: Validator Component\n\nA powerful and flexible data validation component for PHP, part of the KaririCode Framework. It uses attribute-based validation with configurable processors to ensure data integrity and validation in your applications.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Basic Usage](#basic-usage)\n  - [Advanced Usage: User Registration](#advanced-usage-user-registration)\n- [Available Validators](#available-validators)\n  - [Input Validators](#input-validators)\n  - [Numeric Validators](#numeric-validators)\n  - [Logic Validators](#logic-validators)\n  - [Date Validators](#date-validators)\n- [Configuration](#configuration)\n- [Integration with Other KaririCode Components](#integration-with-other-kariricode-components)\n- [Development and Testing](#development-and-testing)\n- [Contributing](#contributing)\n- [License](#license)\n- [Support and Community](#support-and-community)\n\n## Features\n\n- Attribute-based validation for object properties\n- Comprehensive set of built-in validators for common use cases\n- Easy integration with other KaririCode components\n- Configurable processors for customized validation logic\n- Support for custom error messages\n- Extensible architecture allowing custom validators\n- Robust error handling and reporting\n- Chainable validation pipelines for complex data validation\n- Built-in support for multiple validation scenarios\n- Type-safe validation with PHP 8.3 features\n\n## Installation\n\nYou can install the Validator component via Composer:\n\n```bash\ncomposer require kariricode/validator\n```\n\n### Requirements\n\n- PHP 8.3 or higher\n- Composer\n- Extensions: `ext-mbstring`, `ext-filter`\n\n## Usage\n\n### Basic Usage\n\n1. Define your data class with validation attributes:\n\n```php\nuse KaririCode\\Validator\\Attribute\\Validate;\n\nclass UserProfile\n{\n    #[Validate(\n        processors: [\n            'required',\n            'length' =\u003e ['minLength' =\u003e 3, 'maxLength' =\u003e 20],\n        ],\n        messages: [\n            'required' =\u003e 'Username is required',\n            'length' =\u003e 'Username must be between 3 and 20 characters',\n        ]\n    )]\n    private string $username = '';\n\n    #[Validate(\n        processors: ['required', 'email'],\n        messages: [\n            'required' =\u003e 'Email is required',\n            'email' =\u003e 'Invalid email format',\n        ]\n    )]\n    private string $email = '';\n\n    // Getters and setters...\n}\n```\n\n2. Set up the validator and use it:\n\n```php\nuse KaririCode\\ProcessorPipeline\\ProcessorRegistry;\nuse KaririCode\\Validator\\Validator;\nuse KaririCode\\Validator\\Processor\\Logic\\RequiredValidator;\nuse KaririCode\\Validator\\Processor\\Input\\LengthValidator;\nuse KaririCode\\Validator\\Processor\\Input\\EmailValidator;\n\n$registry = new ProcessorRegistry();\n$registry-\u003eregister('validator', 'required', new RequiredValidator());\n$registry-\u003eregister('validator', 'length', new LengthValidator());\n$registry-\u003eregister('validator', 'email', new EmailValidator());\n\n$validator = new Validator($registry);\n\n$userProfile = new UserProfile();\n$userProfile-\u003esetUsername('wa');  // Too short\n$userProfile-\u003esetEmail('invalid-email');  // Invalid format\n\n$result = $validator-\u003evalidate($userProfile);\n\nif ($result-\u003ehasErrors()) {\n    foreach ($result-\u003egetErrors() as $property =\u003e $errors) {\n        foreach ($errors as $error) {\n            echo \"$property: {$error['message']}\\n\";\n        }\n    }\n}\n```\n\n### Advanced Usage: User Registration\n\nHere's an example of how to use the KaririCode Validator in a real-world scenario, such as validating user registration data:\n\n```php\nuse KaririCode\\Validator\\Attribute\\Validate;\n\nclass UserRegistration\n{\n    #[Validate(\n        processors: [\n            'required',\n            'length' =\u003e ['minLength' =\u003e 3, 'maxLength' =\u003e 20],\n        ],\n        messages: [\n            'required' =\u003e 'Username is required',\n            'length' =\u003e 'Username must be between 3 and 20 characters',\n        ]\n    )]\n    private string $username = '';\n\n    #[Validate(\n        processors: ['required', 'email'],\n        messages: [\n            'required' =\u003e 'Email is required',\n            'email' =\u003e 'Invalid email format',\n        ]\n    )]\n    private string $email = '';\n\n    #[Validate(\n        processors: [\n            'required',\n            'length' =\u003e ['minLength' =\u003e 8],\n        ],\n        messages: [\n            'required' =\u003e 'Password is required',\n            'length' =\u003e 'Password must be at least 8 characters long',\n        ]\n    )]\n    private string $password = '';\n\n    #[Validate(\n        processors: [\n            'required',\n            'integer',\n            'range' =\u003e ['min' =\u003e 18, 'max' =\u003e 120],\n        ],\n        messages: [\n            'required' =\u003e 'Age is required',\n            'integer' =\u003e 'Age must be a whole number',\n            'range' =\u003e 'Age must be between 18 and 120',\n        ]\n    )]\n    private int $age = 0;\n\n    // Getters and setters...\n}\n\n// Usage example\n$registration = new UserRegistration();\n$registration-\u003esetUsername('wm');  // Too short\n$registration-\u003esetEmail('invalid');  // Invalid format\n$registration-\u003esetPassword('weak');  // Too short\n$registration-\u003esetAge(15);  // Too young\n\n$result = $validator-\u003evalidate($registration);\n\n// Process validation results\nif ($result-\u003ehasErrors()) {\n    $errors = $result-\u003egetErrors();\n    // Handle validation errors\n} else {\n    $validatedData = $result-\u003egetValidatedData();\n    // Process valid registration\n}\n```\n\n## Available Validators\n\n### Input Validators\n\n- **EmailValidator**: Validates email addresses using PHP's filter_var function.\n\n  - Error Keys:\n    - `invalidType`: Input is not a string\n    - `invalidFormat`: Invalid email format\n\n- **LengthValidator**: Validates string length within specified bounds.\n\n  - **Configuration Options**:\n    - `minLength`: Minimum allowed length\n    - `maxLength`: Maximum allowed length\n  - Error Keys:\n    - `invalidType`: Input is not a string\n    - `tooShort`: String is shorter than minLength\n    - `tooLong`: String is longer than maxLength\n\n- **UrlValidator**: Validates URLs using PHP's filter_var function.\n  - Error Keys:\n    - `invalidType`: Input is not a string\n    - `invalidFormat`: Invalid URL format\n\n### Numeric Validators\n\n- **IntegerValidator**: Ensures the input is a valid integer.\n\n  - Error Keys:\n    - `notAnInteger`: Input is not a valid integer\n\n- **RangeValidator**: Validates numeric values within a specified range.\n  - **Configuration Options**:\n    - `min`: Minimum allowed value\n    - `max`: Maximum allowed value\n  - Error Keys:\n    - `notNumeric`: Input is not a number\n    - `outOfRange`: Value is outside specified range\n\n### Logic Validators\n\n- **RequiredValidator**: Ensures a value is not empty.\n  - Error Keys:\n    - `missingValue`: Required value is missing or empty\n\n### Date Validators\n\n- **DateFormatValidator**: Validates dates against a specified format.\n\n  - **Configuration Options**:\n    - `format`: Date format string (default: 'Y-m-d')\n  - Error Keys:\n    - `invalidType`: Input is not a string\n    - `invalidFormat`: Date doesn't match specified format\n\n- **DateRangeValidator**: Validates dates within a specified range.\n  - **Configuration Options**:\n    - `minDate`: Minimum allowed date\n    - `maxDate`: Maximum allowed date\n    - `format`: Date format string (default: 'Y-m-d')\n  - Error Keys:\n    - `invalidType`: Input is not a string\n    - `invalidDate`: Invalid date format\n    - `outOfRange`: Date is outside specified range\n\n## Configuration\n\nThe Validator component can be configured globally or per-validator basis. Here's an example of how to configure the `LengthValidator`:\n\n```php\nuse KaririCode\\Validator\\Processor\\Input\\LengthValidator;\n\n$lengthValidator = new LengthValidator();\n$lengthValidator-\u003econfigure([\n    'minLength' =\u003e 3,\n    'maxLength' =\u003e 20,\n]);\n\n$registry-\u003eregister('validator', 'length', $lengthValidator);\n```\n\n## Integration with Other KaririCode Components\n\nThe Validator component is designed to work seamlessly with other KaririCode components:\n\n- **KaririCode\\Contract**: Provides interfaces and contracts for consistent component integration.\n- **KaririCode\\ProcessorPipeline**: Utilized for building and executing validation pipelines.\n- **KaririCode\\PropertyInspector**: Used for analyzing and processing object properties with validation attributes.\n\n## Registry Explanation\n\nThe registry is a central component for managing validators. Here's how to set up a complete registry:\n\n```php\n// Create and configure the registry\n$registry = new ProcessorRegistry();\n\n// Register all required validators\n$registry-\u003eregister('validator', 'required', new RequiredValidator());\n$registry-\u003eregister('validator', 'email', new EmailValidator());\n$registry-\u003eregister('validator', 'length', new LengthValidator());\n$registry-\u003eregister('validator', 'integer', new IntegerValidator());\n$registry-\u003eregister('validator', 'range', new RangeValidator());\n$registry-\u003eregister('validator', 'url', new UrlValidator());\n$registry-\u003eregister('validator', 'dateFormat', new DateFormatValidator());\n$registry-\u003eregister('validator', 'dateRange', new DateRangeValidator());\n```\n\n## Development and Testing\n\nFor development and testing purposes, this package uses Docker and Docker Compose to ensure consistency across different environments. A Makefile is provided for convenience.\n\n### Prerequisites\n\n- Docker\n- Docker Compose\n- Make (optional, but recommended for easier command execution)\n\n### Development Setup\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/KaririCode-Framework/kariricode-validator.git\n   cd kariricode-validator\n   ```\n\n2. Set up the environment:\n\n   ```bash\n   make setup-env\n   ```\n\n3. Start the Docker containers:\n\n   ```bash\n   make up\n   ```\n\n4. Install dependencies:\n\n   ```bash\n   make composer-install\n   ```\n\n### Available Make Commands\n\n- `make up`: Start all services in the background\n- `make down`: Stop and remove all containers\n- `make build`: Build Docker images\n- `make shell`: Access the PHP container shell\n- `make test`: Run tests\n- `make coverage`: Run test coverage with visual formatting\n- `make cs-fix`: Run PHP CS Fixer to fix code style\n- `make quality`: Run all quality commands (cs-check, test, security-check)\n\n## Contributing\n\nWe welcome contributions to the KaririCode Validator component! Here's how you can contribute:\n\n1. Fork the repository\n2. Create a new branch for your feature or bug fix\n3. Write tests for your changes\n4. Implement your changes\n5. Run the test suite and ensure all tests pass\n6. Submit a pull request with a clear description of your changes\n\nPlease read our [Contributing Guide](CONTRIBUTING.md) for more details on our code of conduct and development process.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Support and Community\n\n- **Documentation**: [https://kariricode.org/docs/validator](https://kariricode.org/docs/validator)\n- **Issue Tracker**: [GitHub Issues](https://github.com/KaririCode-Framework/kariricode-validator/issues)\n- **Community Forum**: [KaririCode Club Community](https://kariricode.club)\n- **Stack Overflow**: Tag your questions with `kariricode-validator`\n\n---\n\nBuilt with ❤️ by the KaririCode team. Empowering developers to create more secure and robust PHP applications.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkariricode-framework%2Fkariricode-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkariricode-framework%2Fkariricode-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkariricode-framework%2Fkariricode-validator/lists"}