nubox/laminas-router-attributes

Use Symfony Route Attributes for Laminas Controller

1.0.0 2023-12-27 13:08 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• laminas/laminas-router: ^3.0
• symfony/config: ^6.4 || ^7.0
• symfony/http-foundation: ^6.4 || ^7.0
• symfony/routing: ^6.4 || ^7.0

Requires (Dev)

• laminas/laminas-coding-standard: ~2.5.0
• laminas/laminas-test: ^4.0
• symfony/expression-language: ^6.4 || ^7.0
• vimeo/psalm: ^5.18

Suggests

• symfony/expression-language: to use symfony conditonal routes

BSD-3-Clause

• Sebastian Hopfe

README

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!