Component
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\Component
- Since
- 3.0.0
Component helper
# Public Methods
| Method | Description |
|---|---|
| createComponent() | Instantiates and populates a component, and ensures that it is an instance of a given interface. |
| 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.
Arguments
$config(mixed) – The component’s class name, or its config, with atypevalue and optionally asettingsvalue.$instanceOf(string, null) – The class or interface that the component must be an instance of.
Returns
craft\base\ComponentInterface – The component
Throws
- yii\base\InvalidConfigException
if $config doesn’t contain atypevalue, or the type isn’s compatible with|null $instanceOf. - craft\errors\MissingComponentException
if the class specified by $config doesn’t exist, or belongs to an uninstalled plugin
# mergeSettings()
Extracts settings from a given component config, and returns a new config array with the settings merged in.
Arguments
$config(array)
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.
Arguments
$class(string) – The component’s class name.$instanceOf(string, null) – The class or interface that the component must be an instance of.$throwException(boolean) – Whether an exception should be thrown if an issue is encountered
Returns
Throws
- yii\base\InvalidConfigException
if $config doesn’t contain atypevalue, or the type isn’s compatible with|null $instanceOf. - craft\errors\MissingComponentException
if the class specified by $config doesn’t exist, or belongs to an uninstalled plugin