README

Repository abandoned 2019-12-31

This repository has moved to laminas-api-tools/api-tools-rpc.

Introduction

Module for implementing RPC web services in Zend Framework.

Enables:

defining controllers as PHP callables.
creating a whitelist of HTTP request methods; requests outside the whitelist will return a 405 Method Not Allowed response with an Allow header indicating allowed methods.

Requirements

Please see the composer.json file.

Installation

Run the following composer command:

$ composer require zfcampus/zf-rpc

Alternately, manually add the following to your composer.json, in the require section:

"require": {
    "zfcampus/zf-rpc": "^1.3"
}

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\Rpc',
    ],
    /* ... */
];

zf-component-installer

If you use zf-component-installer, that plugin will install zf-rpc as a module for you.

Configuration

User Configuration

This module uses the top-level configuration key of zf-rpc.

Key: Controller Service Name

The zf-rpc module uses a mapping between controller service names with the values being an array of information that determine how the RPC style controller will behave. The key should be a controller service name that also matches a controller service name assigned to a route in the router configuration.

Inside this key, the following sub-keys are required:

http_methods: for configuring what methods this RPC service controller can respond to. This also is used for populating the Allow response header for this service.
route_name: for linking back to a particular route. This is especially useful when RPC routes need to build links as part of their response.
callable (optional): utilized to specify a callable that will be invoked at dispatch time. At dispatch time, these callables are typically wrapped in an instance of ZF\Rpc\RpcController, which is a dispatchable action controller.

Example:

'zf-rpc' => [
    'Application\Controller\LoginController' => [
        'http_methods' => ['POST'],
        'route_name'   => 'api-login',
        'callable'     => 'Application\Controller\LoginController::process',
    ],
],

System Configuration

The following configuration ensures this module operates properly in the context of a ZF2 application:

'controllers' => [
    'abstract_factories' => [
        'ZF\Rpc\Factory\RpcControllerFactory',
    ],
],

ZF2 Events

Listeners

ZF\Rpc\OptionsListener

This listeners is registered to the MvcEvent::EVENT_ROUTE event with a priority of -100. It is responsible for ensuring the HTTP response to an OPTIONS request for the given RPC service includes the properly configured and allowed HTTP methods in the Allow header. This uses the configuration from the http_methods key of the zf-rpc service configuration for the matching service. Additionally, it verifies if the incoming request method is in the configured http_methods for the RPC service, and, if not, returns a 405 Method Not Allowed response with a populated Allow header.

ZF2 Services

Models

ZF\Rpc\ParameterMatcher

This particular model is used and is useful for taking a callable and a set of named parameters, and determining which ones can be used as arguments to the callable.

Controller

ZF\Rpc\RpcController

This controller is used to wrap a callable registered as an RPC service in order to make it a ZF2 dispatchable.

zfcampus / zf-rpc

Maintainers

Details