Download the PHP package alexoliverwd/basic-router without Composer
On this page you can find all versions of the php package alexoliverwd/basic-router. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download alexoliverwd/basic-router
More information about alexoliverwd/basic-router
Files in alexoliverwd/basic-router
Package basic-router
Short Description A minimalistic yet powerful PHP class designed to handle routing in web applications.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package basic-router
Basic Router
This application is a minimalistic yet powerful PHP class designed to handle routing in web applications. It's a dependency-free solution that offers a straightforward approach to mapping HTTP requests to specific PHP functions or methods.
Installation
Preferred installation is via Composer:
Basic Usage
When a request comes in to the application, the Router instance will examine the request method (GET, POST, PUT, DELETE) and the requested URL. If a matching route is found, the associated callback function will be executed.
Attribute-Based Controller Routing
Attributes provide a modern, native way to declare route metadata directly in your code. This approach is now recommended for defining routes, while conventional methods will remain supported for compatibility.
Conventional Method
In this example, if a GET request is made to the root URL (/), the function function () { echo 'get'; } will be called, and the string "get" will be output.
Registering an endpoint
The method registers a new route in the routing system.
Parameters
- Method: The HTTP method (e.g., GET, POST, PUT, DELETE).
- Route: The URL pattern for the route.
- Callback: The callable function or method to be executed when the route is matched.
Return Value:
- true: If the route is successfully registered.
- false: If the route already exists for the specified method.
Executing registered routes
The method is the core of the routing system. It's responsible for:
- Parsing the Request: Extracts the requested URL path and HTTP method from the server environment.
- Matching Routes: Compares the parsed request against registered routes to find a matching route.
- Executing Callback: If a match is found, the associated callback function is executed.
- Handling 404 Errors: If no match is found, the registered 404 error handler is invoked.
Unregistering an endpoint
This method unregisters a previously registered route from the routing system.
Parameters
- Method: The HTTP method (e.g., GET, POST, PUT, DELETE) in lowercase.
- Route: The URL pattern of the route to be unregistered.
Return Value:
- true: If the route is successfully unregistered.
- false: If the route doesn't exist or couldn't be unregistered.
Handling 404 errors
The method registers a callback function to be executed when a 404 Not Found error occurs. This allows you to customize the error handling behavior for your application.
Parameters
- Callback: A callable function or method that will be invoked when a 404 error is encountered. This callback can be used to generate custom error messages, redirect to a specific page, or perform other error handling actions.
