https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk
Simple JSON-RPC params validator that use Symfony validator component
https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk
json-rpc jsonrpc-server-sdk params-validator php sdk symfony-validator
Last synced: about 1 year ago
JSON representation
Simple JSON-RPC params validator that use Symfony validator component
- Host: GitHub
- URL: https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk
- Owner: yoanm
- License: mit
- Created: 2018-05-13T09:19:26.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-30T14:17:35.000Z (almost 2 years ago)
- Last Synced: 2025-04-22T19:07:59.514Z (about 1 year ago)
- Topics: json-rpc, jsonrpc-server-sdk, params-validator, php, sdk, symfony-validator
- Language: PHP
- Homepage:
- Size: 58.6 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# JSON-RPC params symfony validator
[](https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk)
[](https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk)
[](https://dependabot.com)
[](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-validator-sdk/build-status/master)
[](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-validator-sdk/?branch=master)
[](https://www.codacy.com/gh/yoanm/php-jsonrpc-params-symfony-validator-sdk/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=yoanm/php-jsonrpc-params-symfony-validator-sdk\&utm_campaign=Badge_Grade)
[](https://github.com/yoanm/php-jsonrpc-params-symfony-validator-sdk/actions/workflows/CI.yml)
[](https://codecov.io/gh/yoanm/php-jsonrpc-params-symfony-validator-sdk)
[](https://symfony.com/)
[](https://packagist.org/packages/yoanm/jsonrpc-params-symfony-validator-sdk)
[](https://packagist.org/packages/yoanm/jsonrpc-params-symfony-validator-sdk)
Simple JSON-RPC params validator that use Symfony validator component
See [yoanm/symfony-jsonrpc-params-validator](https://github.com/yoanm/symfony-jsonrpc-params-validator) for automatic dependency injection.
See [yoanm/jsonrpc-params-symfony-constraint-doc-sdk](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) for documentation generation.
## Versions
* Symfony v3/4 - PHP >=7.1 : `^v1.0`
* Symfony v4/5 - PHP >=7.2 : `^v2.0`
⚠️⚠️ `v0.2.0` is replaced by `v1.0.0` ! ⚠️⚠️
⚠️⚠️ `v0.3.0` was badly taggued, used `v2.0.0` instead ! ⚠️⚠️
* Symfony v4.4/5.4/6.0 - PHP ^8.0 : `^v2.1`
## How to use
In order to be validated, a JSON-RPC method must :
* Implements `JsonRpcMethodInterface` from [`yoanm/jsonrpc-server-sdk`](https://github.com/yoanm/php-jsonrpc-server-sdk)
* Implements [`MethodWithValidatedParamsInterface`](./src/Infra/JsonRpcParamsValidator.php)
### With [`yoanm/jsonrpc-server-sdk`](https://github.com/yoanm/php-jsonrpc-server-sdk)
Create the validator and inject it into request handler :
```php
$requestHandler->setMethodParamsValidator(
new JsonRpcParamsValidator(
(new ValidatorBuilder())->getValidator()
)
);
```
Then you can send JSON-RPC request string to the server and any method wich implements `MethodWithValidatedParamsInterface` will be validated.
### Standalone
```php
use Symfony\Component\Validator\ValidatorBuilder;
use Yoanm\JsonRpcParamsSymfonyValidator\Infra\JsonRpcParamsValidator;
// Create the validator
$paramsValidator = new JsonRpcParamsValidator(
(new ValidatorBuilder())->getValidator()
);
// Validate a given JSON-RPC method instance against a JSON-RPC request
$violationList = $paramsValidator->validate($jsonRpcRequest, $jsonRpcMethod);
```
### Params validation example
```php
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\Collection;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\NotNull;
use Yoanm\JsonRpcParamsSymfonyValidator\Domain\MethodWithValidatedParamsInterface;
use Yoanm\JsonRpcServer\Domain\JsonRpcMethodInterface;
class MethodExample implements JsonRpcMethodInterface, MethodWithValidatedParamsInterface
{
/**
* {@inheritdoc}
*/
public function apply(array $paramList = null)
{
return 'result';
}
public function getParamsConstraint(): Constraint
{
return new Collection(
[
'fields' => [
'fieldA' => new NotNull(),
'fieldB' => new NotBlank(),
],
]
);
}
}
```
### Violations format
Each violations will have the following format :
```php
[
'path' => 'property_path',
'message' => 'violation message',
'code' => 'violation_code'
]
```
## Contributing
See [contributing note](./CONTRIBUTING.md)