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 protocols 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:
Router
Object
Using a -
Instantiate the
Router
class.$router = new Router();
-
Define routes using the
get()
andpost()
methods. Supply a URI pattern to match against and a callback that is executed when pattern an protocol both match.$router->get("/", function() { // e.g., load a view });
-
Set a 404 callback to load a view or trigger behavior when no route matches.
$router->set404Callback(function() { // e.g., load a 404 view });
-
Optional: define a base path if your application is not located in your server's document root.
$router->setBasePath("/path/to/your/files");
-
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();
Router::getRoute()
Using the Static Routing Method -
Invoke the static method. Provide a base path as 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
PROTOCOL /pattern
, e.g.GET /
when a GET request was made to the root directory.$route = Router::getRoute("/path/to/your/files");
-
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; }
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.