Class yii\debug\Module
| Inheritance | yii\debug\Module » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\BootstrapInterface, yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-debug/blob/master/Module.php |
The Yii Debug Module provides the debug toolbar and debugger
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $aliases | array | List of path aliases to be defined. | yii\base\Module |
| $allowedHosts | array | The list of hosts that are allowed to access this module. | yii\debug\Module |
| $allowedIPs | array | The list of IPs that are allowed to access this module. | yii\debug\Module |
| $basePath | string | The root directory of the module. | yii\base\Module |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $components | array | The list of the component definitions or the loaded component instances (ID => definition or instance). | yii\di\ServiceLocator |
| $controllerMap | array | Mapping from controller ID to controller configurations. | yii\base\Module |
| $controllerNamespace | yii\debug\Module | ||
| $controllerPath | string | The directory that contains the controller classes. | yii\base\Module |
| $dataPath | string | The directory storing the debugger data files. | yii\debug\Module |
| $defaultRoute | string | The default route of this module. | yii\base\Module |
| $enableDebugLogs | boolean | Whether to enable message logging for the requests about debug module actions. | yii\debug\Module |
| $historySize | integer | The maximum number of debug data files to keep. | yii\debug\Module |
| $id | string | An ID that uniquely identifies this module among other modules which have the same parent. | yii\base\Module |
| $layout | string|boolean | The layout that should be applied for views within this module. | yii\base\Module |
| $layoutPath | string | The root directory of layout files. | yii\base\Module |
| $logTarget | yii\debug\LogTarget | yii\debug\Module | |
| $module | yii\base\Module | The parent module of this module. | yii\base\Module |
| $modules | array | The modules (indexed by their IDs) | yii\base\Module |
| $panels | array | List of debug panels. | yii\debug\Module |
| $params | array | Custom module parameters (name => value). | yii\base\Module |
| $uniqueId | string | The unique ID of the module. | yii\base\Module |
| $viewPath | string | The root directory of view files. | yii\base\Module |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Module |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| afterAction() | This method is invoked right after an action within this module is executed. | yii\base\Module |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeAction() | This method is invoked right before an action within this module is executed. | yii\debug\Module |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| bootstrap() | Bootstrap method to be called during application bootstrap stage. | yii\debug\Module |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| clear() | Removes the component from the locator. | yii\di\ServiceLocator |
| createController() | Creates a controller instance based on the given route. | yii\base\Module |
| createControllerByID() | Creates a controller based on the given controller ID. | yii\base\Module |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| get() | Returns the component instance with the specified ID. | yii\di\ServiceLocator |
| getBasePath() | Returns the root directory of the module. | yii\base\Module |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getComponents() | Returns the list of the component definitions or the loaded component instances. | yii\di\ServiceLocator |
| getControllerPath() | Returns the directory that contains the controller classes according to $controllerNamespace. | yii\base\Module |
| getInstance() | Returns the currently requested instance of this module class. | yii\base\Module |
| getLayoutPath() | Returns the directory that contains layout view files for this module. | yii\base\Module |
| getModule() | Retrieves the child module of the specified ID. | yii\base\Module |
| getModules() | Returns the sub-modules in this module. | yii\base\Module |
| getUniqueId() | Returns an ID that uniquely identifies this module among all modules within the current application. | yii\base\Module |
| getViewPath() | Returns the directory that contains the view files for this module. | yii\base\Module |
| getYiiLogo() | Returns Yii logo ready to use in <img src=" |
yii\debug\Module |
| has() | Returns a value indicating whether the locator has the specified component definition or has instantiated the component. | yii\di\ServiceLocator |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasModule() | Checks whether the child module of the specified ID exists. | yii\base\Module |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the module. | yii\debug\Module |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| renderToolbar() | Renders mini-toolbar at the end of page body. | yii\debug\Module |
| runAction() | Runs a controller action specified by a route. | yii\base\Module |
| set() | Registers a component definition with this locator. | yii\di\ServiceLocator |
| setAliases() | Defines path aliases. | yii\base\Module |
| setBasePath() | Sets the root directory of the module. | yii\base\Module |
| setComponents() | Registers a set of component definitions in this locator. | yii\di\ServiceLocator |
| setInstance() | Sets the currently requested instance of this module class. | yii\base\Module |
| setLayoutPath() | Sets the directory that contains the layout files. | yii\base\Module |
| setModule() | Adds a sub-module to this module. | yii\base\Module |
| setModules() | Registers sub-modules in the current module. | yii\base\Module |
| setViewPath() | Sets the directory that contains the view files. | yii\base\Module |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| checkAccess() | Checks if current user is allowed to access the module | yii\debug\Module |
| corePanels() | yii\debug\Module | |
| initPanels() | Initializes panels. | yii\debug\Module |
| resetGlobalSettings() | Resets potentially incompatible global settings done in app config. | yii\debug\Module |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_ACTION | yii\base\ActionEvent | An event raised after executing a controller action. | yii\base\Module |
| EVENT_BEFORE_ACTION | yii\base\ActionEvent | An event raised before executing a controller action. | yii\base\Module |
Property Details
The list of hosts that are allowed to access this module.
Each array element is a hostname that will be resolved to an IP address that is compared
with the IP address of the user. A use case is to use a dynamic DNS (DDNS) to allow access.
The default value is [].
The list of IPs that are allowed to access this module.
Each array element represents a single IP filter which can be either an IP address
or an address with wildcard (e.g. 192.168.0.*) to represent a network segment.
The default value is ['127.0.0.1', '::1'], which means the module can only be accessed
by localhost.
The directory storing the debugger data files. This can be specified using a path alias.
Whether to enable message logging for the requests about debug module actions. You normally do not want to keep these logs because they may distract you from the logs about your applications. You may want to enable the debug logs if you want to investigate how the debug module itself works.
The maximum number of debug data files to keep. If there are more files generated, the oldest ones will be removed.
List of debug panels. The array keys are the panel IDs, and values are the corresponding panel class names or configuration arrays. This will be merged with corePanels(). You may reconfigure a core panel via this property by using the same panel ID. You may also disable a core panel by setting it to be false in this property.
Method Details
This method is invoked right before an action within this module is executed.
The method will trigger the EVENT_BEFORE_ACTION event. The return value of the method will determine whether the action should continue to run.
In case the action should not run, the request should be handled inside of the beforeAction code
by either providing the necessary output or redirecting the request. Otherwise the response will be empty.
If you override this method, your code should look like the following:
public function beforeAction($action)
{
if (!parent::beforeAction($action)) {
return false;
}
// your custom code here
return true; // or false to not run the action
}| boolean beforeAction( $action ) | ||
| $action | yii\base\Action | The action to be executed. |
| return | boolean | Whether the action should continue to be executed. |
|---|---|---|
Bootstrap method to be called during application bootstrap stage.
| void bootstrap( $app ) | ||
| $app | yii\base\Application | The application currently running |
Checks if current user is allowed to access the module
| boolean checkAccess( ) | ||
| return | boolean | If access is granted |
|---|---|---|
| array corePanels( ) | ||
| return | array | Default set of panels |
|---|---|---|
Returns Yii logo ready to use in <img src="
| string getYiiLogo( ) | ||
| return | string | Base64 representation of the image |
|---|---|---|
Initializes the module.
This method is called after the module is created and initialized with property values given in configuration. The default implementation will initialize $controllerNamespace if it is not set.
If you override this method, please make sure you call the parent implementation.
| void init( ) |
Initializes panels.
| void initPanels( ) |
Renders mini-toolbar at the end of page body.
| void renderToolbar( $event ) | ||
| $event | yii\base\Event | |
Resets potentially incompatible global settings done in app config.
| void resetGlobalSettings( ) |