fhooe/router

fhooe/router is a simple object-oriented router developed for PHP classes in the Media Technology and Design program at the University of Applied Sciences Upper Austria. It is primarily designed for educational purposes (learning the concept of routing and object-oriented principles). Its functionality is limited by design (e.g., only GET and POST methods are supported). Use it for "public" applications at your own risk.

Installation

The recommended way to use fhooe-router in your project is through Composer:

composer require fhooe/router

Alternatively, you can use the fhooe/router-skeleton project that gives you a fully working example built upon fhooe/router (including some simple views):

composer create-project fhooe/router-skeleton path/to/install

Composer will create a project in the path/to/install directory.

Basic Usage

fhooe/router can be used in two ways:

Using a Router Object (recommended)

1. Instantiate the Router class.

   $router = new Router();

   Adding a logger: Pass an instance of a PSR-3 compatible logger application, e.g., Monolog, to receive predefined log messages about routes being added and executed. This can be useful to track what the Router is doing.

   $logger = new Logger("skeleton-logger");
   // add processors, formatters or handlers to the logger
   $router = new Router($logger);

2. Define routes using the get() and post() methods. Supply a URI pattern to match against and a callback that is executed when the pattern and HTTP method match.

   $router->get("/", function () {
       // e.g., load a view
   });

   Placeholders: You can define route placeholders using curly brackets. The name of the placeholder will be available as a parameter in the callback, and the actual value in the URI will be its argument.

   $router->get("/product/{id}", function ($id) {
      // e.g., load a view to display the product
   });

   Optional parts: You can make route parts optional by putting them in square brackets. That way, a route will match both ways. This can be, for example, used to make a route work with or without a trailing slash.

   $router->get("/form[/]", function () {
      // e.g., load a view
   });

3. Set a 404 callback to load a view or trigger behavior when no route matches.

   $router->set404Callback(function () {
       // e.g., load a 404 view
   });

4. Optional: Define a base path if your application is not located in your server's document root.

   $router->setBasePath("/path/to/your/files");

5. Run the router. This will fetch the current URI, match it against the defined routes, and execute them if a match is found.

   $router->run();

Using the Static Routing Method Router::getRoute()

1. Invoke the static method. Provide a base path as an argument if your project is not located in your server's document root. The method returns the route as a string in the form of METHOD /pattern , e.g., GET /, when a GET request was made to the root directory.

   $route = Router::getRoute("/path/to/your/files");

2. Use a conditional expression to decide what to do with the matched route.

   switch($route) {
       case "GET /":
           // e.g., load a view
           break;
       default:
           // e.g., load the 404 view
           break;
   }

The static method is intended primarily to quickly get the route string. It offers less functionality, e.g., no reverse route resolution.

Contributing

If you'd like to contribute, please refer to CONTRIBUTING for details.

License

fhooe/router is licensed under the MIT license. See LICENSE for more information.