Component

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.

Instantiates and populates a component, and ensures that it is an instance of a given interface.

$config (mixed) – The component’s class name, or its config, with a type value and optionally a settings value.
$instanceOf (string, null) – The class or interface that the component must be an instance of.

yii\base\InvalidConfigException
if $config doesn’t contain a type value, 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

Extracts settings from a given component config, and returns a new config array with the settings merged in.

Returns whether a component class exists, is an instance of a given interface, and doesn't belong to a disabled plugin.

$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

yii\base\InvalidConfigException
if $config doesn’t contain a type value, 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