Component.php 18.4 KB
Newer Older
Qiang Xue committed
1
<?php
w  
Qiang Xue committed
2 3
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6
 * @license http://www.yiiframework.com/license/
 */
Qiang Xue committed
7 8 9

namespace yii\base;

Qiang Xue committed
10 11
use Yii;

w  
Qiang Xue committed
12
/**
13 14
 * Component is the base class that implements the *property*, *event* and *behavior* features.
 *
Qiang Xue committed
15
 * @include @yii/base/Component.md
16 17 18
 *
 * @property Behavior[] $behaviors List of behaviors attached to this component. This property is read-only.
 *
w  
Qiang Xue committed
19
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
20
 * @since 2.0
w  
Qiang Xue committed
21
 */
Qiang Xue committed
22
class Component extends Object
Qiang Xue committed
23
{
Qiang Xue committed
24
	/**
Qiang Xue committed
25
	 * @var array the attached event handlers (event name => handlers)
Qiang Xue committed
26
	 */
27
	private $_events = [];
Qiang Xue committed
28 29 30
	/**
	 * @var Behavior[] the attached behaviors (behavior name => behavior)
	 */
Qiang Xue committed
31
	private $_behaviors;
Qiang Xue committed
32 33

	/**
w  
Qiang Xue committed
34 35 36 37 38 39 40 41 42
	 * 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;`.
	 * @param string $name the property name
43
	 * @return mixed the property value or the value of a behavior's property
Qiang Xue committed
44
	 * @throws UnknownPropertyException if the property is not defined
Qiang Xue committed
45
	 * @throws InvalidCallException if the property is write-only.
46
	 * @see __set()
Qiang Xue committed
47 48 49 50
	 */
	public function __get($name)
	{
		$getter = 'get' . $name;
51 52
		if (method_exists($this, $getter)) {
			// read property, e.g. getName()
Qiang Xue committed
53
			return $this->$getter();
54 55
		} else {
			// behavior property
Qiang Xue committed
56
			$this->ensureBehaviors();
Qiang Xue committed
57
			foreach ($this->_behaviors as $behavior) {
Qiang Xue committed
58
				if ($behavior->canGetProperty($name)) {
Qiang Xue committed
59
					return $behavior->$name;
Qiang Xue committed
60
				}
Qiang Xue committed
61 62
			}
		}
63 64 65 66 67
		if (method_exists($this, 'set' . $name)) {
			throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
		} else {
			throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
		}
Qiang Xue committed
68 69 70
	}

	/**
71
	 * Sets the value of a component property.
w  
Qiang Xue committed
72 73 74
	 * This method will check in the following order and act accordingly:
	 *
	 *  - a property defined by a setter: set the property value
Qiang Xue committed
75 76
	 *  - 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"
w  
Qiang Xue committed
77 78 79 80
	 *  - 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;`.
Qiang Xue committed
81
	 * @param string $name the property name or the event name
w  
Qiang Xue committed
82
	 * @param mixed $value the property value
83 84
	 * @throws UnknownPropertyException if the property is not defined
	 * @throws InvalidCallException if the property is read-only.
85
	 * @see __get()
Qiang Xue committed
86
	 */
Qiang Xue committed
87
	public function __set($name, $value)
Qiang Xue committed
88
	{
Qiang Xue committed
89
		$setter = 'set' . $name;
Qiang Xue committed
90 91
		if (method_exists($this, $setter)) {
			// set property
Qiang Xue committed
92 93
			$this->$setter($value);
			return;
Qiang Xue committed
94 95
		} elseif (strncmp($name, 'on ', 3) === 0) {
			// on event: attach event handler
Qiang Xue committed
96
			$this->on(trim(substr($name, 3)), $value);
Qiang Xue committed
97
			return;
Qiang Xue committed
98 99 100
		} elseif (strncmp($name, 'as ', 3) === 0) {
			// as behavior: attach behavior
			$name = trim(substr($name, 3));
Qiang Xue committed
101
			$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
102
			return;
103 104
		} else {
			// behavior property
Qiang Xue committed
105
			$this->ensureBehaviors();
Qiang Xue committed
106
			foreach ($this->_behaviors as $behavior) {
Qiang Xue committed
107
				if ($behavior->canSetProperty($name)) {
Qiang Xue committed
108 109
					$behavior->$name = $value;
					return;
Qiang Xue committed
110
				}
Qiang Xue committed
111 112
			}
		}
Qiang Xue committed
113
		if (method_exists($this, 'get' . $name)) {
Qiang Xue committed
114
			throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
Qiang Xue committed
115
		} else {
Qiang Xue committed
116
			throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
Qiang Xue committed
117
		}
Qiang Xue committed
118 119 120 121
	}

	/**
	 * Checks if a property value is null.
w  
Qiang Xue committed
122 123 124 125 126 127 128
	 * This method will check in the following order and act accordingly:
	 *
	 *  - a property defined by a setter: return whether the property value is null
	 *  - a property of a behavior: return whether the property value is null
	 *
	 * Do not call this method directly as it is a PHP magic method that
	 * will be implicitly called when executing `isset($component->property)`.
Qiang Xue committed
129
	 * @param string $name the property name or the event name
w  
Qiang Xue committed
130
	 * @return boolean whether the named property is null
Qiang Xue committed
131 132 133
	 */
	public function __isset($name)
	{
Qiang Xue committed
134
		$getter = 'get' . $name;
135
		if (method_exists($this, $getter)) {
Qiang Xue committed
136
			return $this->$getter() !== null;
137 138
		} else {
			// behavior property
Qiang Xue committed
139
			$this->ensureBehaviors();
Qiang Xue committed
140
			foreach ($this->_behaviors as $behavior) {
Qiang Xue committed
141
				if ($behavior->canGetProperty($name)) {
Qiang Xue committed
142
					return $behavior->$name !== null;
Qiang Xue committed
143
				}
Qiang Xue committed
144 145 146 147 148 149 150
			}
		}
		return false;
	}

	/**
	 * Sets a component property to be null.
w  
Qiang Xue committed
151 152 153 154 155 156 157 158
	 * 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)`.
	 * @param string $name the property name
159
	 * @throws InvalidCallException if the property is read only.
Qiang Xue committed
160 161 162
	 */
	public function __unset($name)
	{
Qiang Xue committed
163
		$setter = 'set' . $name;
164
		if (method_exists($this, $setter)) {
Qiang Xue committed
165 166
			$this->$setter(null);
			return;
167 168
		} else {
			// behavior property
Qiang Xue committed
169
			$this->ensureBehaviors();
Qiang Xue committed
170
			foreach ($this->_behaviors as $behavior) {
Qiang Xue committed
171
				if ($behavior->canSetProperty($name)) {
Qiang Xue committed
172 173
					$behavior->$name = null;
					return;
Qiang Xue committed
174
				}
Qiang Xue committed
175
			}
Qiang Xue committed
176 177
		}
		if (method_exists($this, 'get' . $name)) {
Qiang Xue committed
178
			throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '.' . $name);
w  
Qiang Xue committed
179
		}
Qiang Xue committed
180 181 182 183
	}

	/**
	 * Calls the named method which is not a class method.
184 185
	 *
	 * This method will check if any attached behavior has
w  
Qiang Xue committed
186 187 188 189
	 * 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.
Qiang Xue committed
190
	 * @param string $name the method name
Qiang Xue committed
191
	 * @param array $params method parameters
Qiang Xue committed
192
	 * @return mixed the method return value
Qiang Xue committed
193
	 * @throws UnknownMethodException when calling unknown method
Qiang Xue committed
194
	 */
Qiang Xue committed
195
	public function __call($name, $params)
Qiang Xue committed
196
	{
Qiang Xue committed
197
		$this->ensureBehaviors();
Qiang Xue committed
198
		foreach ($this->_behaviors as $object) {
199
			if ($object->hasMethod($name)) {
Alexander Makarov committed
200
				return call_user_func_array([$object, $name], $params);
w  
Qiang Xue committed
201
			}
Qiang Xue committed
202
		}
Qiang Xue committed
203

Qiang Xue committed
204
		throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
Qiang Xue committed
205 206
	}

Qiang Xue committed
207 208 209 210 211 212
	/**
	 * 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.
	 */
	public function __clone()
	{
213
		$this->_events = [];
Qiang Xue committed
214
		$this->_behaviors = null;
Qiang Xue committed
215 216
	}

Qiang Xue committed
217 218 219 220 221 222
	/**
	 * 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);
crtlib committed
223
	 * - the class has a member variable with the specified name (when `$checkVars` is true);
224
	 * - an attached behavior has a property of the given name (when `$checkBehaviors` is true).
Qiang Xue committed
225 226
	 *
	 * @param string $name the property name
crtlib committed
227
	 * @param boolean $checkVars whether to treat member variables as properties
228
	 * @param boolean $checkBehaviors whether to treat behaviors' properties as properties of this component
Qiang Xue committed
229
	 * @return boolean whether the property is defined
230 231
	 * @see canGetProperty()
	 * @see canSetProperty()
Qiang Xue committed
232
	 */
crtlib committed
233
	public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
Qiang Xue committed
234
	{
crtlib committed
235
		return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
Qiang Xue committed
236 237 238 239 240 241 242 243
	}

	/**
	 * 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);
crtlib committed
244
	 * - the class has a member variable with the specified name (when `$checkVars` is true);
245
	 * - an attached behavior has a readable property of the given name (when `$checkBehaviors` is true).
Qiang Xue committed
246 247
	 *
	 * @param string $name the property name
crtlib committed
248
	 * @param boolean $checkVars whether to treat member variables as properties
Qiang Xue committed
249
	 * @param boolean $checkBehaviors whether to treat behaviors' properties as properties of this component
Qiang Xue committed
250
	 * @return boolean whether the property can be read
251
	 * @see canSetProperty()
Qiang Xue committed
252
	 */
crtlib committed
253
	public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
Qiang Xue committed
254
	{
crtlib committed
255
		if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
Qiang Xue committed
256
			return true;
Qiang Xue committed
257
		} elseif ($checkBehaviors) {
Qiang Xue committed
258
			$this->ensureBehaviors();
Qiang Xue committed
259
			foreach ($this->_behaviors as $behavior) {
crtlib committed
260
				if ($behavior->canGetProperty($name, $checkVars)) {
Qiang Xue committed
261 262 263 264
					return true;
				}
			}
		}
265
		return false;
Qiang Xue committed
266 267 268 269 270 271 272 273
	}

	/**
	 * 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);
crtlib committed
274
	 * - the class has a member variable with the specified name (when `$checkVars` is true);
275
	 * - an attached behavior has a writable property of the given name (when `$checkBehaviors` is true).
Qiang Xue committed
276 277
	 *
	 * @param string $name the property name
crtlib committed
278
	 * @param boolean $checkVars whether to treat member variables as properties
Qiang Xue committed
279
	 * @param boolean $checkBehaviors whether to treat behaviors' properties as properties of this component
Qiang Xue committed
280
	 * @return boolean whether the property can be written
281
	 * @see canGetProperty()
Qiang Xue committed
282
	 */
crtlib committed
283
	public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
Qiang Xue committed
284
	{
crtlib committed
285
		if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
Qiang Xue committed
286
			return true;
Qiang Xue committed
287
		} elseif ($checkBehaviors) {
Qiang Xue committed
288
			$this->ensureBehaviors();
Qiang Xue committed
289
			foreach ($this->_behaviors as $behavior) {
crtlib committed
290
				if ($behavior->canSetProperty($name, $checkVars)) {
Qiang Xue committed
291 292 293 294
					return true;
				}
			}
		}
295
		return false;
Qiang Xue committed
296 297
	}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
	/**
	 * 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).
	 *
	 * @param string $name the property name
	 * @param boolean $checkBehaviors whether to treat behaviors' methods as methods of this component
	 * @return boolean whether the property is defined
	 */
	public function hasMethod($name, $checkBehaviors = true)
	{
		if (method_exists($this, $name)) {
			return true;
		} elseif ($checkBehaviors) {
			$this->ensureBehaviors();
			foreach ($this->_behaviors as $behavior) {
				if ($behavior->hasMethod($name)) {
					return true;
				}
			}
		}
		return false;
	}

Qiang Xue committed
324 325 326 327 328 329 330 331 332 333
	/**
	 * 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:
	 *
	 * ~~~
Alexander Makarov committed
334
	 * 'behaviorName' => [
Qiang Xue committed
335 336 337
	 *     'class' => 'BehaviorClass',
	 *     'property1' => 'value1',
	 *     'property2' => 'value2',
Alexander Makarov committed
338
	 * ]
Qiang Xue committed
339 340
	 * ~~~
	 *
Qiang Xue committed
341 342 343 344
	 * Note that a behavior class must extend from [[Behavior]]. Behavior names can be strings
	 * or integers. If the former, they uniquely identify the behaviors. If the latter, the corresponding
	 * behaviors are anonymous and their properties and methods will NOT be made available via the component
	 * (however, the behaviors can still respond to the component's events).
Qiang Xue committed
345
	 *
Qiang Xue committed
346
	 * Behaviors declared in this method will be attached to the component automatically (on demand).
Qiang Xue committed
347 348 349 350 351
	 *
	 * @return array the behavior configurations.
	 */
	public function behaviors()
	{
Alexander Makarov committed
352
		return [];
Qiang Xue committed
353 354 355
	}

	/**
Qiang Xue committed
356
	 * Returns a value indicating whether there is any handler attached to the named event.
Qiang Xue committed
357
	 * @param string $name the event name
w  
Qiang Xue committed
358
	 * @return boolean whether there is any handler attached to the event.
Qiang Xue committed
359
	 */
w  
Qiang Xue committed
360
	public function hasEventHandlers($name)
Qiang Xue committed
361
	{
Qiang Xue committed
362
		$this->ensureBehaviors();
363
		return !empty($this->_events[$name]) || Event::hasHandlers($this, $name);
Qiang Xue committed
364 365 366 367 368
	}

	/**
	 * Attaches an event handler to an event.
	 *
369
	 * The event handler must be a valid PHP callback. The followings are
w  
Qiang Xue committed
370 371
	 * some examples:
	 *
w  
Qiang Xue committed
372
	 * ~~~
Qiang Xue committed
373
	 * function ($event) { ... }         // anonymous function
Alexander Makarov committed
374 375 376
	 * [$object, 'handleClick']          // $object->handleClick()
	 * ['Page', 'handleClick']           // Page::handleClick()
	 * 'handleClick'                     // global function handleClick()
w  
Qiang Xue committed
377
	 * ~~~
Qiang Xue committed
378
	 *
379
	 * The event handler must be defined with the following signature,
Qiang Xue committed
380
	 *
w  
Qiang Xue committed
381
	 * ~~~
Qiang Xue committed
382
	 * function ($event)
w  
Qiang Xue committed
383
	 * ~~~
Qiang Xue committed
384
	 *
w  
Qiang Xue committed
385
	 * where `$event` is an [[Event]] object which includes parameters associated with the event.
Qiang Xue committed
386 387
	 *
	 * @param string $name the event name
Qiang Xue committed
388 389 390
	 * @param callback $handler the event handler
	 * @param mixed $data 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]].
Qiang Xue committed
391
	 * @see off()
Qiang Xue committed
392
	 */
Qiang Xue committed
393
	public function on($name, $handler, $data = null)
Qiang Xue committed
394
	{
Qiang Xue committed
395
		$this->ensureBehaviors();
Alexander Makarov committed
396
		$this->_events[$name][] = [$handler, $data];
Qiang Xue committed
397 398 399
	}

	/**
Qiang Xue committed
400 401
	 * Detaches an existing event handler from this component.
	 * This method is the opposite of [[on()]].
Qiang Xue committed
402
	 * @param string $name event name
Qiang Xue committed
403 404
	 * @param callback $handler the event handler to be removed.
	 * If it is null, all handlers attached to the named event will be removed.
Qiang Xue committed
405
	 * @return boolean if a handler is found and detached
Qiang Xue committed
406
	 * @see on()
Qiang Xue committed
407
	 */
Qiang Xue committed
408
	public function off($name, $handler = null)
Qiang Xue committed
409
	{
Qiang Xue committed
410
		$this->ensureBehaviors();
Qiang Xue committed
411 412 413 414 415 416 417 418 419 420 421 422
		if (empty($this->_events[$name])) {
			return false;
		}
		if ($handler === null) {
			unset($this->_events[$name]);
			return true;
		} else {
			$removed = false;
			foreach ($this->_events[$name] as $i => $event) {
				if ($event[0] === $handler) {
					unset($this->_events[$name][$i]);
					$removed = true;
Qiang Xue committed
423 424
				}
			}
Qiang Xue committed
425 426 427 428
			if ($removed) {
				$this->_events[$name] = array_values($this->_events[$name]);
			}
			return $removed;
Qiang Xue committed
429
		}
Qiang Xue committed
430 431 432
	}

	/**
Qiang Xue committed
433
	 * Triggers an event.
Qiang Xue committed
434
	 * This method represents the happening of an event. It invokes
Carsten Brandt committed
435
	 * all attached handlers for the event including class-level handlers.
Qiang Xue committed
436
	 * @param string $name the event name
Qiang Xue committed
437
	 * @param Event $event the event parameter. If not set, a default [[Event]] object will be created.
Qiang Xue committed
438
	 */
439
	public function trigger($name, Event $event = null)
Qiang Xue committed
440
	{
Qiang Xue committed
441
		$this->ensureBehaviors();
Qiang Xue committed
442
		if (!empty($this->_events[$name])) {
Qiang Xue committed
443
			if ($event === null) {
Qiang Xue committed
444 445 446 447
				$event = new Event;
			}
			if ($event->sender === null) {
				$event->sender = $this;
Qiang Xue committed
448
			}
Qiang Xue committed
449 450
			$event->handled = false;
			$event->name = $name;
Qiang Xue committed
451 452 453
			foreach ($this->_events[$name] as $handler) {
				$event->data = $handler[1];
				call_user_func($handler[0], $event);
w  
Qiang Xue committed
454
				// stop further handling if the event is handled
Qiang Xue committed
455
				if ($event->handled) {
Qiang Xue committed
456
					return;
w  
Qiang Xue committed
457 458 459
				}
			}
		}
Carsten Brandt committed
460
		// invoke class-level attached handlers
461
		Event::trigger($this, $name, $event);
w  
Qiang Xue committed
462 463 464 465
	}

	/**
	 * Returns the named behavior object.
Qiang Xue committed
466
	 * @param string $name the behavior name
w  
Qiang Xue committed
467 468
	 * @return Behavior the behavior object, or null if the behavior does not exist
	 */
Qiang Xue committed
469
	public function getBehavior($name)
w  
Qiang Xue committed
470
	{
Qiang Xue committed
471
		$this->ensureBehaviors();
Qiang Xue committed
472
		return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
Qiang Xue committed
473 474 475 476 477 478 479 480 481
	}

	/**
	 * Returns all behaviors attached to this component.
	 * @return Behavior[] list of behaviors attached to this component
	 */
	public function getBehaviors()
	{
		$this->ensureBehaviors();
Qiang Xue committed
482
		return $this->_behaviors;
w  
Qiang Xue committed
483 484 485 486 487 488
	}

	/**
	 * 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
Qiang Xue committed
489
	 * this component by calling the [[Behavior::attach()]] method.
Qiang Xue committed
490
	 * @param string $name the name of the behavior.
Qiang Xue committed
491
	 * @param string|array|Behavior $behavior the behavior configuration. This can be one of the following:
w  
Qiang Xue committed
492 493 494
	 *
	 *  - a [[Behavior]] object
	 *  - a string specifying the behavior class
Qiang Xue committed
495
	 *  - an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.
w  
Qiang Xue committed
496 497
	 *
	 * @return Behavior the behavior object
498
	 * @see detachBehavior()
w  
Qiang Xue committed
499 500 501
	 */
	public function attachBehavior($name, $behavior)
	{
Qiang Xue committed
502 503
		$this->ensureBehaviors();
		return $this->attachBehaviorInternal($name, $behavior);
w  
Qiang Xue committed
504 505 506 507 508
	}

	/**
	 * Attaches a list of behaviors to the component.
	 * Each behavior is indexed by its name and should be a [[Behavior]] object,
Qiang Xue committed
509
	 * a string specifying the behavior class, or an configuration array for creating the behavior.
w  
Qiang Xue committed
510
	 * @param array $behaviors list of behaviors to be attached to the component
511
	 * @see attachBehavior()
w  
Qiang Xue committed
512 513 514
	 */
	public function attachBehaviors($behaviors)
	{
Qiang Xue committed
515
		$this->ensureBehaviors();
w  
Qiang Xue committed
516
		foreach ($behaviors as $name => $behavior) {
Qiang Xue committed
517
			$this->attachBehaviorInternal($name, $behavior);
w  
Qiang Xue committed
518 519 520 521 522
		}
	}

	/**
	 * Detaches a behavior from the component.
Qiang Xue committed
523
	 * The behavior's [[Behavior::detach()]] method will be invoked.
w  
Qiang Xue committed
524 525 526 527 528
	 * @param string $name the behavior's name.
	 * @return Behavior the detached behavior. Null if the behavior does not exist.
	 */
	public function detachBehavior($name)
	{
529
		$this->ensureBehaviors();
Qiang Xue committed
530 531 532
		if (isset($this->_behaviors[$name])) {
			$behavior = $this->_behaviors[$name];
			unset($this->_behaviors[$name]);
533
			$behavior->detach();
w  
Qiang Xue committed
534
			return $behavior;
Qiang Xue committed
535 536
		} else {
			return null;
w  
Qiang Xue committed
537 538 539 540 541 542 543 544
		}
	}

	/**
	 * Detaches all behaviors from the component.
	 */
	public function detachBehaviors()
	{
545
		$this->ensureBehaviors();
546 547
		foreach ($this->_behaviors as $name => $behavior) {
			$this->detachBehavior($name);
Qiang Xue committed
548 549 550 551 552 553 554 555
		}
	}

	/**
	 * Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
	 */
	public function ensureBehaviors()
	{
Qiang Xue committed
556
		if ($this->_behaviors === null) {
Alexander Makarov committed
557
			$this->_behaviors = [];
Qiang Xue committed
558
			foreach ($this->behaviors() as $name => $behavior) {
Qiang Xue committed
559
				$this->attachBehaviorInternal($name, $behavior);
Qiang Xue committed
560
			}
w  
Qiang Xue committed
561 562
		}
	}
Qiang Xue committed
563 564 565

	/**
	 * Attaches a behavior to this component.
Qiang Xue committed
566
	 * @param string $name the name of the behavior.
Qiang Xue committed
567 568 569 570 571 572
	 * @param string|array|Behavior $behavior the behavior to be attached
	 * @return Behavior the attached behavior.
	 */
	private function attachBehaviorInternal($name, $behavior)
	{
		if (!($behavior instanceof Behavior)) {
Qiang Xue committed
573
			$behavior = Yii::createObject($behavior);
Qiang Xue committed
574
		}
Qiang Xue committed
575 576
		if (isset($this->_behaviors[$name])) {
			$this->_behaviors[$name]->detach();
Qiang Xue committed
577
		}
Qiang Xue committed
578
		$behavior->attach($this);
Qiang Xue committed
579
		return $this->_behaviors[$name] = $behavior;
Qiang Xue committed
580
	}
Qiang Xue committed
581
}