Component

API reference › yii › base › Component

class	yii\base\Component
Extends	BaseObject
Implements	Configurable
Since	2.0
Source	framework/base/Component.php

48 subclasses

• Action
• Controller
• ErrorHandler
• Model
• Request
• Response
• Security
• Theme
• View
• ViewRenderer
• Widget
• yii\caching\Cache
• yii\data\BaseDataProvider
• yii\db\BatchQueryResult
• yii\db\Command
• yii\db\Connection
• yii\db\Migration
• yii\db\Query
• yii\db\SqlTokenizer
• yii\di\Container
• yii\di\ServiceLocator
• yii\filters\AccessRule
• yii\i18n\Formatter
• yii\i18n\GettextFile
• yii\i18n\I18N
• yii\i18n\Locale
• yii\i18n\MessageFormatter
• yii\i18n\MessageSource
• yii\log\Dispatcher
• yii\log\Logger
• yii\log\Target
• yii\mail\BaseMailer
• yii\mutex\Mutex
• yii\rbac\BaseManager
• yii\rest\Serializer
• yii\test\Fixture
• yii\validators\Validator
• yii\web\AssetConverter
• yii\web\AssetManager
• yii\web\HtmlResponseFormatter
• yii\web\JsonResponseFormatter
• yii\web\Session
• yii\web\UrlManager
• yii\web\User
• yii\web\XmlResponseFormatter
• yii\widgets\ActiveField
• yii\debug\Panel
• yii\inertia\Manager

Component is the base class that implements the property, event and behavior features.

Component provides the event and behavior features, in addition to the property feature which is implemented in its parent class BaseObject.

Event is a way to “inject” custom code into existing code at certain places. For example, a comment object can trigger an “add” event when the user adds a comment. We can write custom code and attach it to this event so that when the event is triggered (i.e. comment will be added), our custom code will be executed.

An event is identified by a name that should be unique within the class it is defined at. Event names are case-sensitive.

One or multiple PHP callbacks, called event handlers, can be attached to an event. You can call trigger() to raise an event. When an event is raised, the event handlers will be invoked automatically in the order they were attached.

To attach an event handler to an event, call on():

$post->on('update', function ($event) {
    // send email notification
});

In the above, an anonymous function is attached to the “update” event of the post. You may attach the following types of event handlers:

• anonymous function: function ($event) { ... }
• object method: [$object, 'handleAdd']
• static class method: ['Page', 'handleAdd']
• global function: 'handleAdd'

The signature of an event handler should be like the following:

function foo($event)

where $event is an Event object which includes parameters associated with the event.

You can also attach a handler to an event when configuring a component with a configuration array. The syntax is like the following:

[
    'on add' => function ($event) { ... }
]

where on add stands for attaching an event to the add event.

Sometimes, you may want to associate extra data with an event handler when you attach it to an event and then access it when the handler is invoked. You may do so by

$post->on('update', function ($event) {
    // the data can be accessed via $event->data
}, $data);

A behavior is an instance of Behavior or its child class. A component can be attached with one or multiple behaviors. When a behavior is attached to a component, its public properties and methods can be accessed via the component directly, as if the component owns those properties and methods.

To attach a behavior to a component, declare it in behaviors(), or explicitly call attachBehavior(). Behaviors declared in behaviors() are automatically attached to the corresponding component.

One can also attach a behavior to a component when configuring it with a configuration array. The syntax is like the following:

[
    'as tree' => [
        'class' => 'Tree',
    ],
]

where as tree stands for attaching a behavior named tree, and the array will be passed to Yii::createObject() to create the behavior object.

For more details and usage information on Component, see the guide article on components.

Properties

Property	Type	Description	Defined by
$behaviors read-only	array<Behavior<static>>	List of behaviors attached to this component.	Component

Methods

Method	Description	Defined by
__construct()	Constructor.	BaseObject
__call()	Calls the named method which is not a class method.	Component
__clone()	This method is called after the object is created by cloning an existing one.	Component
__get()	Returns the value of a component property.	Component
__isset()	Checks if a property is set, i.e. defined and not null.	Component
__set()	Sets the value of a component property.	Component
__unset()	Sets a component property to be null.	Component
attachBehavior()	Attaches a behavior to this component.	Component
attachBehaviors()	Attaches a list of behaviors to the component.	Component
behaviors()	Returns a list of behaviors that this component should behave as.	Component
canGetProperty()	Returns a value indicating whether a property can be read.	Component
canSetProperty()	Returns a value indicating whether a property can be set.	Component
className() static	Returns the fully qualified name of this class.	BaseObject
detachBehavior()	Detaches a behavior from the component.	Component
detachBehaviors()	Detaches all behaviors from the component.	Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	Component
getBehavior()	Returns the named behavior object.	Component
getBehaviors()	Returns all behaviors attached to this component.	Component
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	Component
hasMethod()	Returns a value indicating whether a method is defined.	Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	Component
init()	Initializes the object.	BaseObject
off()	Detaches an existing event handler from this component.	Component
on()	Attaches an event handler to an event.	Component
trigger()	Triggers an event.	Component

Method details

__call()

public function __call(string $name, array $params): mixed

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

Parameter	Type	Description
$name	string	The method name
$params	array	Method parameters

Returns

mixed: The method return value

Throws

• UnknownMethodException: when calling unknown method

__clone()

public function __clone(): mixed

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

Returns

mixed

__get()

public function __get(string $name): mixed

Returns the value of a component property.

This method will check in the following order and act accordingly:

• a property defined by a getter: return the getter result
• a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

Parameter	Type	Description
$name	string	The property name

Returns

mixed: The property value or the value of a behavior’s property

Throws

• UnknownPropertyException: if the property is not defined
• InvalidCallException: if the property is write-only.

See also

• __set()

__isset()

public function __isset(string $name): bool

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

• a property defined by a setter: return whether the property is set
• a property of a behavior: return whether the property is set
• return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

Parameter	Type	Description
$name	string	The property name or the event name

Returns

bool: Whether the named property is set

See also

• https://www.php.net/manual/en/function.isset.php

__set()

public function __set(string $name, mixed $value): mixed

Sets the value of a component property.

This method will check in the following order and act accordingly:

• a property defined by a setter: set the property value
• an event in the format of “on xyz”: attach the handler to the event “xyz”
• a behavior in the format of “as xyz”: attach the behavior named as “xyz”
• a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

Parameter	Type	Description
$name	string	The property name or the event name
$value	mixed	The property value

Returns

mixed

Throws

• UnknownPropertyException: if the property is not defined
• InvalidCallException: if the property is read-only.

See also

• __get()

__unset()

public function __unset(string $name): mixed

Sets a component property to be null.

This method will check in the following order and act accordingly:

• a property defined by a setter: set the property value to be null
• a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

Parameter	Type	Description
$name	string	The property name

Returns

mixed

Throws

• InvalidCallException: if the property is read only.

See also

• https://www.php.net/manual/en/function.unset.php

attachBehavior()

public function attachBehavior(string $name, string|array|yii\base\Behavior $behavior): yii\base\Behavior<static>

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the Behavior::attach() method.

Parameters

Parameter	Type	Description
$name	string	The name of the behavior.
$behavior	string|array|Behavior	The behavior configuration. This can be one of the following: - a Behavior object - a string specifying the behavior class - an object configuration array that will be passed to Yii::createObject() to create the behavior object.

Returns

Behavior<static>: The behavior object

See also

• detachBehavior()

attachBehaviors()

public function attachBehaviors(array $behaviors): mixed

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

Parameter	Type	Description
$behaviors	array	List of behaviors to be attached to the component

Returns

mixed

See also

• attachBehavior()

behaviors()

public function behaviors(): array<array-key, class-string|array{class: class-string}|yii\base\Behavior>

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Returns

array<array-key, class-string|array{class: class-string}|Behavior>: The behavior configurations.

canGetProperty()

public function canGetProperty(string $name, bool $checkVars = true, bool $checkBehaviors = true): bool

Returns a value indicating whether a property can be read.

A property can be read if:

• the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
• the class has a member variable with the specified name (when $checkVars is true);
• an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

Parameter	Type	Description
$name	string	The property name
$checkVars	bool	Whether to treat member variables as properties
$checkBehaviors	bool	Whether to treat behaviors’ properties as properties of this component

Returns

bool: Whether the property can be read

See also

• canSetProperty()

canSetProperty()

public function canSetProperty(string $name, bool $checkVars = true, bool $checkBehaviors = true): bool

Returns a value indicating whether a property can be set.

A property can be written if:

• the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
• the class has a member variable with the specified name (when $checkVars is true);
• an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

Parameter	Type	Description
$name	string	The property name
$checkVars	bool	Whether to treat member variables as properties
$checkBehaviors	bool	Whether to treat behaviors’ properties as properties of this component

Returns

bool: Whether the property can be written

See also

• canGetProperty()

detachBehavior()

public function detachBehavior(string $name): yii\base\Behavior<static>|null

Detaches a behavior from the component.

The behavior’s Behavior::detach() method will be invoked.

Parameters

Parameter	Type	Description
$name	string	The behavior’s name.

Returns

Behavior<static>|null: The detached behavior. Null if the behavior does not exist.

detachBehaviors()

public function detachBehaviors(): mixed

Detaches all behaviors from the component.

Returns

mixed

ensureBehaviors()

public function ensureBehaviors(): mixed

Makes sure that the behaviors declared in behaviors() are attached to this component.

Returns

mixed

getBehavior()

public function getBehavior(string $name): yii\base\Behavior<static>|null

Returns the named behavior object.

Parameters

Parameter	Type	Description
$name	string	The behavior name

Returns

Behavior<static>|null: The behavior object, or null if the behavior does not exist

getBehaviors()

public function getBehaviors(): array<yii\base\Behavior<static>>

Returns all behaviors attached to this component.

Returns

array<Behavior<static>>: List of behaviors attached to this component

hasEventHandlers()

public function hasEventHandlers(string $name): bool

Returns a value indicating whether there is any handler attached to the named event.

Parameters

Parameter	Type	Description
$name	string	The event name

Returns

bool: Whether there is any handler attached to the event.

hasMethod()

public function hasMethod(string $name, bool $checkBehaviors = true): bool

Returns a value indicating whether a method is defined.

A method is defined if:

• the class has a method with the specified name
• an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

Parameter	Type	Description
$name	string	The property name
$checkBehaviors	bool	Whether to treat behaviors’ methods as methods of this component

Returns

bool: Whether the method is defined

hasProperty()

public function hasProperty(string $name, bool $checkVars = true, bool $checkBehaviors = true): bool

Returns a value indicating whether a property is defined for this component.

A property is defined if:

• the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
• the class has a member variable with the specified name (when $checkVars is true);
• an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

Parameter	Type	Description
$name	string	The property name
$checkVars	bool	Whether to treat member variables as properties
$checkBehaviors	bool	Whether to treat behaviors’ properties as properties of this component

Returns

bool: Whether the property is defined

See also

• canGetProperty()
• canSetProperty()

off()

public function off(string $name, callable|null $handler = null): bool

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

Parameter	Type	Description
$name	string	Event name
$handler	callable|null	The event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Returns

bool: If a handler is found and detached

See also

• on()

on()

public function on(string $name, callable $handler, mixed $data = null, bool $append = true): mixed

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

Parameter	Type	Description
$name	string	The event name
$handler	callable	The event handler
$data	mixed	The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via Event::$data.
$append	bool	Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Returns

mixed

See also

• off()

trigger()

public function trigger(string $name, yii\base\Event|null $event = null): mixed

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

Parameter	Type	Description
$name	string	The event name
$event	Event|null	The event instance. If not set, a default Event object will be created.

Returns

mixed