Interface Yiisoft\Router\RouteCollectorInterface
| Implemented by | Yiisoft\Router\RouteCollector |
|---|
Public 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
Add a route or a group of routes.
| public abstract addRoute( Yiisoft\Router\Route|Yiisoft\Router\Group $routes ): self | ||
| $routes | Yiisoft\Router\Route|Yiisoft\Router\Group | |
public function addRoute(Route|Group ...$routes): self;
| public abstract getItems( ): Yiisoft\Router\Group[]|Yiisoft\Router\Route[] |
public function getItems(): array;
| public abstract getMiddlewareDefinitions( ): array[]|callable[]|string[] |
public function getMiddlewareDefinitions(): array;
Appends a handler middleware definition that should be invoked for a matched route.
First added handler will be executed first.
| public abstract middleware( array|callable|string $middlewareDefinition ): self | ||
| $middlewareDefinition | array|callable|string | |
public function middleware(array|callable|string ...$middlewareDefinition): self;
Prepends a handler middleware definition that should be invoked for a matched route.
First added handler will be executed last.
| public abstract prependMiddleware( array|callable|string $middlewareDefinition ): self | ||
| $middlewareDefinition | array|callable|string | |
public function prependMiddleware(array|callable|string ...$middlewareDefinition): self;
Signup or Login in order to comment.