framework/Web/UI/WebControls/TContentPlaceHolder.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

<?php
/**
 * TContentPlaceHolder class file.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.pradosoft.com/
 * @copyright Copyright &copy; 2005-2014 PradoSoft
 * @license http://www.pradosoft.com/license/
 * @package Prado\Web\UI\WebControls
 */

namespace Prado\Web\UI\WebControls;
use Prado\Exceptions\TConfigurationException;

/**
 * TContentPlaceHolder class
 *
 * TContentPlaceHolder reserves a place on a template where a {@link TContent}
 * control can inject itself and its children in. TContentPlaceHolder and {@link TContent}
 * together implement a decoration pattern for prado templated controls.
 * A template control (called content control) can specify a master control
 * whose template contains some TContentPlaceHolder controls.
 * {@link TContent} controls on the content control's template will replace the corresponding
 * {@link TContentPlaceHolder} controls on the master control's template.
 * This is called content injection. It is done by matching the IDs of
 * {@link TContent} and {@link TContentPlaceHolder} controls.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @package Prado\Web\UI\WebControls
 * @since 3.0
 */
class TContentPlaceHolder extends \Prado\Web\UI\TControl
{
	/**
	 * This method is invoked after the control is instantiated on a template.
	 * This overrides the parent implementation by registering the content placeholder
	 * control to the template owner control. The placeholder control will NOT
	 * be added to the potential parent control!
	 * @param TControl potential parent of this control
	 */
	public function createdOnTemplate($parent)
	{
		if(($id=$this->getID())==='')
			throw new TConfigurationException('contentplaceholder_id_required');
		$this->getTemplateControl()->registerContentPlaceHolder($id,$this);
		$parent->getControls()->add($this);
	}
}