CTheme

所有包 | 属性 | 方法

包	system.web
继承	class CTheme » CComponent
可用自	1.0
源码	framework/web/CTheme.php

CTheme represents an application theme.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
basePath	string	the file path to the theme folder	CTheme
baseUrl	string	the relative URL to the theme folder (without ending slash)	CTheme
name	string	theme name	CTheme
skinPath	string	the path for widget skins.	CTheme
systemViewPath	string	the path for system views.	CTheme
viewPath	string	the path for controller views.	CTheme

公共方法

隐藏继承的方法

方法	描述	被定义在
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CTheme
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getBasePath()	Returns the file path to the theme folder	CTheme
getBaseUrl()	Returns the relative URL to the theme folder (without ending slash)	CTheme
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getLayoutFile()	Finds the layout file for the specified controller's layout.	CTheme
getName()	Returns theme name	CTheme
getSkinPath()	Returns the path for widget skins. Defaults to 'ThemeRoot/views/skins'.	CTheme
getSystemViewPath()	Returns the path for system views. Defaults to 'ThemeRoot/views/system'.	CTheme
getViewFile()	Finds the view file for the specified controller's view.	CTheme
getViewPath()	Returns the path for controller views. Defaults to 'ThemeRoot/views'.	CTheme
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
raiseEvent()	Raises an event.	CComponent

属性详情

basePath 属性只读

public string getBasePath()

the file path to the theme folder

baseUrl 属性只读

public string getBaseUrl()

the relative URL to the theme folder (without ending slash)

name 属性只读

public string getName()

theme name

skinPath 属性只读（自版本 v1.1 可用）

public string getSkinPath()

the path for widget skins. Defaults to 'ThemeRoot/views/skins'.

systemViewPath 属性只读

public string getSystemViewPath()

the path for system views. Defaults to 'ThemeRoot/views/system'.

viewPath 属性只读

public string getViewPath()

the path for controller views. Defaults to 'ThemeRoot/views'.

方法详情

__construct() 方法

public void __construct(string $name, string $basePath, string $baseUrl)
$name	string	name of the theme
$basePath	string	base theme path
$baseUrl	string	base theme URL

源码： framework/web/CTheme.php#37 (显示)


public function __construct($name,$basePath,$baseUrl)
{
    $this->_name=$name;
    $this->_baseUrl=$baseUrl;
    $this->_basePath=$basePath;
}

Constructor.

getBasePath() 方法

public string getBasePath()
{return}	string	the file path to the theme folder

源码： framework/web/CTheme.php#63 (显示)


public function getBasePath()
{
    return $this->_basePath;
}

getBaseUrl() 方法

public string getBaseUrl()
{return}	string	the relative URL to the theme folder (without ending slash)

源码： framework/web/CTheme.php#55 (显示)


public function getBaseUrl()
{
    return $this->_baseUrl;
}

getLayoutFile() 方法

public string getLayoutFile(CController $controller, string $layoutName)
$controller	CController	the controller
$layoutName	string	the layout name
{return}	string	the layout file path. False if the file does not exist.

源码： framework/web/CTheme.php#113 (显示)


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();
        }
    }
    elseif($module!==null)
        $moduleViewPath.='/'.$module->getId();

    return $controller->resolveViewFile($layoutName,$moduleViewPath.'/layouts',$basePath,$moduleViewPath);
}

Finds the layout file for the specified controller's layout.

getName() 方法

public string getName()
{return}	string	theme name

源码： framework/web/CTheme.php#47 (显示)


public function getName()
{
    return $this->_name;
}

getSkinPath() 方法（自版本 v1.1 可用）

public string getSkinPath()
{return}	string	the path for widget skins. Defaults to 'ThemeRoot/views/skins'.

源码： framework/web/CTheme.php#88 (显示)


public function getSkinPath()
{
    return $this->getViewPath().DIRECTORY_SEPARATOR.'skins';
}

getSystemViewPath() 方法

public string getSystemViewPath()
{return}	string	the path for system views. Defaults to 'ThemeRoot/views/system'.

源码： framework/web/CTheme.php#79 (显示)


public function getSystemViewPath()
{
    return $this->getViewPath().DIRECTORY_SEPARATOR.'system';
}

getViewFile() 方法

public string getViewFile(CController $controller, string $viewName)
$controller	CController	the controller
$viewName	string	the view name
{return}	string	the view file path. False if the file does not exist.

源码： framework/web/CTheme.php#99 (显示)


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);
}

Finds the view file for the specified controller's view.

getViewPath() 方法

public string getViewPath()
{return}	string	the path for controller views. Defaults to 'ThemeRoot/views'.

源码： framework/web/CTheme.php#71 (显示)


public function getViewPath()
{
    return $this->_basePath.DIRECTORY_SEPARATOR.'views';
}