marco476/routing-manager

PHP performance-oriented routing manager

, _(*1)

PHP performance-oriented Routing manager

This library is PHP performance-oriented routing manager working with routes setted by:, _(*2)

• PHP Array
• YAML file
• XML file

Installation

You can install it with Composer:, _(*3)

composer require marco476/routing-manager

Usage

Use the routing-manager library is extreme simple. All routes setted must include an expression key/tag for matching with URI., _(*4)

When you call matchRoute method, the library find a match between routes setted and URI present. It return the route matched array if math with URI is Ok or false if not., _(*5)

Array

See an example with array:, _(*6)

setRoutes(array(
    'homepage' => array( //Name route
        'expression'     => '/', //MUST DEFINE!
        'controller'=> 'MyController',
        'action'    => 'MyAction',
        'extra1'    => 'extra1',
        'extra2'    => 'extra2'
    )
));

if ($routeMatch = $Routing->matchRoute()) {
    echo "See that" . "
";
    var_dump($routeMatch);
} else {
    echo "mmm.. what's wrong?";
}
```

### YML
See an example with **YML**:

```PHP
setRoutesFromYml(__DIR__, 'routes.yml');

if ($routeMatch = $Routing->matchRoute()) {
    echo "See that" . "
";
    var_dump($routeMatch);
} else {
    echo "mmm.. what's wrong?";
}
```

And see a YML routes configuration file:

```YML
homepage: #Name route
    expression: "/" #MUST DEFINE!
    controller: "MyController"
    action:     "MyAction"
    params:     ["myFirstParameter", "sendMe"]
```

> Note: If you want use a YAML file routes configuration, you must install the yaml php extension. You can install it with *sudo apt-get install php-yaml* or with *PECL*. For detail, [see that](http://bd808.com/pecl-file_formats-yaml/)

### XML
See an example with **XML**:

```PHP
setRoutesFromXml(__DIR__, 'routes.xml');

if ($routeMatch = $Routing->matchRoute()) {
    echo "See that" . "
";
    var_dump($routeMatch);
} else {
    echo "mmm.. what's wrong?";
}
```

And see a XML routes configuration file:

```XML

<root>
  <node>
    <expression>/</expression>
    <controller>MyController</controller>
    <action>MyAction</action>
    <extra>Hello</extra>
  </node>
  <node>
    <expression>/contacts</expression>
    <controller>MyController2</controller>
    <params>Hello1</params>
    <extra>
      <name>Marco</name>
      <surname>Cante</surname>
    </extra>
  </node>
</root>

Note: If you want use a XML file routes configuration, you must install the libxml php extension. You can see that, _(*7)

Wildcards

A wildcard is a jolly name inserting into {} (like {idUser}). You can set wildcards into expression key/tag and set a requirements array key/tag for each one of them (see the example on bottom)., _(*8)

If requirements array is not present for a wildcard, it can be everything. For example:, _(*9)

'expression'    => '/{myName}'

It can be everything: * /marco * /123 * /marco123, _(*10)

If requirements array is present for a wildcard, you can use a custom regular expression or ExpressionRoute static constant for NUMERIC or STRING (only in PHP array) strong expression. For example :, _(*11)

'expression'    => '/{myName}',
'requirements'  => array(
    'myName'  => ExpressionRoute::STRING
    )

It can be: * /marco * /wellName, _(*12)

But not: * /123 * /marco123, _(*13)

And with custom regular expression:, _(*14)

'expression'    => '/{myName}',
'requirements'  => array(
    'myName'  => (marco|luigi)
    )

It can be: * /marco * /luigi, _(*15)

and not else! See the examples on bottom:, _(*16)

Wildcards in Array

See an example with array:, _(*17)

setRoutes(array(
    'homepage' => array(
        'expression'    => '/{wildcard}/{wildcard2}',
        'requirements'  => array(
            'wildcard'  => ExpressionRoute::NUMERIC,
            'wildcard2' => '(hello|bye)'
            ),
        'controller'    => 'MyController',
        'action'        => 'MyAction',
        'extra1'        => 'extra1',
    )
));

if ($routeMatch = $Routing->matchRoute()) {
    echo "See my data!";
    var_dump($routeMatch);
} else {
    echo "mmm.. what's wrong?";
}
```

### Wildcards in YML
See an example with **YML**:

```YML
homepage: 
    expression:   "/{test}"
    requirements:
        test:     "[a-zA-Z]+"
    controller:   "IndexController"
    action:       "showHomeAction"
    params:       ["myFirstParameter", "sendMe"]
```

### Wildcards in XML
See an example with **XML**:

```XML

<root>
  <node>
    <expression>/{test}</expression>
    <requirements>
      <test>(marco|luigi)</test>
    </requirements>
    <controller>MyController</controller>
    <action>MyAction</action>
  </node>
</root>

Unit Test

You can run unit test from document root with:, _(*18)

vendor/bin/phpunit