Cp
- Type
- Class
- Namespace
- craft\web\twig\variables
- Inherits
- craft\web\twig\variables\Cp » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0
CP functions
Public Properties
| Property | Description |
|---|---|
| $alerts | array |
| $behaviors | yii\base\Behavior – List of behaviors attached to this component |
$alerts
- Type
- array
- Access
- Read-only
Signature
public array getAlerts ( )
Public Methods
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of an object property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets value of an object property. |
| __unset() | Sets an object property to null. |
| areAlertsCached() | Returns whether the CP alerts are cached. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| craftIdAccount() | Returns the Craft ID account. |
| craftIdAccountUrl() | Returns the Craft ID account URL. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getAlerts() | Returns an array of alerts to display in the CP. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
| nav() | Returns the Control Panel nav items. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| settings() | Returns the list of settings. |
| trigger() | Triggers an event. |
areAlertsCached()
Signature
public boolean areAlertsCached ( )
craftIdAccount()
Signature
public array, null craftIdAccount ( )
craftIdAccountUrl()
Signature
public string craftIdAccountUrl ( )
getAlerts()
Signature
public array getAlerts ( )
nav()
Signature
public array nav ( )
settings()
Signature
public array settings ( )
Events
EVENT_REGISTER_CP_NAV_ITEMS
The event that is triggered when registering Control Panel nav items.