CTheme
| Package | system.web |
|---|---|
| Inheritance | class CTheme » CComponent |
| Since | 1.0 |
| Version | $Id: CTheme.php 2218 2010-06-23 01:50:19Z qiang.xue $ |
CTheme represents an application theme.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| 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 |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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() | CTheme | |
| getBaseUrl() | 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() | CTheme | |
| getSkinPath() | CTheme | |
| getSystemViewPath() | CTheme | |
| getViewFile() | Finds the view file for the specified controller's view. | CTheme |
| getViewPath() | 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 |
Property Details
basePath
property
read-only
public string getBasePath()
the file path to the theme folder
baseUrl
property
read-only
public string getBaseUrl()
the relative URL to the theme folder (without ending slash)
name
property
read-only
public string getName()
theme name
skinPath
property
read-only (available since v1.1)
public string getSkinPath()
the path for widget skins. Defaults to 'ThemeRoot/views/skins'.
systemViewPath
property
read-only
public string getSystemViewPath()
the path for system views. Defaults to 'ThemeRoot/views/system'.
viewPath
property
read-only
public string getViewPath()
the path for controller views. Defaults to 'ThemeRoot/views'.
Method Details
__construct()
method
|
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 |
Constructor.
getBasePath()
method
|
public string getBasePath()
| ||
| {return} | string | the file path to the theme folder |
getBaseUrl()
method
|
public string getBaseUrl()
| ||
| {return} | string | the relative URL to the theme folder (without ending slash) |
getLayoutFile()
method
|
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. |
Finds the layout file for the specified controller's layout.
getName()
method
|
public string getName()
| ||
| {return} | string | theme name |
getSkinPath()
method
(available since v1.1)
|
public string getSkinPath()
| ||
| {return} | string | the path for widget skins. Defaults to 'ThemeRoot/views/skins'. |
getSystemViewPath()
method
|
public string getSystemViewPath()
| ||
| {return} | string | the path for system views. Defaults to 'ThemeRoot/views/system'. |
getViewFile()
method
|
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. |
Finds the view file for the specified controller's view.
getViewPath()
method
|
public string getViewPath()
| ||
| {return} | string | the path for controller views. Defaults to 'ThemeRoot/views'. |