nusphere / laminas-router-attributes

Using Symfony Route Attributes in Laminas Action Controller

This guide will walk you through on how to use Symfony Route Attributes in Laminas Action Controller in PHP 8.1.

Requirements

• PHP 8.1 or higher

Installation

Install the required packages via composer.

composer require nubox/laminas-router-attributes

Activate Plugin in our Laminas Application

return [
    // Retrieve list of modules used in this application.
    'modules' => [
        ...,
        \Laminas\Router\Attributes\Module::class, // or 'Laminas\Router\Attributes'
    ],
    ...
];

Usage

You can start by creating a new action controller which we will annotate with Symfony's Route attributes instead of the laminas configuration.

<?php 

namespace Module\Controller; 

use Laminas\Mvc\Controller\AbstractActionController;
use Symfony\Component\Routing\Attribute\Route;

class MyController extends AbstractActionController 
{ 
    #[Route('/my-path', name: 'my_route_name')] 
    public function myAction() { 
        //Your action code goes here...
    }
}

In the example above, #[Route('/my-path', name: 'my_route_name')] defines the path for the action and names the route.

That's all! You have successfully configured Symfony Route Attributes in your Laminas Action Controller.

Supported behavior from Symfony routes

• configuration via Attributes
  • path -> domain route for methods or classes
  • name -> set up a name for the route
  • condition -> for more complex conditions about your route (require symfony/expression-language)
  • methods -> restrict the route to an explicit method
  • requirments -> Parameters Validation via RegExp
  • inline-defaults -> Inline default-settings (in combination with conditions, also)
  • defaults -> add default settings

Troubleshooting

If you run into any issue while trying to use Symfony Route attributes in your Laminas Action Controller, please refer to the respective Symfony and Laminas documentation.

• Symfony Documentation: https://symfony.com/doc/current/routing.html
• Laminas Documentation: https://docs.laminas.dev/laminas-mvc/

Should you encounter issues that are not documented, kindly log them in our issues tracker.

Happy Coding!

laminas-router-attributes's Issues

Console Commands for Routing

Feature Request

same behavior for laminas routing like symfony console commands

Q	A
New Feature	yes

Summary

Provide following laminas commands:

• php vendor/bin/laminas debug:router
• php vendor/bin/laminas router:match

@see https://symfony.com/doc/current/routing.html#debugging-routes

Wildcard Route for Wildcard Actions

Feature Request

In Laminas it is possible to set the action route variable, which acts as a "catch-all" route for the method in the controller.

Q	A
New Feature	yes

Summary

The following controller is given:

<?php 

namespace Module\Controller; 

use Laminas\Mvc\Controller\AbstractActionController;
use Symfony\Component\Routing\Attribute\Route;

#[Route('/api/{action}', name: 'my_wildcard_route')] 
class MyController extends AbstractActionController 
{
    public function myAction() { 
        //Your action code goes here...
    }

    public function userListAction() { 
        //Your action code goes here...
    }
}

• a route call /api/my should call MyController::myAction
• following route calls should call MyController::myAction:
  • /api/userList
  • /api/userlist
  • /api/user-list
  • /api/user_list

Allow symfony/http-foundation ^5.0

Feature Request

Q	A
New Feature	yes

Summary

For backward comp. symfony/http-foundation ^5.0 should be supported

Implement UrlGeneratorInterface as Service

Feature Request

Provide a service for generating a route by its route-name

Q	A
New Feature	yes

Summary

// src/Service/SomeService.php
namespace App\Service;

use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

class SomeService
{
    public function __construct(
        private UrlGeneratorInterface $router,
    ) {
    }

    public function someMethod(): void
    {
        // ...

        // generate a URL with no route arguments
        $signUpPage = $this->router->generate('sign_up');

        // generate a URL with route arguments
        $userProfilePage = $this->router->generate('user_profile', [
            'username' => $user->getUserIdentifier(),
        ]);

        // generated URLs are "absolute paths" by default. Pass a third optional
        // argument to generate different URLs (e.g. an "absolute URL")
        $signUpPage = $this->router->generate('sign_up', [], UrlGeneratorInterface::ABSOLUTE_URL);

        // when a route is localized, Symfony uses by default the current request locale
        // pass a different '_locale' value if you want to set the locale explicitly
        $signUpPageInDutch = $this->router->generate('sign_up', ['_locale' => 'nl']);
    }
}

https://symfony.com/doc/current/routing.html#generating-urls-in-services