behaviors.md 2.81 KB
Newer Older
1 2 3
Behaviors
=========

4 5 6 7
A behavior (also knows as *mixin*) can be used to enhance the functionality of an existing component without modifying the component's
code. In particular, a behavior can "inject" its own methods and properties into the component, making them directly accessible
via the component itslef. A behavior can also respond to  events triggered in the component, thus intercepting the normal
code execution. Unlike [PHP's traits](http://www.php.net/traits), behaviors can be attached to classes at runtime.
8 9 10 11

Using behaviors
---------------

12 13
A behavior can be attached to any class that extends from `Component`. In order to attach a behavior to a class, the component class must implement the `behaviors`
method. As an example, Yii provides the `AutoTimestamp` behavior for automatically updating timestamp fields when saving an Active Record model:
14 15 16 17 18 19 20 21 22 23 24 25

```php
class User extends ActiveRecord
{
	// ...

	public function behaviors()
	{
		return [
			'timestamp' => [
				'class' => 'yii\behaviors\AutoTimestamp',
				'attributes' => [
Alexander Kochetov committed
26 27
					ActiveRecord::EVENT_BEFORE_INSERT => ['created_at', 'updated_at'],
					ActiveRecord::EVENT_BEFORE_UPDATE => 'updated_at',
28 29 30 31 32 33 34
				],
			],
		];
	}
}
```

35
In the above, the `class` value is a string representing the fully qualified behavior class name. All of the other key-value pairs represent corresponding public properties of the `AutoTimestamp` class, thereby customizing how the behavior functions.
36 37 38 39

Creating your own behaviors
---------------------------

40
To create your own behavior, you must define a class that extends [[yii\base\Behavior]].
41 42

```php
43 44 45 46 47
namespace app\components;

use yii\base\Behavior;

class MyBehavior extends Behavior
48 49 50 51
{
}
```

52
To make it customizable, like [[yii\behaviors\AutoTimestamp]], add public properties:
53 54

```php
55 56 57 58 59
namespace app\components;

use yii\base\Behavior;

class MyBehavior extends Behavior
60 61 62 63 64 65 66 67
{
	public $attr;
}
```

Now, when the behavior is used, you can set the attribute to which you'd want the behavior to be applied:

```php
68 69 70 71
namespace app\models;

use yii\db\ActiveRecord;

72 73 74 75 76 77 78 79
class User extends ActiveRecord
{
	// ...

	public function behaviors()
	{
		return [
			'mybehavior' => [
80
				'class' => 'app\components\MyBehavior',
81 82 83 84 85 86 87
				'attr' => 'member_type'
			],
		];
	}
}
```

88 89
Behaviors are normally written to take action when certain events occur. Below we're implementing `events` method
to assign event handlers:
90 91

```php
92 93 94 95 96 97
namespace app\components;

use yii\base\Behavior;
use yii\db\ActiveRecord;

class MyBehavior extends Behavior
98 99
{
	public $attr;
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

	public function events()
	{
		return [
			ActiveRecord::EVENT_BEFORE_INSERT => 'beforeInsert',
			ActiveRecord::EVENT_BEFORE_UPDATE => 'beforeUpdate',
		];
	}

	public function beforeInsert() {
		$model = $this->owner;
		// Use $model->$attr
	}

	public function beforeUpdate() {
		$model = $this->owner;
116 117 118
		// Use $model->$attr
	}
}
Alexander Kochetov committed
119
```