summaryrefslogtreecommitdiff
path: root/framework/web/CExtController.php
blob: 987d1ae8ea4fdd6ab476be247edacd0ea07e282c (plain)
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
50
51
52
53
54
<?php
/**
 * CExtController class file.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.yiiframework.com/
 * @copyright Copyright &copy; 2008-2011 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */


/**
 * CExtController is the base class for controllers distributed as extension.
 *
 * The main purpose of CExtController is to redefine the {@link viewPath} property
 * so that it points to the "views" subdirectory under the directory containing
 * the controller class file.
 *
 * @property string $viewPath The directory containing the view files for this controller.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @version $Id: CExtController.php 3515 2011-12-28 12:29:24Z mdomba $
 * @package system.web
 * @since 1.0
 */
class CExtController extends CController
{
	private $_viewPath;

	/**
	 * Returns the directory containing view files for this controller.
	 * This method overrides the parent implementation by specifying the view path
	 * to be the "views" subdirectory under the directory containing the controller
	 * class file.
	 * @return string the directory containing the view files for this controller.
	 */
	public function getViewPath()
	{
		if($this->_viewPath===null)
		{
			$class=new ReflectionClass(get_class($this));
			$this->_viewPath=dirname($class->getFileName()).DIRECTORY_SEPARATOR.'views';
		}
		return $this->_viewPath;
	}

	/**
	 * @param string $value the directory containing the view files for this controller.
	 */
	public function setViewPath($value)
	{
		$this->_viewPath=$value;
	}
}