2017 © Pedro Peláez
 

library base-path-router

A PSR-15 middleware for hierarchical dispatching based on path prefixes

image

middlewares/base-path-router

A PSR-15 middleware for hierarchical dispatching based on path prefixes

  • Tuesday, July 3, 2018
  • by oscarotero
  • Repository
  • 2 Watchers
  • 1 Stars
  • 0 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

middlewares/base-path-router

Latest Version on Packagist ![Software License][ico-license] Testing ![Total Downloads][ico-downloads], (*1)

A middleware dispatching to other middleware stacks, based on different path prefixes., (*2)

Requirements

Installation

This package is installable and autoloadable via Composer as middlewares/base-path-router., (*3)

composer require middlewares/base-path-router

You may also want to install middlewares/request-handler., (*4)

Example

This example uses middleware/request-handler to execute the route handler:, (*5)

$dispatcher = new Dispatcher([
    new Middlewares\BasePathRouter([
        '/admin' => $admin,
        '/admin/login' => $adminLogin,
        '/blog' => $blog,
    ]),
    new Middlewares\RequestHandler()
]);

$response = $dispatcher->dispatch(new ServerRequest());

BasePathRouter allows anything to be defined as the router handler (a closure, callback, action object, controller class, etc). The middleware will store this handler in a request attribute., (*6)

Usage

You have to set an array of paths (as keys) and handlers (as values)., (*7)

$router = new Middlewares\BasePathRouter([
    '/foo' => $routerFoo,
    '/bar' => $routerBar,
    '/foo/bar' => $routerFooBar,
]);

Optionally, you can provide a Psr\Http\Message\ResponseFactoryInterface as the second argument, to create the error responses (404) if the router is not found. If it's not defined, Middleware\Utils\Factory will be used to detect it automatically., (*8)

$responseFactory = new MyOwnResponseFactory();

$router = new Middlewares\BasePathRouter($paths, $responseFactory);

continueOnError

Set true to continue to the next middleware instead return an empty 404 response for non-matching requests (i.e. those that do not have an URI path start with one of the provided prefixes)., (*9)

stripPrefix

By default, subsequent middleware will receive a slightly manipulated request object: any matching path prefixes will be stripped from the URI. This helps when you have a hierarchical setup of routers, where subsequent routers (e.g. one for the API stack mounted under the /api endpoint) can ignore the common prefix., (*10)

If you want to disable this behavior, use the stripPrefix method:, (*11)

$router = (new Middlewares\BasePathRouter([
        '/prefix1' => $middleware1,
    ]))->stripPrefix(false);

attribute

The attribute name used to store the handler in the server request. The default attribute name is request-handler., (*12)

$dispatcher = new Dispatcher([
    //Save the route handler in an attribute called "route"
    (new Middlewares\BasePathRouter($paths))->attribute('route'),

    //Execute the route handler
    (new Middlewares\RequestHandler())->attribute('route')
]);

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details., (*13)

The MIT License (MIT). Please see LICENSE for more information., (*14)

The Versions

03/07 2018

dev-master

9999999-dev https://github.com/middlewares/base-path-router

A PSR-15 middleware for hierarchical dispatching based on path prefixes

  Sources   Download

MIT

The Requires

 

The Development Requires

middleware psr-7 server http routing psr-15