2017 © Pedro PelĂĄez
 

library router

Routeur HTTP basique écrit en PHP sans aucune dépendance.

image

akibatech/router

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  • Sunday, September 25, 2016
  • by MarceauKa
  • Repository
  • 1 Watchers
  • 3 Stars
  • 33 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 13 Versions
  • 14 % Grown

The README.md

Router

Build Status, (*1)

Router is a lightweight HTTP resquest router written in PHP., (*2)

It will be your perfect companion if you need a simple and effective library or if you want an easy to understand routing library.
Otherwise, take a look at these awesome libraries symfony/routing ou league/route., (*3)

Installation

Router can be installed with composer: composer require marceauka/router. For now, it requires PHP 7.4 or 8.0., (*4)

Also, copy / paste src/Router.php where you want and require it., (*5)

Configure Apache

The router works perfectly with any kind of URL, but if you want some url rewriting, you can use this example .htaccess., (*6)

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]

Usage

Instanciation

Router as no params., (*7)

$router = new Router;

Adding routes

Once you have the instance, adding routes is childish., (*8)

// Will respond to : /hello (en GET)
$router->get('hello', function () {
    echo 'Hello world!';
});

Your routes can follow these HTTP verbs: POST, PUT, PATCH and DELETE., (*9)

// POST request
$router->post(...);
// PATCH request
$router->patch(...);

A route can use many HTTP verbs:, (*10)

// GET and POST requests
$router->add(['GET', 'POST'], 'hello', ...);
// ... Or all HTTP verbs
$router->any('hello', ...);

Finally, routes can be chained or added with a callback:, (*11)

// Chaining
$router->get('foo', ...)->get('bar', ...);
// ...or via a callback
$router->routes(function ($router) {
    // Votre logique
});

If no callback is given to the routes() method, all routes will be returned., (*12)

$router->get('hello', ...);

var_dump($router->routes()); // Returns [1 => ['uri' => 'hello', 'action' => '...']]

Listening requests

For everything to work, Router needs to incoming requests:, (*13)

// Will use REQUEST_URI and REQUEST_METHOD
$router->listen();
// You can spoof them with your own logic (Request library for example).
$router->listing('request', 'method');

Dispatching actions

Obviously, for each route, a need. You need to define an action for each of them., (*14)

  • A callback :
$router->get('hello', function () {
    echo 'Hello!';
})
  • A class (controller, ...) :
$router->get('hello', 'MyClass@myMethod');

Here, the route, once matched, will instanciate the class named "MyClass" and will call the "myMethod" method.
Note: Router will accepts namespaces if you application can autoload them (PSR-4, ...)., (*15)

$router->get('route-namespace', 'App\Http\Controller@myMethod');

Besides, you can define a global namespace for all of your actions., (*16)

// Will call App\Http\Controller\Account@resume()
$router->namespaceWith('App\Http\Controller')->get('mon-account', 'Account@resume');

You can define a not found action when no routes was matched., (*17)

$router->whenNotFound(function () {
    echo 'Page not found';
});

URL parameters

Your routes can contains dynamic parameters. Usage is simple., (*18)

// Autorise "profile/1" or "profile/12" but not "profile/john".
$router->get('profile/{:num}', ...);

Parameters can be:, (*19)

  • {:num} for a numeric value
  • {:alpha} for a alpha value
  • {:any} for all kinds of chars
  • {:slug} for numbers, alpha, dash (-) and arobase (@)

Once matched, parameters are sent to the corresponding action in the URL defined order., (*20)

$router->get('profile/{:num}/{:alpha}', function ($id, $name) {
    echo "My name is $name and my ID is $id !";
});

Named routes

You can give a name to your routes to access them later or easily creating links (in a view for example)., (*21)

$router->get('/homepage', '...', 'home');
$router->link('home'); // Returns "/homepage"

If your route contains parameters, you can build an URI with filled parameters.
You need to give all parameters expected by the route, otherwise and exception will be rised., (*22)

$router->get('/tag/{:slug}', '...', 'tag');
$router->link('tag', 'wordpress'); // => Returns "/tag/wordpress"

$router->get('/user/{:num}/{:any}', '...', 'profile');
$router->link('profile', [42, 'JohnDoe']); // => Returns "/user/42/JohnDoe"

Caching

Sometimes, when our router contains many routes, it's convenient to have a ready-to-use Router instance for each script execution. Router supports serialization and unserialization. Two helpers exists to assists you., (*23)

  • Export the configured instance:
$compiled = $router->getCompiled(); // Retourns a string
  • Import a configured instance:
$router = MarceauKa\Router::fromCompiled($compiled); // Returns the instance previously configured

Note: Routes using a callback can't be serialized. Only the "MyClass@myMethod" is serializable.
The router does not provide functionnality to store or read a cache file. It's not its goal., (*24)

Tests

Tests are with PHPUnit 9. You can use the phpunit command given at vendor/bin., (*25)

vendor/bin/phpunit

Tests are certainly incomplete. Feel free to contribute., (*26)

Licence

MIT, (*27)

The Versions

25/09 2016

dev-master

9999999-dev

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

25/09 2016

1.0.1

1.0.1.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

19/08 2016

1.0.0

1.0.0.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

19/08 2016

0.1.4

0.1.4.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

13/08 2016

0.1.3

0.1.3.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

07/08 2016

0.1.2

0.1.2.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

07/08 2016

0.1.1

0.1.1.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

07/08 2016

0.1.0

0.1.0.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

06/08 2016

0.0.5

0.0.5.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

06/08 2016

0.0.4

0.0.4.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.4

 

The Development Requires

by Avatar MarceauKa

rest library http simple router routes routeur

06/08 2016

0.0.3

0.0.3.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.4

 

by Avatar MarceauKa

rest library http simple router routes routeur

06/08 2016

0.0.2

0.0.2.0

Routeur HTTP basique écrit en PHP sans aucune dépendance.

  Sources   Download

MIT

The Requires

  • php >=5.4

 

by Avatar MarceauKa

library simple router routeur

06/08 2016

0.0.1

0.0.1.0

Routeur HTTP basique Ă©crit en PHP.

  Sources   Download

MIT

The Requires

  • php 5.4

 

by Avatar MarceauKa

library simple router routeur