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.0
CP functions
Public Properties
| Property | Description |
|---|---|
| alerts | array |
| behaviors | yii\base\Behavior – List of behaviors attached to this component |
| envSuggestions | string[] |
| templateSuggestions | string[] |
alerts
- Type
- array
- Access
- Read-only
envSuggestions
- Type
- string[]
- Access
- Read-only
templateSuggestions
- Type
- string[]
- Access
- Read-only
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. |
| getAsciiCharMap() | Returns ASCII character mappings for the given language, if it differs from the application language. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getEnvSuggestions() | Returns the available environment variable and alias suggestions for inputs that support them. |
| getTemplateSuggestions() | Returns the available template path suggestions for template inputs. |
| 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()
Returns whether the CP alerts are cached.
Returns
craftIdAccount()
Returns the Craft ID account.
Returns
craftIdAccountUrl()
Returns the Craft ID account URL.
Returns
getAlerts()
Returns an array of alerts to display in the CP.
Returns
getAsciiCharMap()
- Since
- 3.1.9
Returns ASCII character mappings for the given language, if it differs from the application language.
Arguments
$language(string)
Returns
getEnvSuggestions()
- Since
- 3.1.0
Returns the available environment variable and alias suggestions for inputs that support them.
Arguments
$includeAliases(boolean) – Whether aliases should be included in the list (only enable this if the setting defines a URL or file path)
Returns
string[]
getTemplateSuggestions()
- Since
- 3.1.0
Returns the available template path suggestions for template inputs.
Returns
string[]
nav()
Returns the Control Panel nav items. Each CP nav item should be defined by an array with the following keys:
label– The human-facing nav item labelurl– The URL the nav item should link toid– The HTMLidattribute the nav item should have (optional)icon– The path to an SVG file that should be used as the nav item icon (optional)fontIcon– A character/ligature from Craft’s font icon set (optional)badgeCount– A number that should be displayed beside the nav item when unselectedsubnav– A sub-array of subnav items
Subnav arrays should be associative, with identifiable keys set to sub-arrays with the following keys:
label– The human-facing subnav item labelurl– The URL the subnav item should link to
For example:
[
'label' => 'Commerce',
'url' => 'commerce',
'subnav' => [
'orders' => ['label' => 'Orders', 'url' => 'commerce/orders',
'discounts' => ['label' => 'Discounts', 'url' => 'commerce/discounts',
],
]
Control Panel templates can specify which subnav item is selected by defining a selectedSubnavItem variable.
{% set selectedSubnavItem = 'orders' %}
Returns
Throws
settings()
Returns the list of settings.
Returns
Events
EVENT_REGISTER_CP_NAV_ITEMS
The event that is triggered when registering Control Panel nav items.
EVENT_REGISTER_CP_SETTINGS
- Type
- craft\events\RegisterCpSettingsEvent
- Since
- 3.1.0
The event that is triggered when registering Control Panel nav items.