devinow/router

Devinow Framework Routing Library,Router for PHP. Simple, lightweight and convenient.

4.0.0 2023-08-04 14:45 UTC

Requires

• php: >=8.1.0

MIT

• Devinow

• route
• routing
• http
• router

README

composer require devinow/router

Usage

1. Enable URL rewriting on your web server

   • Apache (in .htaccess or httpd.conf)

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

   • Nginx (in nginx.conf)

     try_files $uri /index.php;
     

2. Create a new Router instance

   • for the web root

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

   • for any subdirectory

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

3. Add some routes and map them to anonymous functions or closures

   • Static route:

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

   • Dynamic route (with parameters):

     $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.

   • Route with multiple supported request methods:

     $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

   // 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)

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

   and

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