PHP
Twig

Component

Type: Class
Namespace: craft\helpers
Inherits: craft\helpers\Component
Since: 3.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.

`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 a type value and optionally a settings value.
$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 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

`mergeSettings()`

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

Arguments

$config (array)

Returns

← Assets ConfigHelper →