Giter Club home page Giter Club logo

php-jsonrpc-params-symfony-validator-sdk's Introduction

JSON-RPC params symfony validator

License Code size Dependabot Status

Scrutinizer Build Status Scrutinizer Code Quality Codacy Badge

CI codecov Symfony Versions

Latest Stable Version Packagist PHP version

Simple JSON-RPC params validator that use Symfony validator component

See yoanm/symfony-jsonrpc-params-validator for automatic dependency injection.

See yoanm/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 :

Create the validator and inject it into request handler :

$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

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

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 :

[
  'path' => 'property_path',
  'message' => 'violation message',
  'code' => 'violation_code'
]

Contributing

See contributing note

php-jsonrpc-params-symfony-validator-sdk's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar yoanm avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

sbooker symfonyx

php-jsonrpc-params-symfony-validator-sdk's Issues

Fix bad versionning

Same mistake than there

  • Create v1.0.0 from v0.2.0
  • Create v2.0.0 from v0.3.0
  • update README with :
    - Symfony v3/4 - PHP >=7.0 : `^v1.0` 
    - Symfony v4/5 - PHP >=7.1 : `^v2.0`
    
      ⚠️⚠️ `v0.2.0` is replaced by `v1.0.0` ! ⚠️⚠️
      ⚠️⚠️ `v0.3.0` was badly taggued, used `v2.0.0` instead ! ⚠️⚠️

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.