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
cleanseConfig()	Cleanses a component config of any on X or as X keys.
createComponent()	Instantiates and populates a component, and ensures that it is an instance of a given interface.
iconSvg()	Returns an SVG icon’s contents.
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.

cleanseConfig()

Since

3.9.4

Cleanses a component config of any on X or as X keys.

View source (opens new window)

Arguments

• $config (array (opens new window))

Returns

array (opens new window)

createComponent()

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

View source (opens new window)

Arguments

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

Returns

craft\base\ComponentInterface – The component

Throws

• yii\base\InvalidConfigException (opens new window)
  if $config doesn’t contain a type 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.

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

string (opens new window)

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

array (opens new window)

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

boolean (opens new window)

Throws

• yii\base\InvalidConfigException (opens new window)
  if $config doesn’t contain a type 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