0 follower

Interface Yiisoft\Router\RouteCollectorInterface

Implemented byYiisoft\Router\RouteCollector

Public Methods

Hide inherited methods

Method Description Defined By
addRoute() Add a route or a group of routes. Yiisoft\Router\RouteCollectorInterface
getItems() Yiisoft\Router\RouteCollectorInterface
getMiddlewareDefinitions() Yiisoft\Router\RouteCollectorInterface
middleware() Appends a handler middleware definition that should be invoked for a matched route. Yiisoft\Router\RouteCollectorInterface
prependMiddleware() Prepends a handler middleware definition that should be invoked for a matched route. Yiisoft\Router\RouteCollectorInterface

Method Details

Hide inherited methods

addRoute() public abstract method

Add a route or a group of routes.

public abstract self addRoute ( Yiisoft\Router\Route|Yiisoft\Router\Group $routes )
$routes Yiisoft\Router\Route|Yiisoft\Router\Group

                public function addRoute(Route|Group ...$routes): self;

            
getItems() public abstract method

public abstract Yiisoft\Router\Group[]|Yiisoft\Router\Route[] getItems ( )

                public function getItems(): array;

            
getMiddlewareDefinitions() public abstract method

public abstract array[]|callable[]|string[] getMiddlewareDefinitions ( )

                public function getMiddlewareDefinitions(): array;

            
middleware() public abstract method

Appends a handler middleware definition that should be invoked for a matched route.

First added handler will be executed first.

public abstract self middleware ( array|callable|string $middlewareDefinition )
$middlewareDefinition array|callable|string

                public function middleware(array|callable|string ...$middlewareDefinition): self;

            
prependMiddleware() public abstract method

Prepends a handler middleware definition that should be invoked for a matched route.

First added handler will be executed last.

public abstract self prependMiddleware ( array|callable|string $middlewareDefinition )
$middlewareDefinition array|callable|string

                public function prependMiddleware(array|callable|string ...$middlewareDefinition): self;