PHPackages noc-med/zf-rest - 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. [HTTP & Networking](/categories/http) 4. / 5. noc-med/zf-rest ActiveLibrary[HTTP & Networking](/categories/http) noc-med/zf-rest =============== ZF2 Module providing structure for RESTful resources 1.0.3(11y ago)017BSD-3-ClausePHPPHP >=5.3.23 Since Oct 3Pushed 11y ago1 watchersCompare [ Source](https://github.com/nocvp/zf-rest)[ Packagist](https://packagist.org/packages/noc-med/zf-rest)[ Docs](http://apigility.org/)[ RSS](/packages/noc-med-zf-rest/feed)WikiDiscussions master Synced today READMEChangelogDependencies (21)Versions (16)Used By (0) ZF REST ======= [](#zf-rest) [![Build Status](https://camo.githubusercontent.com/2b8efefc15ace00e225255c3545099c0e598c8178f7e6494f44de8bf029fbb29/68747470733a2f2f7472617669732d63692e6f72672f7a6663616d7075732f7a662d726573742e706e67)](https://travis-ci.org/zfcampus/zf-rest) Introduction ------------ [](#introduction) This module provides structure and code for quickly implementing RESTful APIs that use JSON as a transport. It allows you to create RESTful JSON APIs that use the following standards: - [Hypermedia Application Language](http://tools.ietf.org/html/draft-kelly-json-hal-06), aka HAL, used for creating JSON payloads with hypermedia controls. - [Problem Details for HTTP APIs](http://tools.ietf.org/html/draft-nottingham-http-problem-06), aka API Problem, used for reporting API problems. Requirements ------------ [](#requirements) Please see the [composer.json](composer.json) file. Installation ------------ [](#installation) Run the following `composer` command: ``` $ composer require "zfcampus/zf-rest:~1.0-dev" ``` Alternately, manually add the following to your `composer.json`, in the `require` section: ``` "require": { "zfcampus/zf-rest": "~1.0-dev" } ``` 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 array( /* ... */ 'modules' => array( /* ... */ 'ZF\Rest', ), /* ... */ ); ``` Configuration ------------- [](#configuration) ### User Configuration [](#user-configuration) The top-level key used to configure this module is `zf-rest`. #### Key: Controller Service Name [](#key-controller-service-name) Each key under `zf-rest` is a controller service name, and the value is an array with one or more of the following keys. ##### Sub-key: `collection_http_methods` [](#sub-key-collection_http_methods) An array of HTTP methods that are allowed when making requests to a collection. ##### Sub-key: `entity_http_methods` [](#sub-key-entity_http_methods) An array of HTTP methods that are allowed when making requests for entities. ##### Sub-key: `collection_name` [](#sub-key-collection_name) The name of the embedded property in the representation denoting the collection. ##### Sub-key: `collection_query_whitelist` (optional) [](#sub-key-collection_query_whitelist-optional) An array of query string arguments to whitelist for collection requests and when generating links to collections. These parameters will be passed to the resource class' `fetchAll()` method. Any of these parameters present in the request will also be used when generating links to the collection. Examples of query string arguments you may want to whitelist include "sort", "filter", etc. ##### Sub-key: `controller_class` (optional) [](#sub-key-controller_class-optional) An alternate controller class to use when creating the controller service; it **must** extend `ZF\Rest\RestController`. Only use this if you are altering the workflow present in the `RestController`. ##### Sub-key: `identifier` (optional) [](#sub-key-identifier-optional) The name of event identifier for controller. It allows multiple instances of controller to react to different sets of shared events. ##### Sub-key: `resource_identifiers` (optional) [](#sub-key-resource_identifiers-optional) The name or an array of names of event identifier/s for resource. ##### Sub-key: `entity_class` [](#sub-key-entity_class) The class to be used for representing an entity. Primarily useful for introspection (for example in the Apigility Admin UI). ##### Sub-key: `route_name` [](#sub-key-route_name) The route name associated with this REST service. This is utilized when links need to be generated in the response. ##### Sub-key: `route_identifier_name` [](#sub-key-route_identifier_name) The parameter name for the identifier in the route specification. ##### Sub-key: `listener` [](#sub-key-listener) The resource class that will be dispatched to handle any collection or entity requests. ##### Sub-key: `page_size` [](#sub-key-page_size) The number of entities to return per "page" of a collection. This is only used if the collection returned is a `Zend\Paginator\Paginator` instance or derivative. ##### Sub-key: `page_size_param` (optional) [](#sub-key-page_size_param-optional) The name of a query string argument that will set a per-request page size. Not set by default; we recommend having additional logic to ensure a ceiling for the page size as well, to prevent denial of service attacks on your API. #### User configuration example: [](#user-configuration-example) ``` 'AddressBook\\V1\\Rest\\Contact\\Controller' => array( 'listener' => 'AddressBook\\V1\\Rest\\Contact\\ContactResource', 'route_name' => 'address-book.rest.contact', 'route_identifier_name' => 'contact_id', 'collection_name' => 'contact', 'entity_http_methods' => array( 0 => 'GET', 1 => 'PATCH', 2 => 'PUT', 3 => 'DELETE', ), 'collection_http_methods' => array( 0 => 'GET', 1 => 'POST', ), 'collection_query_whitelist' => array(), 'page_size' => 25, 'page_size_param' => null, 'entity_class' => 'AddressBook\\V1\\Rest\\Contact\\ContactEntity', 'collection_class' => 'AddressBook\\V1\\Rest\\Contact\\ContactCollection', 'service_name' => 'Contact', ), ``` ### System Configuration [](#system-configuration) The `zf-rest` module provides the following configuration to ensure it operates properly in a Zend Framework 2 application. ``` 'service_manager' => array( 'invokables' => array( 'ZF\Rest\RestParametersListener' => 'ZF\Rest\Listener\RestParametersListener', ), 'factories' => array( 'ZF\Rest\OptionsListener' => 'ZF\Rest\Factory\OptionsListenerFactory', ), ), 'controllers' => array( 'abstract_factories' => array( 'ZF\Rest\Factory\RestControllerFactory' ) ), 'view_manager' => array( // Enable this in your application configuration in order to get full // exception stack traces in your API-Problem responses. 'display_exceptions' => false, ), ``` ZF2 Events ========== [](#zf2-events) ### Listeners [](#listeners) #### ZF\\Rest\\Listener\\OptionsListener [](#zfrestlisteneroptionslistener) This listener is registered to the `MvcEvent::EVENT_ROUTE` event with a priority of `-100`. It serves two purposes: - If a request is made to either a REST entity or collection with a method they do not support, it will return a `405 Method not allowed` response, with a populated `Allow` header indicating which request methods may be used. - For `OPTIONS` requests, it will respond with a `200 OK` response and a populated `Allow` header indicating which request methods may be used. #### ZF\\Rest\\Listener\\RestParametersListener [](#zfrestlistenerrestparameterslistener) This listener is attached to the shared `dispatch` event at priority `100`. The listener maps query string arguments from the request to the `Resource` object composed in the `RestController`, as well as injects the `RouteMatch`. ZF2 Services ============ [](#zf2-services) ### Models [](#models) #### ZF\\Rest\\AbstractResourceListener [](#zfrestabstractresourcelistener) This abstract class is the base implementation of a [Resource](zfrestresource) listener. Since dispatching of `zf-rest` based REST services is event driven, a listener must be constructed to listen for events triggered from `ZF\Rest\Resource` (which is called from the `RestController`). The following methods are called during `dispatch()`, depending on the HTTP method: - `create($data)` - Triggered by a `POST` request to a resource *collection*. - `delete($id)` - Triggered by a `DELETE` request to a resource *entity*. - `deleteList($data)` - Triggered by a `DELETE` request to a resource *collection*. - `fetch($id)` - Triggered by a `GET` request to a resource *entity*. - `fetchAll($params = array())` - Triggered by a `GET` request to a resource *collection*. - `patch($id, $data)` - Triggered by a `PATCH` request to resource *entity*. - `patchList($data)` - Triggered by a `PATCH` request to a resource *collection*. - `update($id, $data)` - Triggered by a `PUT` request to a resource *entity*. - `replaceList($data)` - Triggered by a `PUT` request to a resource *collection*. #### ZF\\Rest\\Resource [](#zfrestresource) The `Resource` object handles dispatching business logic for REST requests. It composes an `EventManager` instance in order to delegate operations to attached listeners. Additionally, it composes request information, such as the `Request`, `RouteMatch`, and `MvcEvent` objects, in order to seed the `ResourceEvent` it creates and passes to listeners when triggering events. ### Controller [](#controller) #### ZF\\Rest\\RestController [](#zfrestrestcontroller) This is the base controller implementation used when a controller service name matches a configured REST service. All REST services managed by `zf-rest` will use this controller (though separate instances of it), unless they specify a [controller\_class](#subkeycontrollerclassoptional) option. Instances are created via the `ZF\Rest\Factory\RestControllerFactory` abstract factory. The `RestController` calls the appropriate method in `ZF\Rest\Resource` based on the requested HTTP method. It returns [HAL](https://github.com/zfcampus/zf-hal) payloads on success, and [API Problem](https://github.com/zfcampus/zf-api-problem) responses on error. ### Health Score 29 — LowBetter than 57% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community18 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 92.2% 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 ~28 days Total 12 Last Release 4344d ago Major Versions 0.9.1 → 1.0.0beta12014-03-18 PHP version history (3 changes)0.6.0PHP >=5.3.3 0.8.0PHP >=5.4.8 0.9.0PHP >=5.3.23 ### Community Maintainers ![](https://www.gravatar.com/avatar/6cd83d6b6c035e0082e898195d02aa9fb561d10be79e5a6946b8815be8bc33f8?d=identicon)[semihs](/maintainers/semihs) --- Top Contributors [![weierophinney](https://avatars.githubusercontent.com/u/25943?v=4)](https://github.com/weierophinney "weierophinney (626 commits)")[![acabala](https://avatars.githubusercontent.com/u/530622?v=4)](https://github.com/acabala "acabala (11 commits)")[![ralphschindler](https://avatars.githubusercontent.com/u/76674?v=4)](https://github.com/ralphschindler "ralphschindler (8 commits)")[![telkins](https://avatars.githubusercontent.com/u/53731?v=4)](https://github.com/telkins "telkins (6 commits)")[![MichaelGooden](https://avatars.githubusercontent.com/u/1275012?v=4)](https://github.com/MichaelGooden "MichaelGooden (5 commits)")[![Wilt](https://avatars.githubusercontent.com/u/2419627?v=4)](https://github.com/Wilt "Wilt (4 commits)")[![AxaliaN](https://avatars.githubusercontent.com/u/724353?v=4)](https://github.com/AxaliaN "AxaliaN (4 commits)")[![michaelmoussa](https://avatars.githubusercontent.com/u/183833?v=4)](https://github.com/michaelmoussa "michaelmoussa (3 commits)")[![TomHAnderson](https://avatars.githubusercontent.com/u/493920?v=4)](https://github.com/TomHAnderson "TomHAnderson (2 commits)")[![neeckeloo](https://avatars.githubusercontent.com/u/1768645?v=4)](https://github.com/neeckeloo "neeckeloo (1 commits)")[![olavocneto](https://avatars.githubusercontent.com/u/568745?v=4)](https://github.com/olavocneto "olavocneto (1 commits)")[![maldoran](https://avatars.githubusercontent.com/u/2001174?v=4)](https://github.com/maldoran "maldoran (1 commits)")[![samsonasik](https://avatars.githubusercontent.com/u/459648?v=4)](https://github.com/samsonasik "samsonasik (1 commits)")[![sasezaki](https://avatars.githubusercontent.com/u/42755?v=4)](https://github.com/sasezaki "sasezaki (1 commits)")[![semihs](https://avatars.githubusercontent.com/u/4303177?v=4)](https://github.com/semihs "semihs (1 commits)")[![ezimuel](https://avatars.githubusercontent.com/u/475967?v=4)](https://github.com/ezimuel "ezimuel (1 commits)")[![artdevgame](https://avatars.githubusercontent.com/u/353729?v=4)](https://github.com/artdevgame "artdevgame (1 commits)")[![adamculp](https://avatars.githubusercontent.com/u/284451?v=4)](https://github.com/adamculp "adamculp (1 commits)")[![ministerofpanic](https://avatars.githubusercontent.com/u/353729?v=4)](https://github.com/ministerofpanic "ministerofpanic (1 commits)") --- Tags restzendmodulezf2 ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/noc-med-zf-rest/health.svg) ``` [![Health](https://phpackages.com/badges/noc-med-zf-rest/health.svg)](https://phpackages.com/packages/noc-med-zf-rest) ``` ### Alternatives [zfr/zfr-cors Zend Framework module that let you deal with CORS requests 611.3M3](/packages/zfr-zfr-cors)[zfr/zfr-rest Zend Framework 2 REST Module. 8120.7k](/packages/zfr-zfr-rest) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)