Component
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\Component
- Since
- 3.0.0
Component helper
View source (opens new window)
# Public Methods
Method | Description |
---|---|
createComponent() | Instantiates and populates a component, and ensures that it is an instance of a given interface. |
iconSvg() | Returns an SVG icon’s contents, namespaced and with aria-hidden="true" added to it. |
mergeSettings() | Extracts settings from a given component config, and returns a new config array with the settings merged in. |
validateComponentClass() | Returns whether a component class exists, is an instance of a given interface, and doesn't belong to a disabled plugin. |
# createComponent()
Instantiates and populates a component, and ensures that it is an instance of a given interface.
View source (opens new window)
Arguments
$config
(string (opens new window), array (opens new window)) – The component’s class name, or its config, with atype
value and optionally asettings
value.$instanceOf
(string (opens new window), null (opens new window)) – The class or interface that the component must be an instance of.
Returns
\craft\helpers\T
– The component
Throws
- yii\base\InvalidConfigException (opens new window)
if $config doesn’t contain atype
value, or the type isn’t compatible with|null $instanceOf. - craft\errors\MissingComponentException
if the class specified by $config doesn’t exist, or belongs to an uninstalled plugin
# iconSvg()
- Since
- 3.5.0
Returns an SVG icon’s contents, namespaced and with aria-hidden="true"
added to it.
View source (opens new window)
Arguments
$icon
(string (opens new window), null (opens new window)) – The path to the SVG icon, or the actual SVG contents$label
(string (opens new window)) – The label of the component
Returns
# mergeSettings()
Extracts settings from a given component config, and returns a new config array with the settings merged in.
View source (opens new window)
Arguments
$config
(array (opens new window))
Returns
# validateComponentClass()
- Since
- 3.2.0
Returns whether a component class exists, is an instance of a given interface, and doesn't belong to a disabled plugin.
View source (opens new window)
Arguments
$class
(string (opens new window)) – The component’s class name.$instanceOf
(string (opens new window), null (opens new window)) – The class or interface that the component must be an instance of.$throwException
(boolean (opens new window)) – Whether an exception should be thrown if an issue is encountered
Returns
Throws
- yii\base\InvalidConfigException (opens new window)
if $config doesn’t contain atype
value, or the type isn’t compatible with|null $instanceOf. - craft\errors\MissingComponentException
if the class specified by $config doesn’t exist, or belongs to an uninstalled plugin