{"id":15490140,"url":"https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk","last_synced_at":"2025-04-22T19:08:06.552Z","repository":{"id":57087680,"uuid":"133222094","full_name":"yoanm/php-jsonrpc-params-symfony-validator-sdk","owner":"yoanm","description":"Simple JSON-RPC params validator that use Symfony validator component","archived":false,"fork":false,"pushed_at":"2024-06-30T14:17:35.000Z","size":60,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-22T19:07:59.514Z","etag":null,"topics":["json-rpc","jsonrpc-server-sdk","params-validator","php","sdk","symfony-validator"],"latest_commit_sha":null,"homepage":"","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/yoanm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-13T09:19:26.000Z","updated_at":"2023-04-02T10:52:44.000Z","dependencies_parsed_at":"2025-03-04T04:30:56.328Z","dependency_job_id":"2d80ab20-4ce9-4140-9d19-57e566b2f7b6","html_url":"https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk","commit_stats":{"total_commits":32,"total_committers":3,"mean_commits":"10.666666666666666","dds":0.0625,"last_synced_commit":"f417a0c62195bfceee6556c3d88fe7a27bf045bb"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-params-symfony-validator-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-params-symfony-validator-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-params-symfony-validator-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoanm%2Fphp-jsonrpc-params-symfony-validator-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoanm","download_url":"https://codeload.github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250306638,"owners_count":21408926,"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":["json-rpc","jsonrpc-server-sdk","params-validator","php","sdk","symfony-validator"],"created_at":"2024-10-02T07:09:30.042Z","updated_at":"2025-04-22T19:08:06.530Z","avatar_url":"https://github.com/yoanm.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSON-RPC params symfony validator\n[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-params-symfony-validator-sdk.svg)](https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk)\n[![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-params-symfony-validator-sdk.svg)](https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk)\n[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\\\u0026repo=yoanm/php-jsonrpc-params-symfony-validator-sdk)](https://dependabot.com)\n\n[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-params-symfony-validator-sdk.svg?label=Scrutinizer\\\u0026logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-validator-sdk/build-status/master)\n[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-params-symfony-validator-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-validator-sdk/?branch=master)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8f39424add044b43a70bdb238e2f48db)](https://www.codacy.com/gh/yoanm/php-jsonrpc-params-symfony-validator-sdk/dashboard?utm_source=github.com\\\u0026utm_medium=referral\\\u0026utm_content=yoanm/php-jsonrpc-params-symfony-validator-sdk\\\u0026utm_campaign=Badge_Grade)\n\n[![CI](https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk/actions/workflows/CI.yml)\n[![codecov](https://codecov.io/gh/yoanm/php-jsonrpc-params-symfony-validator-sdk/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/php-jsonrpc-params-symfony-validator-sdk)\n[![Symfony Versions](https://img.shields.io/badge/Symfony-v4.4%20%2F%20v5.4%2F%20v6.x-8892BF.svg?logo=github)](https://symfony.com/)\n\n[![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/jsonrpc-params-symfony-validator-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-params-symfony-validator-sdk)\n[![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/jsonrpc-params-symfony-validator-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-params-symfony-validator-sdk)\n\n\nSimple JSON-RPC params validator that use Symfony validator component\n\nSee [yoanm/symfony-jsonrpc-params-validator](https://github.com/yoanm/symfony-jsonrpc-params-validator) for automatic dependency injection.\n\nSee [yoanm/jsonrpc-params-symfony-constraint-doc-sdk](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) for documentation generation.\n\n## Versions\n\n*   Symfony v3/4 - PHP \u003e=7.1 : `^v1.0` \n*   Symfony v4/5 - PHP \u003e=7.2 : `^v2.0`\n\n    ⚠️⚠️ `v0.2.0` is replaced by `v1.0.0` ! ⚠️⚠️\n\n    ⚠️⚠️ `v0.3.0` was badly taggued, used `v2.0.0` instead ! ⚠️⚠️\n\n*   Symfony v4.4/5.4/6.0 - PHP ^8.0 : `^v2.1`\n\n## How to use\n\nIn order to be validated, a JSON-RPC method must : \n*   Implements `JsonRpcMethodInterface` from [`yoanm/jsonrpc-server-sdk`](https://github.com/yoanm/php-jsonrpc-server-sdk)\n*   Implements [`MethodWithValidatedParamsInterface`](./src/Infra/JsonRpcParamsValidator.php)\n\n### With [`yoanm/jsonrpc-server-sdk`](https://github.com/yoanm/php-jsonrpc-server-sdk)\nCreate the validator and inject it into request handler : \n```php\n$requestHandler-\u003esetMethodParamsValidator(\n  new JsonRpcParamsValidator(\n    (new ValidatorBuilder())-\u003egetValidator()\n  )\n);\n```\n\nThen you can send JSON-RPC request string to the server and any method wich implements `MethodWithValidatedParamsInterface` will be validated.\n\n### Standalone \n```php\nuse Symfony\\Component\\Validator\\ValidatorBuilder;\nuse Yoanm\\JsonRpcParamsSymfonyValidator\\Infra\\JsonRpcParamsValidator;\n\n// Create the validator\n$paramsValidator = new JsonRpcParamsValidator(\n  (new ValidatorBuilder())-\u003egetValidator()\n);\n\n// Validate a given JSON-RPC method instance against a JSON-RPC request\n$violationList = $paramsValidator-\u003evalidate($jsonRpcRequest, $jsonRpcMethod);\n```\n\n### Params validation example\n```php\nuse Symfony\\Component\\Validator\\Constraint;\nuse Symfony\\Component\\Validator\\Constraints\\Collection;\nuse Symfony\\Component\\Validator\\Constraints\\NotBlank;\nuse Symfony\\Component\\Validator\\Constraints\\NotNull;\nuse Yoanm\\JsonRpcParamsSymfonyValidator\\Domain\\MethodWithValidatedParamsInterface;\nuse Yoanm\\JsonRpcServer\\Domain\\JsonRpcMethodInterface;\n\nclass MethodExample implements JsonRpcMethodInterface, MethodWithValidatedParamsInterface\n{\n  /**\n   * {@inheritdoc}\n   */\n  public function apply(array $paramList = null)\n  {\n    return 'result';\n  }\n\n  public function getParamsConstraint(): Constraint\n  {\n    return new Collection(\n      [\n        'fields' =\u003e [\n          'fieldA' =\u003e new NotNull(),\n          'fieldB' =\u003e new NotBlank(),\n        ],\n      ]\n    );\n  }\n}\n```\n\n### Violations format\nEach violations will have the following format :\n```php\n[\n  'path' =\u003e 'property_path',\n  'message' =\u003e 'violation message',\n  'code' =\u003e 'violation_code'\n]\n```\n\n## Contributing\nSee [contributing note](./CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoanm%2Fphp-jsonrpc-params-symfony-validator-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoanm%2Fphp-jsonrpc-params-symfony-validator-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoanm%2Fphp-jsonrpc-params-symfony-validator-sdk/lists"}