PHPackages zfcampus/zf-content-validation - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Validation & Sanitization](/categories/validation) 4. / 5. zfcampus/zf-content-validation Abandoned → [laminas-api-tools/api-tools-content-validation](/?search=laminas-api-tools%2Fapi-tools-content-validation)ArchivedLibrary[Validation & Sanitization](/categories/validation) zfcampus/zf-content-validation ============================== Zend Framework module providing incoming content validation 1.8.0(7y ago)191.9M↓39%24[8 issues](https://github.com/zfcampus/zf-content-validation/issues)4BSD-3-ClausePHPPHP ^5.6 || ^7.0 Since Dec 6Pushed 6y ago2 watchersCompare [ Source](https://github.com/zfcampus/zf-content-validation)[ Packagist](https://packagist.org/packages/zfcampus/zf-content-validation)[ RSS](/packages/zfcampus-zf-content-validation/feed)WikiDiscussions master Synced 2d ago READMEChangelog (10)Dependencies (13)Versions (31)Used By (4) ZF Content Validation ===================== [](#zf-content-validation) > ## Repository abandoned 2019-12-31 > > [](#repository-abandoned-2019-12-31) > > This repository has moved to [laminas-api-tools/api-tools-content-validation](https://github.com/laminas-api-tools/api-tools-content-validation). [![Build Status](https://camo.githubusercontent.com/88804d92180c5f358f0946437cfe1f64c078810ac5830a983ad88b577518a71a/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f7a6663616d7075732f7a662d636f6e74656e742d76616c69646174696f6e2e7376673f6272616e63683d6d6173746572)](https://secure.travis-ci.org/zfcampus/zf-content-validation)[![Coverage Status](https://camo.githubusercontent.com/b05ada4ce6f4937cb9b561ce287a9ad0881c023ff1f8407314284ad249d923c9/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f7a6663616d7075732f7a662d636f6e74656e742d76616c69646174696f6e2f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/zfcampus/zf-content-validation?branch=master) Introduction ------------ [](#introduction) Zend Framework module for automating validation of incoming input. Allows the following: - Defining named input filters. - Mapping named input filters to named controller services. - Returning an `ApiProblemResponse` with validation error messages on invalid input. Requirements ------------ [](#requirements) Please see the [composer.json](composer.json) file. Installation ------------ [](#installation) Run the following `composer` command: ``` $ composer require zfcampus/zf-content-validation ``` Alternately, manually add the following to your `composer.json`, in the `require` section: ``` "require": { "zfcampus/zf-content-validation": "^1.4" } ``` And then run `composer update` to ensure the module is installed. Finally, add the module name to your project's `config/application.config.php` under the `modules`key: ``` return [ /* ... */ 'modules' => [ /* ... */ 'ZF\ContentValidation', ], /* ... */ ]; ``` Configuration ------------- [](#configuration) ### User Configuration [](#user-configuration) This module utilizes two user level configuration keys `zf-content-validation` and also `input_filter_specs` (named such that this functionality can be moved into ZF2 in the future). #### Service Name key [](#service-name-key) The `zf-content-validation` key is a mapping between controller service names as the key, and the value being an array of mappings that determine which HTTP method to respond to and what input filter to map to for the given request. The keys for the mapping can either be an HTTP method that accepts a request body (i.e., `POST`, `PUT`, `PATCH`, or `DELETE`), or it can be the word `input_filter`. The value assigned for the `input_filter` key will be used in the case that no input filter is configured for the current HTTP request method. Example where there is a default as well as a POST filter: ``` 'zf-content-validation' => [ 'Application\Controller\HelloWorld' => [ 'input_filter' => 'Application\Controller\HelloWorld\Validator', 'POST' => 'Application\Controller\HelloWorld\CreationValidator', ], ], ``` In the above example, the `Application\Controller\HelloWorld\Validator` service will be selected for `PATCH`, `PUT`, or `DELETE` requests, while the `Application\Controller\HelloWorld\CreationValidator`will be selected for `POST` requests. Starting in version 1.1.0, two additional keys can be defined to affect application validation behavior: - `use_raw_data`: if NOT present, raw data is ALWAYS injected into the "BodyParams" container (defined by zf-content-negotiation). If this key is present and a boolean false, then the validated, filtered data from the input filter will be used instead. - `allows_only_fields_in_filter`: if present, and `use_raw_data` is boolean false, the value of this flag will define whether or not additional fields present in the payload will be merged with the filtered data. - `remove_empty_data`: Should we remove empty data from received data? - If no `remove_empty_data` flag is present, do nothing - use data as is - If `remove_empty_data` flag is present AND is boolean true, then remove empty data from current data array - Does not remove empty data if keys matched received data > ### Validating GET requests > > [](#validating-get-requests) > > - **Since 1.3.0.** > > Starting in 1.3.0, you may also specify `GET` as an HTTP method, mapping it to an input filter in order to validate your query parameters. Configuration is exactly as described in the above section. > > This feature is only available when manually configuring your API; it is not exposed in the Admin UI. > ### Validating collection requests > > [](#validating-collection-requests) > > - **Since 1.5.0** > > Starting in 1.5.0, you may specify any of: > > - `POST_COLLECTION` > - `PUT_COLLECTION` > - `PATCH_COLLECTION` > > as keys. These will then be used specifically with the given HTTP method, but only on requests matching the collection endpoint. > ### Validating DELETE requests > > [](#validating-delete-requests) > > - **Since 1.6.0** > > Starting in 1.6.0, you may specify each of the following keys for input filters: > > - `DELETE` > - `DELETE_COLLECTION` > > The input filter associated with the key will be used to validate data sent in the request body. #### input\_filter\_spec [](#input_filter_spec) `input_filter_spec` is for configuration-driven creation of input filters. The keys for this array will be a unique name, but more often based off the service name it is mapped to under the `zf-content-validation` key. The values will be an input filter configuration array, as is described in the ZF2 manual [section on input filters](http://zf2.readthedocs.org/en/latest/modules/zend.input-filter.intro.html). Example: ``` 'input_filter_specs' => [ 'Application\Controller\HelloWorldGet' => [ 0 => [ 'name' => 'name', 'required' => true, 'filters' => [ 0 => [ 'name' => 'Zend\Filter\StringTrim', 'options' => [], ], ], 'validators' => [], 'description' => 'Hello to name', 'allow_empty' => false, 'continue_if_empty' => false, ], ], ``` ### System Configuration [](#system-configuration) The following configuration is defined by the module in order to function within a ZF2 application. ``` namespace ZF\ContentValidation; use Zend\InputFiler\InputFilterAbstractServiceFactory; use Zend\ServiceManager\Factory\InvokableFactory; return [ 'controller_plugins' => [ 'aliases' => [ 'getinputfilter' => InputFilter\InputFilterPlugin::class, 'getInputfilter' => InputFilter\InputFilterPlugin::class, 'getInputFilter' => InputFilter\InputFilterPlugin::class, ], 'factories' => [ InputFilter\InputFilterPlugin::class => InvokableFactory::class, ], ], 'input_filters' => [ 'abstract_factories' => [ InputFilterAbstractServiceFactory::class, ], ], 'service_manager' => [ 'factories' => [ ContentValidationListener::class => ContentValidationListenerFactory::class, ], ], 'validators' => [ 'factories' => [ 'ZF\ContentValidation\Validator\DbRecordExists' => Validator\Db\RecordExistsFactory::class, 'ZF\ContentValidation\Validator\DbNoRecordExists' => Validator\Db\NoRecordExistsFactory::class, ], ], ]; ``` ZF Events --------- [](#zf-events) ### Listeners [](#listeners) #### ZF\\ContentValidation\\ContentValidationListener [](#zfcontentvalidationcontentvalidationlistener) This listener is attached to the `MvcEvent::EVENT_ROUTE` event at priority `-650`. Its purpose is to utilize the `zf-content-validation` configuration in order to determine if the current request's selected controller service name has a configured input filter. If it does, it will traverse the mappings from the configuration file to create the appropriate input filter (from configuration or the Zend Framework 2 input filter plugin manager) in order to validate the incoming data. This particular listener utilizes the data from the `zf-content-negotiation` data container in order to get the deserialized content body parameters. ### Events [](#events) #### ZF\\ContentValidation\\ContentValidationListener::EVENT\_BEFORE\_VALIDATE [](#zfcontentvalidationcontentvalidationlistenerevent_before_validate) This event is emitted by `ZF\ContentValidation\ContentValidationListener::onRoute()`(described above) in between aggregating data to validate and determining the input filter, and the actual validation of data. Its purpose is to allow users: - the ability to manipulate input filters. - to modify the data set to validate (available since 1.4.0). As an example, you might want to validate an identifier provided via the URI, and matched during routing. You may do this as follows: ``` $events->listen(ContentValidationListener::EVENT_BEFORE_VALIDATE, function ($e) { if ($e->getController() !== MyRestController::class) { return; } $matches = $e->getRouteMatch(); $data = $e->getParam('ZF\ContentValidation\ParameterData') ?: []; $data['id'] = $matches->getParam('id'); $e->setParam('ZF\ContentValidation\ParameterData', $data); }); ``` ZF Services ----------- [](#zf-services) ### Controller Plugins [](#controller-plugins) #### ZF\\ContentValidation\\InputFilter\\InputFilterPlugin (aka getInputFilter) [](#zfcontentvalidationinputfilterinputfilterplugin-aka-getinputfilter) This plugin is available to Zend Framework 2 controllers. When invoked (`$this->getInputFilter()` or `$this->plugin('getinputfilter')->__invoke()`), it returns whatever is in the MVC event parameter `ZF\ContentValidation\InputFilter`, returning null for any value that is not an implementation of `Zend\InputFilter\InputFilter`. ### Service [](#service) #### Zend\\InputFilter\\InputFilterAbstractServiceFactory [](#zendinputfilterinputfilterabstractservicefactory) This abstract factory is responsible for creating and returning an appropriate input filter given a name and the configuration from the top-level key `input_filter_specs`. It is registered with `Zend\InputFilter\InputFilterPluginManager`. ### Health Score 43 — FairBetter than 89% of packages Maintenance12 Infrequent updates — may be unmaintained Popularity50 Moderate usage in the ecosystem Community29 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 73% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~73 days Recently: every ~53 days Total 27 Last Release 2678d ago Major Versions 0.9.1 → 1.0.0beta12014-03-18 PHP version history (4 changes)0.8.0PHP >=5.4.8 0.9.0PHP >=5.3.23 1.2.0PHP >=5.5 1.3.0PHP ^5.6 || ^7.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/296074?v=4)[Zend Framework](/maintainers/zendframework)[@zendframework](https://github.com/zendframework) --- Top Contributors [![weierophinney](https://avatars.githubusercontent.com/u/25943?v=4)](https://github.com/weierophinney "weierophinney (268 commits)")[![michalbundyra](https://avatars.githubusercontent.com/u/7423207?v=4)](https://github.com/michalbundyra "michalbundyra (30 commits)")[![jguittard](https://avatars.githubusercontent.com/u/5320213?v=4)](https://github.com/jguittard "jguittard (25 commits)")[![rkeet-salesupply](https://avatars.githubusercontent.com/u/37324639?v=4)](https://github.com/rkeet-salesupply "rkeet-salesupply (10 commits)")[![ruzann](https://avatars.githubusercontent.com/u/40264956?v=4)](https://github.com/ruzann "ruzann (9 commits)")[![Ocramius](https://avatars.githubusercontent.com/u/154256?v=4)](https://github.com/Ocramius "Ocramius (6 commits)")[![akrabat](https://avatars.githubusercontent.com/u/33135?v=4)](https://github.com/akrabat "akrabat (4 commits)")[![steverhoades](https://avatars.githubusercontent.com/u/1146668?v=4)](https://github.com/steverhoades "steverhoades (4 commits)")[![rkeet](https://avatars.githubusercontent.com/u/3327864?v=4)](https://github.com/rkeet "rkeet (3 commits)")[![ralphschindler](https://avatars.githubusercontent.com/u/76674?v=4)](https://github.com/ralphschindler "ralphschindler (1 commits)")[![AdilHoumadi](https://avatars.githubusercontent.com/u/462805?v=4)](https://github.com/AdilHoumadi "AdilHoumadi (1 commits)")[![BreiteSeite](https://avatars.githubusercontent.com/u/2171105?v=4)](https://github.com/BreiteSeite "BreiteSeite (1 commits)")[![neeckeloo](https://avatars.githubusercontent.com/u/1768645?v=4)](https://github.com/neeckeloo "neeckeloo (1 commits)")[![adamculp](https://avatars.githubusercontent.com/u/284451?v=4)](https://github.com/adamculp "adamculp (1 commits)")[![samsonasik](https://avatars.githubusercontent.com/u/459648?v=4)](https://github.com/samsonasik "samsonasik (1 commits)")[![snapshotpl](https://avatars.githubusercontent.com/u/312655?v=4)](https://github.com/snapshotpl "snapshotpl (1 commits)")[![vixriihi](https://avatars.githubusercontent.com/u/5203261?v=4)](https://github.com/vixriihi "vixriihi (1 commits)") --- Tags validationZendFrameworkzfmodule ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/zfcampus-zf-content-validation/health.svg) ``` [![Health](https://phpackages.com/badges/zfcampus-zf-content-validation/health.svg)](https://phpackages.com/packages/zfcampus-zf-content-validation) ``` ### Alternatives [stroker/form ZF2 module for extending forms with live clientside validation 3957.1k](/packages/stroker-form)[hrevert/ht-img-module Image manipulation module for Zend Framework 2 1829.6k2](/packages/hrevert-ht-img-module) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)