Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amranich/ajax-router
URL query string-based routing library that is PSR-7 compatible.
https://github.com/amranich/ajax-router
ajax ajax-dispatcher ajax-requests ajax-router http php router
Last synced: 17 days ago
JSON representation
URL query string-based routing library that is PSR-7 compatible.
- Host: GitHub
- URL: https://github.com/amranich/ajax-router
- Owner: AmraniCh
- License: mit
- Created: 2021-10-31T00:00:12.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-04T15:49:11.000Z (12 months ago)
- Last Synced: 2024-10-12T06:54:53.584Z (about 1 month ago)
- Topics: ajax, ajax-dispatcher, ajax-requests, ajax-router, http, php, router
- Language: PHP
- Homepage:
- Size: 85.9 KB
- Stars: 11
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/amranich/ajax-router)
[](https://github.com/AmraniCh/ajax-dispatcher/actions/workflows/tests.yml)
## Getting Started
```bash
composer require amranich/ajax-router
```
You can copy/paste this code snippet for a quick start.
We're using [Guzzle PSR-7 interface implementation](https://github.com/guzzle/psr7) here, but you can use any other library you like as long as it implements the same interface.
```php
hasHeader('X-requested-with')
|| strtolower($request->getHeader('X-requested-with')[0]) !== 'XMLHttpRequest') {
throw new BadRequestException("Accept only AJAX requests.");
}
// to organize your project, you can put your routes in a separate file like in an array
// and require it in the second parameter of the router constructor.
$router = new Router($request, 'route', [
// ?route=getPost&id=1005
Route::get('getPost', function ($params) {
// PSR7 responses are a little annoying to work with, you always have extra HTTP layers
// in your app that extend the base PSR7 response class, think of a class like JsonResponse,
// and in the constructor add the content-type header and pass it to the parent class.
$response = new Response;
$response->getBody()->write(json_encode([
'id' => $params['id'],
'title' => 'Best Places to Visit in Marrakech',
'description' => 'Example of post description',
'created_at' => '2022-02-27 03:00:05'
]));
return $response->withHeader('Content-type', 'application/json');
}),
]);
$dispatcher = new Dispatcher($router);
$dispatcher->dispatch();
} catch (Exception $ex) {
$response = new Response(
$ex->getCode() ?: 500,
['Content-type' => 'application/json'],
json_encode(['message' => $ex->getMessage()])
);
$sender = new Sender;
$sender($response);
}
```
## Usage Tips
### Route to controller/class method
If you like to put the business logic in a separate class or in a controller, you can route your requests to them like this :
```php
Route::get('getPost', [PostController::class, 'getPost']);
```
Or :
```php
Route::get('getPost', 'PostController@getPost');
// register the controller class or instance in the router
$router->registerControllers([
PostController::class,
]);
```
If the controller/class has some dependencies that must be passed within the constructor, you can still instantiate the
controller on yourself :
```php
$router->registerControllers([
new PostController($dependencyOne, $dependencyTwo)
]);
```
### Catch route actions exceptions
*I want to catch exceptions that only occurs from my routes actions, and not those thrown by the library or somewhere else, how I can
do that ?*
Answer :
```php
$dispatcher->onException(function (\Exception $ex) {
// $ex exception thrown by a route action
});
```
### Get current route
You can access the current route object using the static method `getCurrentRoute` of the `Route` class.
```php
$route = Router::getCurrentRoute();
$route->getName();
$route->getMethods();
$route->getValue();
```
## Background
The idea of the library came to my mind a long time ago when I was mostly developing web applications using just plain PHP, some of these applications were performing a lot of AJAX requests into a single PHP file, that file can have a hundred lines of code that process these requests depending on a function/method name that sent along with the request, so I started to think of what I can do to improve the way that these requests are handled, and improve the code readability and maintainability.
## Prizes
This package wins the PHP Innovation Award (February 2022) Issued by phpclasses.org
🏆 Prize :
One elePHPant mascot.
https://www.php.net/elephpant.php
📜 Certificate :
https://amranich.dev/certs/phpclasses-february-2022-innovation-award.pdf
## They support this project
