Class yii\debug\controllers\DefaultController

All Classes | Properties | Methods | Events

Inheritance	yii\debug\controllers\DefaultController » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-debug/blob/master/controllers/DefaultController.php

Debugger controller

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$action	yii\base\Action	The action that is currently being executed.	yii\base\Controller
$actionParams	array	The parameters bound to the current action.	yii\web\Controller
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$defaultAction	string	The ID of the action that is used when the action ID is not specified in the request.	yii\base\Controller
$enableCsrfValidation	boolean	Whether to enable CSRF validation for the actions in this controller.	yii\web\Controller
$id	string	The ID of this controller.	yii\base\Controller
$layout	null\|string\|false	The name of the layout to be applied to this controller's views.	yii\debug\controllers\DefaultController
$module	yii\debug\Module		yii\debug\controllers\DefaultController
$modules	yii\base\Module[]	All ancestor modules that this controller is located within.	yii\base\Controller
$route	string	The route (module ID, controller ID and action ID) of the current request.	yii\base\Controller
$summary	array	The summary data (e.g. URL, time)	yii\debug\controllers\DefaultController
$uniqueId	string	The controller ID that is prefixed with the module ID (if any).	yii\base\Controller
$view	yii\base\View\|yii\web\View	The view object that can be used to render views or view files.	yii\base\Controller
$viewPath	string	The directory containing the view files for this controller.	yii\base\Controller

Public Methods

Hide inherited 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()		yii\base\Controller
__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
actionDownloadMail()		yii\debug\controllers\DefaultController
actionIndex()		yii\debug\controllers\DefaultController
actionToolbar()		yii\debug\controllers\DefaultController
actionView()		yii\debug\controllers\DefaultController
actions()	Declares external actions for the controller.	yii\debug\controllers\DefaultController
afterAction()	This method is invoked right after an action is executed.	yii\base\Controller
asJson()	Send data formatted as JSON.	yii\web\Controller
asXml()	Send data formatted as XML.	yii\web\Controller
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeAction()		yii\debug\controllers\DefaultController
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
bindActionParams()	Binds the parameters to the action.	yii\web\Controller
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
createAction()	Creates an action based on the given action ID.	yii\base\Controller
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
findLayoutFile()	Finds the applicable layout file.	yii\base\Controller
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getModules()	Returns all ancestor modules of this controller.	yii\base\Controller
getRoute()	Returns the route of the current request.	yii\base\Controller
getUniqueId()	Returns the unique ID of the controller.	yii\base\Controller
getView()	Returns the view object that can be used to render views or view files.	yii\base\Controller
getViewPath()	Returns the directory containing view files for this controller.	yii\base\Controller
goBack()	Redirects the browser to the last visited page.	yii\web\Controller
goHome()	Redirects the browser to the home page.	yii\web\Controller
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
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\base\Object
loadData()		yii\debug\controllers\DefaultController
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
redirect()	Redirects the browser to the specified URL.	yii\web\Controller
refresh()	Refreshes the current page.	yii\web\Controller
render()	Renders a view and applies layout if available.	yii\base\Controller
renderAjax()	Renders a view in response to an AJAX request.	yii\web\Controller
renderContent()	Renders a static string by applying a layout.	yii\base\Controller
renderFile()	Renders a view file.	yii\base\Controller
renderPartial()	Renders a view without applying layout.	yii\base\Controller
run()	Runs a request specified in terms of a route.	yii\base\Controller
runAction()	Runs an action within this controller with the specified action ID and parameters.	yii\base\Controller
setView()	Sets the view object to be used by this controller.	yii\base\Controller
setViewPath()	Sets the directory that contains the view files.	yii\base\Controller
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
getManifest()		yii\debug\controllers\DefaultController

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_ACTION	yii\base\ActionEvent	An event raised right after executing a controller action.	yii\base\Controller
EVENT_BEFORE_ACTION	yii\base\ActionEvent	An event raised right before executing a controller action.	yii\base\Controller

Property Details

$layout public property

The name of the layout to be applied to this controller's views. This property mainly affects the behavior of render(). Defaults to null, meaning the actual layout value should inherit that from $module's layout value. If false, no layout will be applied.

public null|string|false $layout = 'main'

$module public property

public yii\debug\Module $module = null

$summary public property

The summary data (e.g. URL, time)

public array $summary = null

Method Details

actionDownloadMail() public method

public void actionDownloadMail ( $file )
$file

actionIndex() public method

public void actionIndex ( )

actionToolbar() public method

public void actionToolbar ( $tag )
$tag

actionView() public method

public void actionView ( $tag = null, $panel = null )
$tag
$panel

actions() public method

Declares external actions for the controller.

This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() will be used later to create the requested action using the configuration provided here.

public void actions ( )

beforeAction() public method

public void beforeAction ( $action )
$action

getManifest() protected method

protected void getManifest ( $forceReload = false )
$forceReload

loadData() public method

public void loadData ( $tag, $maxRetry = 0 )
$tag
$maxRetry