0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/router -H 'Accept: application/json'

Class Description
Yiisoft\Router\CurrentRoute Holds information about current route e.g. matched last.
Yiisoft\Router\Debug\DebugRoutesCommand
Yiisoft\Router\Debug\RouterCollector
Yiisoft\Router\Debug\UrlMatcherInterfaceProxy
Yiisoft\Router\Group
Yiisoft\Router\HydratorAttribute\RouteArgument
Yiisoft\Router\HydratorAttribute\RouteArgumentResolver
Yiisoft\Router\Internal\MiddlewareFilter
Yiisoft\Router\MatchingResult
Yiisoft\Router\Middleware\Router
Yiisoft\Router\Route Route defines a mapping from URL to callback / name and vice versa.
Yiisoft\Router\RouteCollection
Yiisoft\Router\RouteCollectionInterface
Yiisoft\Router\RouteCollector
Yiisoft\Router\RouteCollectorInterface
Yiisoft\Router\RouteNotFoundException
Yiisoft\Router\UrlGeneratorInterface UrlGeneratorInterface allows generating URL given route name, arguments, and query parameters.
Yiisoft\Router\UrlMatcherInterface UrlMatcherInterface allows finding a matching route given a PSR-8 server request. It is preferred to type-hint against it in case you need to match URL.