Download the PHP package friendsofhyperf/grpc-validation without Composer
On this page you can find all versions of the php package friendsofhyperf/grpc-validation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download friendsofhyperf/grpc-validation
More information about friendsofhyperf/grpc-validation
Files in friendsofhyperf/grpc-validation
Package grpc-validation
Short Description The GRPC validation component for Hyperf.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package grpc-validation
gRPC Validation
中文说明
Validate a protobuf request before a Hyperf gRPC service method runs.
Installation
The component targets Hyperf 3.2 and requires hyperf/context, hyperf/di,
hyperf/grpc-server, and hyperf/validation. Composer installs these dependencies, and
the package's ConfigProvider automatically registers the validation aspect. There is no
component configuration file to publish.
Basic Usage
Add Validation to a gRPC service method and define Hyperf validation rules for the
protobuf message fields:
HiUser and HiReply in this example are project-specific classes generated from your
.proto definitions. The component validates the first
Google\Protobuf\Internal\Message argument passed to the annotated method.
Annotation Options
| Option | Type | Default | Behavior |
|---|---|---|---|
rules |
array |
[] |
Hyperf validation rules used when no resolvable formRequest is provided. |
messages |
array |
[] |
Custom validation messages used with rules. |
formRequest |
string |
'' |
A container-resolvable Hyperf\Validation\Request\FormRequest class. Its rules() and messages() methods replace the inline values. |
scene |
string |
'' |
Passed to FormRequest::scene(). When empty, the annotated method name is used. |
resolve |
bool |
true |
When true, failed validation immediately throws a gRPC validation exception. |
Using a Form Request
Pass a Form Request class when rules should be shared. The class must be resolvable from the container:
The component calls scene(), then reads rules() and messages(). It does not execute
the complete Form Request validation lifecycle, so methods such as authorize(),
attributes(), and withValidator() are not used. It also does not call Form Request's
protected scene-filtering method. To make scene affect the selected rules, implement
that selection in rules(), for example by reading getScene().
If formRequest is not set or cannot be resolved from the container, the component falls
back to the annotation's inline rules and messages.
Validation Behavior
- The protobuf message is converted with
serializeToJsonString()and decoded to an array before validation. - Validation runs only when rules, a protobuf message argument, and non-empty decoded
data are all present. In particular, an entirely empty protobuf message serializes to
{}, decodes to an empty array, and skips validation. - When validation runs, the decoded data is stored in Hyperf context under the protobuf
message class, and the validator is stored under
Hyperf\Contract\ValidatorInterface. - With the default
resolve: true, a failure throwsFriendsOfHyperf\GrpcValidation\Exception\ValidationException. It extendsHyperf\GrpcServer\Exception\GrpcException, uses the first validation error as its message, has code422, and keeps the Hyperf validation exception as its previous exception. - With
resolve: false, the component creates and stores the validator but does not automatically check it or throw on failure.
All versions of grpc-validation with dependencies
hyperf/di Version ~3.2.0
hyperf/grpc-server Version ~3.2.0
hyperf/validation Version ~3.2.0