2017 © Pedro Peláez
 

library dash

Flexible PSR-7 compliant HTTP router

image

dasprid/dash

Flexible PSR-7 compliant HTTP router

  • Wednesday, February 10, 2016
  • by DASPRiD
  • Repository
  • 7 Watchers
  • 31 Stars
  • 58 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 9 Forks
  • 2 Open issues
  • 19 Versions
  • 0 % Grown

The README.md

                            ▄▄
                       █▀▀▄█░░█▄         ▄▄▄▄▀▀▀▀▀▀▄
                        ▀▄░░██░░█   █▀▀▀▀▀▓▓▓▓▓▓▒▓▄▄▓▀▄
    ▄▄▄▄▄▄  █▄         ▄▄█░░▀▄░█ ▄▄█▀▄▄▀▀█▒▒▒▄▄▀░▀▀██
  ▄█▀▀▀▀▀▀██▓█        █░▀█░░█░█▀▀▄▄█░░░▄▀▀▀▀░░░░░░░█
▄█▄▄▄░░░▒▒▒▀█▓█        ▀▄░█▀█▀▀█▀▄█▄▄▄▀░░░░▀▀█▀▀██░█
     ▀▀▄▓▓▓▒▒█▄▀▄      ▄▄█▀▀▄░░░█    █░░░░░░ ▀███░░░█▄
        ▀▄▄▓░▒▒▀█▄█▀▀▀▀▒▀█▄█▀░░█▀▀▀▀▀░█░░░░░░░░░░░▄░█
           ▀▀▄▄▓▓░░░░░▓▓▓▓▄█ ▀▄▄░▀░░░░░░░░░▄▄▄▄▄▄▄▄▄▄▀▀
               ▀▄▓▓▓▓▓▄▄▄▀  █▓▒░░░░░░░░░░░█▄▀▀▀█▄▄▄▄▄▄▄
                 ▀▀▀▀▀      ▄▀█░▓▒░░░░▄░░░█░▀░▄▄░░█▒▒▒▒▒▒▒█
                         ▄▄▄▀▀░░░░░░░░▄██▀▀▀▀▀▀█▀░░█▀▀▀▄▄▄▀
    DASH                █░░░░░▄▄▀█▄▄▄▀▀         █░░░█
                        █░░▄▄█▒▒▄▀               █░▄▀
                        ▀▀▀  ▀▀▀                  ▀

Build Status Scrutinizer Code Quality Coverage Status, (*1)

Dash is a router which was initially meant to be a router for Zend Framework 3, but by now evolved into its very own package. It has a dependency on ZF's ServiceManager, but purely for its plugin manager implementation., (*2)

Installation

Dash is supposed to be used with a dependency container, but can in theory be used without one. In the average case where you are using Dash with another framework which supplies you a dependency container, there is a file placed in the config directory, which includes all factories which have to be registered. These factories assume that your container also supplies a config array via the name "config". For specific contents of it, refer to the examples below., (*3)

Withint your application, you can easily retrieve the dependency config by instantiating Dash\ConfigProvider. Since it implements an __invoke() method, it can be used with config managers like expressive-config-manager., (*4)

Route Configuration

Route configuration is greatly simplified from ZF2, routes now have an (optional) 3 key indexed array as the first 3 parameters, the format for the shortcut parameters are:, (*5)

[path, defaults, methods], (*6)

This may feel counter intuitive, but the idea is that the most frequently changed parameter appears earliest in the order so that when defining child routes you can skip parameters you wish to inherit., (*7)

path, will expect a string, whereas defaults will expect an array and method will expect either an array of methods this route should match, a single method in a string, or a string of '*' for all methods. An empty string '' will match no methods. Currently, passing no method defaults to '*'., (*8)

Along with the indexed shortcut parameters, named configuration can also be passed using key value pairs:, (*9)

[
    'path' => '/foo',
    'defaults' => ['action' => 'bar', 'controller' => 'FooController'],
    'methods' => ['get', 'post']
]

Parameters and named values can be mixed, although the first 3 indexed items will always to be presumed to be the parameters as ordered above., (*10)

Child Routes

Child routes can be simply defined in the children key of the configuration of the parent route:, (*11)

'dash' => [
    'routes' => [
        'user' => ['/user', ['action' => 'index', 'controller' => 'UserController'], 'children' => [
            'create' => ['/create', ['action' => 'create'], ['get', 'post']],
            'edit' => ['/edit/:id', ['action' => 'edit'], ['get', 'post'], 'constraints' => ['id' => '\d+']],
            'delete' => ['/delete/:id', ['action' => 'delete'], 'get', 'constraints' => ['id' => '\d+']],
        ]],
    ],
],

Route Types

The router no longer has mulitple route types, instead the Generic route handles all aspects of HTTP routing. Instead of specificing the route type in the configuration, the router now knows how to handle all routes based solely on the configuration., (*12)

For example, if you want a given route only to match a specific hostname, simply define the correct key value pair in that route's configuration:, (*13)

'user' => ['/user', ['action' => index', 'controller' => 'UserController'], 'get', 'hostname' => 'login.example.com']

Similarly, if a given route should only match the https protocol:, (*14)

'user' => ['/user', ['action' => index', 'controller' => 'UserController'], 'get', 'secure' => true]

Overloading

One confusion that's anticipate to be a minor problem is the confusion of how to overload a given route parameter from within a different module. This is easily achieved by defining the relevant key\value in the configuration that is intended to override the route. Overwriting a route parameter by the shortcut key will not take effect because it will only be added to the end of the configuration array, (*15)

Module A
'user' => ['/user', ['action' => index', 'controller' => 'UserController'], 'get']

Module B
'user' => ['path' => '/userinfo']

/user now will no longer match, but /userinfo will match in it's place., (*16)

Development

When doing performance-dependent changes, make sure to compare the benchmarks between master and your branch. To run them, execute the following command:, (*17)

php vendor/bin/athletic -p benchmark -b vendor/autoload.php, (*18)

The Versions

10/02 2016

dev-master

9999999-dev https://github.com/DASPRiD/Dash

Flexible PSR-7 compliant HTTP router

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

psr-7 http routing

10/02 2016

1.1.0

1.1.0.0 https://github.com/DASPRiD/Dash

Flexible PSR-7 compliant HTTP router

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

psr-7 http routing

09/02 2016

1.0.0

1.0.0.0 https://github.com/DASPRiD/Dash

Flexible PSR-7 compliant HTTP router

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

psr-7 http routing

01/11 2015

dev-feature/match-result-simplification

dev-feature/match-result-simplification https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

26/10 2015

dev-feature/remove-duplicate-code

dev-feature/remove-duplicate-code https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

25/10 2015

dev-refactoring/make-assemble-name-explicit

dev-refactoring/make-assemble-name-explicit https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

24/10 2015

dev-feature/immutability

dev-feature/immutability https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

10/10 2015

dev-feature/port-handling

dev-feature/port-handling https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

05/10 2015

dev-feature/response-modifiers

dev-feature/response-modifiers https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

04/10 2015

dev-feature/simplified-parameters

dev-feature/simplified-parameters https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

03/10 2015

dev-feature/simplification

dev-feature/simplification https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

by Avatar DASPRiD

27/06 2014

dev-feature/transformers

dev-feature/transformers https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

21/04 2014

dev-feature/specialized-match-result

dev-feature/specialized-match-result https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

13/04 2014

dev-feature/response-match-return

dev-feature/response-match-return https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

11/04 2014

dev-feature/assembly-performance-improvement

dev-feature/assembly-performance-improvement https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

06/12 2013

dev-feature/assemble

dev-feature/assemble https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

28/11 2013

dev-feature/segment-caching

dev-feature/segment-caching https://github.com/DASPRiD/Dash

Router prototype for Zend Framework 3

  Sources   Download

BSD-2-Clause

The Requires

 

The Development Requires

23/11 2013

dev-feature/optimizations

dev-feature/optimizations

Router prototype for Zend Framework 3

  Sources   Download

The Requires

 

The Development Requires

21/11 2013

dev-refactor/remove-mvc-namespace

dev-refactor/remove-mvc-namespace

Router prototype for Zend Framework 3

  Sources   Download

The Requires

 

The Development Requires