brandembassy/php-router

1.2.1 2023-12-06 14:46 UTC

Requires

• php: >=7.4
• psr/http-message: ^1.0

Requires (Dev)

• brandembassy/coding-standard: ^8.6
• mockery/mockery: ^1.2
• nette/di: ^2.4 || ^3.0
• phpunit/phpunit: ^8
• roave/security-advisories: dev-master
• slim/slim: ^3.12

Suggests

• nette/di: Allows usage of Router in Nette DI container.
• slim/slim: Allows usage of slim-router.

MIT

README

Router interface for interoperability between Brand Embassy libraries and services.

Install

composer require brandembassy/php-router

Usage

Two interfaces:

1. RouteDispatcher for dispatching PSR request.
2. UrlGenerator for generating URLs for links in application.

Bridges

Slim Framework with NetteDI

First in your parameters in .neon config file you need to specify routes. Structure is demonstrated by following example:

parameters:
    app:
        routes:
            backOffice: # namespace, just for organization no semantic meaning
                "/back-office/brand/{brandId}/create-user":
                    "get|post": # you can specify multiple HTTP methods
                        name: backOfficeCreateUserInBrand # Name is mandatory and is used as identifier
                        service: BrandEmbassy/App/BackOffice/User/CreateUserInBrandActoon # This service must be callable (must have __invoke() method)

Then in your services.neon you just register services:

urlGenerator:
        class: BrandEmbassy\Router\UrlGenerator
        factory: BrandEmbassy\Router\Bridge\Slim\SlimRouterNetteDiFactory::create(..., %app.routes%)

routeDispatcher:
    class: BrandEmbassy\Router\RouteDispatcher
    factory: BrandEmbassy\Router\Bridge\Slim\SlimRouterNetteDiFactory::create(..., %app.routes%)