delight-im/router

Router for PHP. Simple, lightweight and convenient.

PHP-Router

Router for PHP. Simple, lightweight and convenient., _(*1)

Requirements

• PHP 5.6.0+

Installation

1. Include the library via Composer [?]:, _(*2)

   $ composer require delight-im/router
   

2. Include the Composer autoloader:, _(*3)

   require __DIR__ . '/vendor/autoload.php';
   

Usage

1. Enable URL rewriting on your web server, _(*4)

   • Apache (in .htaccess or httpd.conf), _(*5)

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

   • Nginx (in nginx.conf), _(*6)

     try_files $uri /index.php;
     

2. Create a new Router instance, _(*7)

   • for the web root, _(*8)

     $router = new \Delight\Router\Router();
     

   • for any subdirectory, _(*9)

     $router = new \Delight\Router\Router('/my/base/path');
     

3. Add some routes and map them to anonymous functions or closures, _(*10)

   • Static route:, _(*11)

     $router->get('/', function () {
       // do something
     });
     

   • Dynamic route (with parameters):, _(*12)

     $router->get('/users/:id/photo', function ($id) {
       // get the photo for user `$id`
     });
     

     The values of parameters matched in the URL can be captured as arguments in the callback., _(*13)

   • Route with multiple supported request methods:, _(*14)

     $router->any([ 'POST', 'PUT' ], '/users/:id/address', function ($id) {
       // update the address for user `$id`
     });
     

4. Map routes to controller methods instead for more complex callbacks, _(*15)

   // use static methods
   $router->get('/photos/:id/convert/:mode', [ 'PhotoController', 'myStaticMethod' ]);
   
   // or
   
   // instance methods
   $router->get('/photos/:id/convert/:mode', [ $myPhotoController, 'myInstanceMethod' ]);
   

5. Inject arguments for access to further values and objects (prepended to those matched in the route), _(*16)

   class MyController {
   
       public static function someStaticMethod($database, $uuid) {
           // do something
       }
   
   }
   

   and, _(*17)

   $database = new MyDatabase();
   
   // ...
   
   $router->delete('/messages/:uuid', [ 'MyController', 'someStaticMethod' ], [ $database ]);
   

Contributing

All contributions are welcome! If you wish to contribute, please create an issue first so that your feature, problem or question can be discussed., _(*18)

License

This project is licensed under the terms of the MIT License., _(*19)