Download the PHP package eth8505/laminas-api-tools-rest-queryparam-validation without Composer
On this page you can find all versions of the php package eth8505/laminas-api-tools-rest-queryparam-validation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eth8505/laminas-api-tools-rest-queryparam-validation
More information about eth8505/laminas-api-tools-rest-queryparam-validation
Files in eth8505/laminas-api-tools-rest-queryparam-validation
Package laminas-api-tools-rest-queryparam-validation
Short Description query string validation for laminas-api-tools/api-tools-rest
License MIT
Informations about the package laminas-api-tools-rest-queryparam-validation
LaminasRestQueryParamValidation - Laminas Module for api-tools-rest QueryString validation
The LaminasRestQueryParamValidation module allows you to validate query parameters with laminas-api-tools/api-tools-rest just like you would with laminas-api-tools/api-tools-content-validation for entities.
How to install
Install eth8505/laminas-api-tools-rest-queryparam-validation
package via composer.
$ composer require eth8505/laminas-api-tools-rest-queryparam-validation
Load the module in your application.config.php
file like so:
<?php
return [
'modules' => [
'LaminasRestQueryParamValidation',
// ...
],
];
How to use
Just like with laminas-api-tools/api-tools-content-validation, specify a
query_filter
key in the api-tools-content-validation
section of your module.config.php
and register a
input_filter_spec
. The Laminas API Tools docs
dig into this a little deeper.
Generic query param validation for a rest controller
<?php
return [
// ...
'api-tools-content-validation' => [
'MyModule\\V1\\Rest\\MyModule\\Controller' => [
'query_filter' => 'MyModule\\V1\\Rest\\MyModule\\QueryValidator',
],
],
// ...
'input_filter_specs' => [
'MyModule\\V1\\Rest\\MyModule\\QueryValidator' => [
0 => [
'required' => false,
'validators' => [
// ...
],
'filters' => [],
'name' => 'my_param',
'field_type' => 'integer',
],
],
],
];
Action-specific query-validation
<?php
return [
// ...
'api-tools-content-validation' => [
'MyModule\\V1\\Rest\\MyModule\\Controller' => [
'query_filter' => [
'default' => 'MyModule\\V1\\Rest\\MyModule\\QueryValidator',
'fetchAll' => 'MyModule\\V1\\Rest\\MyModule\\FetchAllQueryValidator'
],
],
],
// ...
'input_filter_specs' => [
'MyModule\\V1\\Rest\\MyModule\\QueryValidator' => [
0 => [
'required' => false,
'validators' => [
// ...
],
'filters' => [],
'name' => 'my_param',
'field_type' => 'integer',
],
],
'MyModule\\V1\\Rest\\MyModule\\FetchAllQueryValidator' => [
0 => [
'required' => false,
'validators' => [
// ...
],
'filters' => [],
'name' => 'my_fetch_all_param',
'field_type' => 'integer',
],
]
],
];
Thanks
Thanks to jdelisle and his Query String validation gist which this module is based on.
All versions of laminas-api-tools-rest-queryparam-validation with dependencies
laminas/laminas-servicemanager Version ^3.4
laminas-api-tools/api-tools-rest Version ^1.5
laminas/laminas-inputfilter Version ^2.10
laminas/laminas-eventmanager Version ^3.3
laminas-api-tools/api-tools-api-problem Version ^1.3
laminas-api-tools/api-tools-content-validation Version ^1.8