yiisoft/yii2-debug API Documentation 3.0
This is the API Documentation for the yiisoft/yii2-debug extension. Here you will find detailed information about all classes provided by this extension. 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 extension. You can use the dropdown menu on the top right to switch between versions.
| Class | Description |
|---|---|
| yii\debug\DbAsset | DB asset bundle |
| yii\debug\DebugAsset | Debugger asset bundle |
| yii\debug\FlattenException | FlattenException wraps a PHP Exception to be able to serialize it. |
| yii\debug\LogTarget | The debug LogTarget is used to store logs for later use in the debugger tool |
| yii\debug\Module | The Yii Debug Module provides the debug toolbar and debugger |
| yii\debug\Panel | Panel is a base class for debugger panel classes. It defines how data should be collected, what should be displayed at debug toolbar and on debugger details view. |
| yii\debug\TimelineAsset | Timeline asset bundle |
| yii\debug\UserswitchAsset | User switch asset bundle |
| yii\debug\actions\db\ExplainAction | ExplainAction provides EXPLAIN information for SQL queries |
| yii\debug\components\search\Filter | Provides array filtering capabilities. |
| yii\debug\components\search\matchers\Base | Base class for matchers that are used in a filter. |
| yii\debug\components\search\matchers\GreaterThan | Checks if the given value is greater than the base one. |
| yii\debug\components\search\matchers\GreaterThanOrEqual | Checks if the given value is greater than or equal the base one. |
| yii\debug\components\search\matchers\LowerThan | Checks if the given value is lower than the base one. |
| yii\debug\components\search\matchers\MatcherInterface | MatcherInterface should be implemented by all matchers that are used in a filter. |
| yii\debug\components\search\matchers\SameAs | Checks if the given value is exactly or partially same as the base one. |
| yii\debug\controllers\DefaultController | Debugger controller provides browsing over available debug logs. |
| yii\debug\controllers\UserController | User controller |
| yii\debug\models\Router | |
| yii\debug\models\UserSwitch | UserSwitch is a model used to temporary logging in another user |
| yii\debug\models\router\ActionRoutes | ActionRoutes model |
| yii\debug\models\router\CurrentRoute | CurrentRoute model |
| yii\debug\models\router\RouterRules | RouterRules model |
| yii\debug\models\search\Base | Base search model |
| yii\debug\models\search\Db | Search model for current request database queries. |
| yii\debug\models\search\Debug | Search model for requests manifest data. |
| yii\debug\models\search\Event | Event |
| yii\debug\models\search\Log | Search model for current request log. |
| yii\debug\models\search\Mail | Mail represents the model behind the search form about current send emails. |
| yii\debug\models\search\Profile | Search model for current request profiling log. |
| yii\debug\models\search\User | Search model for implementation of IdentityInterface |
| yii\debug\models\search\UserSearchInterface | UserSearchInterface is the interface that should be implemented by a class providing identity information and search method. |
| yii\debug\models\timeline\DataProvider | DataProvider implements a data provider based on a data array. |
| yii\debug\models\timeline\Search | Search model for timeline data. |
| yii\debug\models\timeline\Svg | Svg is used to draw a graph using SVG |
| yii\debug\panels\AssetPanel | Debugger panel that collects and displays asset bundles data. |
| yii\debug\panels\ConfigPanel | Debugger panel that collects and displays application configuration and environment. |
| yii\debug\panels\DbPanel | Debugger panel that collects and displays database queries performed. |
| yii\debug\panels\DumpPanel | Dump panel that collects and displays debug messages (Logger::LEVEL_TRACE). |
| yii\debug\panels\EventPanel | Debugger panel that collects and displays information about triggered events. |
| yii\debug\panels\LogPanel | Debugger panel that collects and displays logs. |
| yii\debug\panels\MailPanel | Debugger panel that collects and displays the generated emails. |
| yii\debug\panels\ProfilingPanel | Debugger panel that collects and displays performance profiling info. |
| yii\debug\panels\RequestPanel | Debugger panel that collects and displays request data. |
| yii\debug\panels\RouterPanel | RouterPanel provides a panel which displays information about routing process. |
| yii\debug\panels\TimelinePanel | Debugger panel that collects and displays timeline data. |
| yii\debug\panels\UserPanel | Debugger panel that collects and displays user data. |
| yii\debug\widgets\NavigationButton | Render button for navigation to previous or next request in debug panel |