Class craft\web\twig\variables\Cp
- Inheritance
- craft\web\twig\variables\Cp » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/web/twig/variables/Cp.php
CP functions
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
areAlertsCached() |
Returns whether the CP alerts are cached. | craft\web\twig\variables\Cp |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
craftIdAccount() |
Returns the Craft ID account. | craft\web\twig\variables\Cp |
craftIdAccountUrl() |
Returns the Craft ID account URL. | craft\web\twig\variables\Cp |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
enableCraftId() |
Returns true if Craft ID is enabled. | craft\web\twig\variables\Cp |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getAlerts() |
Returns an array of alerts to display in the CP. | craft\web\twig\variables\Cp |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
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\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() |
Initializes the object. | yii\base\BaseObject |
nav() |
Returns the Control Panel nav items. | craft\web\twig\variables\Cp |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
settings() |
Returns the list of settings. | craft\web\twig\variables\Cp |
trigger() |
Triggers an event. | yii\base\Component |
| Event | Type | Description | Defined By |
|---|---|---|---|
EVENT_REGISTER_CP_NAV_ITEMS |
craft\events\RegisterCpNavItemsEvent | The event that is triggered when registering Control Panel nav items. | craft\web\twig\variables\Cp |
Method Details
areAlertsCached()
public method
#
Returns whether the CP alerts are cached.
public boolean areAlertsCached ( )
craftIdAccount()
public method
#
Returns the Craft ID account.
public array, null craftIdAccount ( )
craftIdAccountUrl()
public method
#
Returns the Craft ID account URL.
public string craftIdAccountUrl ( )
enableCraftId()
public method
#
Returns true if Craft ID is enabled.
public string enableCraftId ( )
getAlerts()
public method
#
Returns an array of alerts to display in the CP.
public array getAlerts ( )
nav()
public method
#
Returns the Control Panel nav items.
public array nav ( )
settings()
public method
#
Returns the list of settings.
public array settings ( )Event Details
EVENT_REGISTER_CP_NAV_ITEMS
event of type craft\events\RegisterCpNavItemsEvent
#
The event that is triggered when registering Control Panel nav items.