包 | system.web |
---|---|
继承 | class CTheme » CComponent |
源自 | 1.0 |
版本 | $Id: CTheme.php 3426 2011-10-25 00:01:09Z alexander.makarow $ |
源码 |
CTheme表示一个应用程序主题。
公共属性
属性 | 类型 | 描述 | 定义在 |
---|---|---|---|
basePath | string | 主题文件夹路径 | CTheme |
baseUrl | string | 主题文件夹相对URL(没有结尾反斜线) | CTheme |
name | string | 主题名称 | CTheme |
skinPath | string | 小部件皮肤路径。默认是‘ThemeRoot/views/skins’。 | CTheme |
systemViewPath | string | 系统视图路径。默认是‘ThemeRoot/views/system’。 | CTheme |
viewPath | string | 控制器视图路径。默认是‘ThemeRoot/views’。 | CTheme |
公共方法
属性详细
basePath
属性
只读
public string getBasePath()
主题文件夹路径
baseUrl
属性
只读
public string getBaseUrl()
主题文件夹相对URL(没有结尾反斜线)
name
属性
只读
public string getName()
主题名称
skinPath
属性
只读 (可用自 v1.1)
public string getSkinPath()
小部件皮肤路径。默认是‘ThemeRoot/views/skins’。
systemViewPath
属性
只读
public string getSystemViewPath()
系统视图路径。默认是‘ThemeRoot/views/system’。
viewPath
属性
只读
public string getViewPath()
控制器视图路径。默认是‘ThemeRoot/views’。
方法详细
__construct()
方法
public void __construct(string $name, string $basePath, string $baseUrl)
| ||
$name | string | 主题名称 |
$basePath | string | 基本主题路径 |
$baseUrl | string | 基本主题URL |
public function __construct($name,$basePath,$baseUrl)
{
$this->_name=$name;
$this->_baseUrl=$baseUrl;
$this->_basePath=$basePath;
}
构造方法。
getBasePath()
方法
public string getBasePath()
| ||
{return} | string | 主题文件夹路径 |
public function getBasePath()
{
return $this->_basePath;
}
getBaseUrl()
方法
public string getBaseUrl()
| ||
{return} | string | 主题文件夹相对URL(没有结尾反斜线) |
public function getBaseUrl()
{
return $this->_baseUrl;
}
getLayoutFile()
方法
public string getLayoutFile(CController $controller, string $layoutName)
| ||
$controller | CController | 控制器 |
$layoutName | string | 布局名称 |
{return} | string | 布局文件路径。如果文件不存在为false。 |
public function getLayoutFile($controller,$layoutName)
{
$moduleViewPath=$basePath=$this->getViewPath();
$module=$controller->getModule();
if(empty($layoutName))
{
while($module!==null)
{
if($module->layout===false)
return false;
if(!empty($module->layout))
break;
$module=$module->getParentModule();
}
if($module===null)
$layoutName=Yii::app()->layout;
else
{
$layoutName=$module->layout;
$moduleViewPath.='/'.$module->getId();
}
}
else if($module!==null)
$moduleViewPath.='/'.$module->getId();
return $controller->resolveViewFile($layoutName,$moduleViewPath.'/layouts',$basePath,$moduleViewPath);
}
查找指定控制器的布局的布局文件。
getName()
方法
public string getName()
| ||
{return} | string | 主题名称 |
public function getName()
{
return $this->_name;
}
getSkinPath()
方法
(可用自 v1.1)
public string getSkinPath()
| ||
{return} | string | 小部件皮肤路径。默认是‘ThemeRoot/views/skins’。 |
public function getSkinPath()
{
return $this->getViewPath().DIRECTORY_SEPARATOR.'skins';
}
getSystemViewPath()
方法
public string getSystemViewPath()
| ||
{return} | string | 系统视图路径。默认是‘ThemeRoot/views/system’。 |
public function getSystemViewPath()
{
return $this->getViewPath().DIRECTORY_SEPARATOR.'system';
}
getViewFile()
方法
public string getViewFile(CController $controller, string $viewName)
| ||
$controller | CController | 控制器 |
$viewName | string | 视图名称 |
{return} | string | 视图文件路径。如果文件不存在为false。 |
public function getViewFile($controller,$viewName)
{
$moduleViewPath=$this->getViewPath();
if(($module=$controller->getModule())!==null)
$moduleViewPath.='/'.$module->getId();
return $controller->resolveViewFile($viewName,$this->getViewPath().'/'.$controller->getUniqueId(),$this->getViewPath(),$moduleViewPath);
}
查找指定控制器的视图的视图文件。
getViewPath()
方法
public string getViewPath()
| ||
{return} | string | 控制器视图路径。默认是‘ThemeRoot/views’。 |
public function getViewPath()
{
return $this->_basePath.DIRECTORY_SEPARATOR.'views';
}