aatis/routing

There is no license information available for the latest version (2.0.0) of this package.

Routing system of Aatis

2.0.0 2024-10-28 22:17 UTC

Requires

• php: >=8.2
• aatis/dependency-injection: ^1.5
• aatis/http-foundation: ^1.0
• aatis/template-renderer: ^1.2

Unknown License

• Maxime Batista

README

Advertisement

This package is a part of Aatis and can't be used without the following packages :

• aatis/dependency-injection (https://github.com/BatMaxou/aatis-dependency-injection)
• aatis/template-renderer (https://github.com/BatMaxou/aatis-template-renderer)
• aatis/http-foundation (https://github.com/BatMaxou/aatis-http-foundation)

Installation

composer require aatis/routing

Usage

Requirements

Add the Router service into the Container.

# In config/services.yaml file :

include_services:
  - 'Aatis\Routing\Service\Router'

You can give to this router arguments linked to your not found error page.

Aatis\Routing\Service\Router:
    arguments:
        notFoundErrorTemplate: 'path/to/your/template',
        notFoundErrorVars:
            template_var1: 404
            template_var2: "Page not found !"

Note

• notFoundErrorTemplate (default: /errors/error.tpl.php) is the path to your custom template for the 404 error page.
• notFoundErrorVars (default: []) is an array of variables that you can use in your custom template. These variables will be pass to the vars parameter of the TemplateRender.

These arguments are optional

Basic usage

The Router will handle the request and provide a response that corresponds to the route, thanks to severals controllers.

$response = $router->redirect($request);

Warning

By default, the Response provided are not prepared. You have to call the prepare method before sending the response.

Controller

A controller is a class that contains all your routes. Each must extends the abstract class AbstractController.

class AatisController extends AbstractController
{
    // ...
}

The AbstractController class provide a method render that allows you to render a template.

class AatisController extends AbstractController
{
    public function hello(): void
    {
        $this->render('template/path', [
            'template_var1' => 'Hello',
            'template_var2' => 'World !'
        ]);
    }
}

Into each controller, you have access to the Container :

class AatisController extends AbstractController
{
    public function hello(): void
    {
        $service = $this->container->get(Service::class);
    }
}

Caution

Despite its availability, this method is not recommended. Use autowiring instead (see below)

Basic Routes

You can create routes into controllers like the following :

#[Route('/hello')]
public function hello(): void
{
    // ...
}

Note

You can give multiple Route to a same controller function

Caution

You can't give the same Route to multiple controller functions

Routes with parameters

You can give parameters to your routes :

#[Route('/hello/{name}/{age}')]
public function hello(string $name, int $age): void
{
    // ...
}

You can also have access to the Request object :

#[Route('/hello/{name}/{age}')]
public function hello(Request $request, string $name, int $age): void
{
    // ...
}

Finally, you can also autowire services / interfaces / env variables like into the constructor of a service thanks to the DependencyInjection package :

#[Route('/hello/{name}/{age}')]
public function hello(Service $service, string $name, int $age, ServiceInterface $serviceImplementingInterface): void
{
    // ...
}

Route with method

You can also restrict the method of your route :

#[Route('/restricted', method: ['POST', 'DELETE'])]
public function restricted(): void
{
    // ...
}

Note

The method parameter is optional and set to empty by default (all methods are allowed)

RequestStack

To store the current Request, it is possible to put it into the RequestStack service.

$request = Request::createFromGlobals();
$requestStack = new RequestStack();

$requestStack->push($request);

With the RequestStack, the current Request is accessible from any service :

class MyService
{
    public function __construct(RequestStack $requestStack)
    {
        $this->request = $requestStack->getCurrentRequest();
    }
}

Caution

The use of the RequestStack is not recommended.