Module
- Type
- Class
- Namespace
- craft\debug
- Inherits
- craft\debug\Module » yii\debug\Module (opens new window) » yii\base\Module (opens new window) » yii\di\ServiceLocator (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\BootstrapInterface (opens new window), yii\base\Configurable (opens new window)
- Since
- 3.0.0
The Yii Debug Module provides the debug toolbar and debugger
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| aliases (opens new window) | array (opens new window) – List of path aliases to be defined. |
| allowedHosts (opens new window) | array (opens new window) – The list of hosts that are allowed to access this module. |
| allowedIPs (opens new window) | array (opens new window) – The list of IPs that are allowed to access this module. |
| basePath (opens new window) | string (opens new window) – The root directory of the module. |
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| checkAccessCallback (opens new window) | callable (opens new window) – A valid PHP callback that returns true if user is allowed to use web shell and false otherwise The signature is the following: function (Action |
| components (opens new window) | array (opens new window) – The list of the component definitions or the loaded component instances (ID => definition or instance). |
| controllerMap (opens new window) | array (opens new window) – Mapping from controller ID to controller configurations. |
| controllerNamespace (opens new window) | string (opens new window), null (opens new window) – The namespace that controller classes are in. |
| controllerPath (opens new window) | string (opens new window) – The directory that contains the controller classes. |
| dataPath (opens new window) | string (opens new window) – The directory storing the debugger data files. |
| debugHeaders (opens new window) | yii\base\Event (opens new window) |
| defaultHeight (opens new window) | integer (opens new window) – The debug bar default height, as a percentage of the total screen height |
| defaultPanel (opens new window) | string (opens new window) – The name of the panel that should be visible when opening the debug panel. |
| defaultRoute (opens new window) | string (opens new window) – The default route of this module. |
| dirMode (opens new window) | integer (opens new window) – The permission to be set for newly created directories. |
| disableCallbackRestrictionWarning (opens new window) | boolean (opens new window) – Whether to disable access callback restriction warning triggered by checkAccess function |
| disableIpRestrictionWarning (opens new window) | boolean (opens new window) – Whether to disable IP address restriction warning triggered by checkAccess function |
| enableDebugLogs (opens new window) | boolean (opens new window) – Whether to enable message logging for the requests about debug module actions. |
| fileMode (opens new window) | integer (opens new window) – The permission to be set for newly created debugger data files. |
| fs | craft\base\FsInterface, null (opens new window) – The filesystem that debug cache files should be stored in. |
| historySize (opens new window) | integer (opens new window) – The maximum number of debug data files to keep. |
| id (opens new window) | string (opens new window) – An ID that uniquely identifies this module among other modules which have the same parent (opens new window). |
| layout (opens new window) | string (opens new window), boolean (opens new window), null (opens new window) – The layout that should be applied for views within this module. |
| layoutPath (opens new window) | string (opens new window) – The root directory of layout files. |
| logTarget (opens new window) | yii\debug\LogTarget (opens new window), array (opens new window), string (opens new window) – The logTarget object, or the configuration for creating the logTarget object. |
| module (opens new window) | yii\base\Module (opens new window), null (opens new window) – The parent module of this module. |
| modules (opens new window) | array (opens new window) – The modules (indexed by their IDs). |
| pageTitle (opens new window) | string (opens new window), callable (opens new window) – Page title could be a string or a callable function php ... 'pageTitle' => 'Custom Debug Title', ... // OR 'pageTitle' => function($url) { $domain = getDomain($url); return $domain . ' debugger'; } |
| panels (opens new window) | array (opens new window), yii\debug\Panel (opens new window) – List of debug panels. |
| params (opens new window) | array (opens new window) – Custom module parameters (name => value). |
| skipAjaxRequestUrl (opens new window) | array (opens new window) – Routes of AJAX requests to skip from being displayed in toolbar |
| toolbarHtml (opens new window) | |
| traceLine (opens new window) | mixed – The string with placeholders to be be substituted or an anonymous function that returns the trace line string. |
| tracePathMappings (opens new window) | array (opens new window) – Used when the virtual, containerized, or remote debug trace paths don't correspond to the developers local paths. |
| uniqueId (opens new window) | string (opens new window) – The unique ID of the module. |
| urlRuleClass (opens new window) | string (opens new window) – The \yii\debug\UrlRule class to use for rules generated by this module. |
| version (opens new window) | string (opens new window) – The version of this module. |
| viewPath (opens new window) | string (opens new window) – The root directory of view files. |
# fs
- Type
- craft\base\FsInterface, null (opens new window)
- Default value
null- Since
- 4.0.0
The filesystem that debug cache files should be stored in.
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Getter magic method. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| afterAction() (opens new window) | This method is invoked right after an action within this module is executed. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| beforeAction() (opens new window) | This method is invoked right before an action within this module is executed. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| bootstrap() | Bootstrap method to be called during application bootstrap stage. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| clear() (opens new window) | Removes the component from the locator. |
| createController() (opens new window) | Creates a controller instance based on the given route. |
| createControllerByID() (opens new window) | Creates a controller based on the given controller ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| get() (opens new window) | Returns the component instance with the specified ID. |
| getBasePath() (opens new window) | Returns the root directory of the module. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getComponents() (opens new window) | Returns the list of the component definitions or the loaded component instances. |
| getControllerPath() (opens new window) | Returns the directory that contains the controller classes according to controllerNamespace (opens new window). |
| getInstance() (opens new window) | Returns the currently requested instance of this module class. |
| getLayoutPath() (opens new window) | Returns the directory that contains layout view files for this module. |
| getModule() (opens new window) | Retrieves the child module of the specified ID. |
| getModules() (opens new window) | Returns the sub-modules in this module. |
| getToolbarHtml() (opens new window) | Gets toolbar HTML |
| getUniqueId() (opens new window) | Returns an ID that uniquely identifies this module among all modules within the current application. |
| getVersion() (opens new window) | Returns current module version. |
| getViewPath() (opens new window) | Returns the directory that contains the view files for this module. |
| getYiiLogo() (opens new window) | Returns the logo URL to be used in <img src=" |
| has() (opens new window) | Returns a value indicating whether the locator has the specified component definition or has instantiated the component. |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasModule() (opens new window) | Checks whether the child module of the specified ID exists. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| htmlTitle() (opens new window) | |
| init() (opens new window) | Initializes the module. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| renderToolbar() | Renders mini-toolbar at the end of page body. |
| runAction() (opens new window) | Runs a controller action specified by a route. |
| set() (opens new window) | Registers a component definition with this locator. |
| setAliases() (opens new window) | Defines path aliases. |
| setBasePath() (opens new window) | Sets the root directory of the module. |
| setComponents() (opens new window) | Registers a set of component definitions in this locator. |
| setControllerPath() (opens new window) | Sets the directory that contains the controller classes. |
| setDebugHeaders() (opens new window) | Setting headers to transfer debug data in AJAX requests without interfering with the request itself. |
| setInstance() (opens new window) | Sets the currently requested instance of this module class. |
| setLayoutPath() (opens new window) | Sets the directory that contains the layout files. |
| setModule() (opens new window) | Adds a sub-module to this module. |
| setModules() (opens new window) | Registers sub-modules in the current module. |
| setVersion() (opens new window) | Sets current module version. |
| setViewPath() (opens new window) | Sets the directory that contains the view files. |
| setYiiLogo() (opens new window) | Sets the logo URL to be used in <img src=" |
| trigger() (opens new window) | Triggers an event. |
# bootstrap()
Bootstrap method to be called during application bootstrap stage.
View source (opens new window)
Arguments
$app(yii\base\Application (opens new window)) – The application currently running
# renderToolbar()
Renders mini-toolbar at the end of page body.
View source (opens new window)
Arguments
$event(yii\base\Event (opens new window))
Throws
# Protected Methods
| Method | Description |
|---|---|
| checkAccess() (opens new window) | Checks if current user is allowed to access the module |
| corePanels() (opens new window) | |
| defaultVersion() (opens new window) | Returns default module version. |
| initPanels() (opens new window) | Initializes panels. |
| resetGlobalSettings() (opens new window) | Resets potentially incompatible global settings done in app config. |
# Constants
| Constant | Description |
|---|---|
DEFAULT_IDE_TRACELINE |