PHP Class Prado\Web\UI\TThemeManager

TThemeManager manages the themes used in a Prado application. Themes are stored under the directory specified by the {@link setBasePath BasePath} property. The themes can be accessed via URL {@link setBaseUrl BaseUrl}. Each theme is represented by a subdirectory and all the files under that directory. The name of a theme is the name of the corresponding subdirectory. By default, the base path of all themes is a directory named "themes" under the directory containing the application entry script. To get a theme (normally you do not need to), call {@link getTheme}. TThemeManager may be configured within page service tag in application configuration file as follows, where {@link getCacheExpire CacheExpire}, {@link getCacheControl CacheControl} and {@link getBufferOutput BufferOutput} are configurable properties of THttpResponse.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends Prado\TModule
Mostra file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method Description
getAvailableThemes ( ) : array
getBasePath ( ) : string
getBaseUrl ( ) : string
getTheme ( $name ) : TTheme
getThemeClass ( ) : string
init ( $config ) Initializes the module.
setBasePath ( $value )
setBaseUrl ( $value )
setThemeClass ( string | null $class )

Method Details

getAvailableThemes() public method

public getAvailableThemes ( ) : array
return array list of available theme names

getBasePath() public method

public getBasePath ( ) : string
return string the base path for all themes. It is returned as an absolute path.

getBaseUrl() public method

public getBaseUrl ( ) : string
return string the base URL for all themes.

getTheme() public method

public getTheme ( $name ) : TTheme
return TTheme the theme retrieved

getThemeClass() public method

public getThemeClass ( ) : string
return string Theme class name in namespace format. Defaults to {@link TThemeManager::DEFAULT_THEMECLASS DEFAULT_THEMECLASS}.

init() public method

This method is required by IModule and is invoked by application.
public init ( $config )

setBasePath() public method

public setBasePath ( $value )

setBaseUrl() public method

public setBaseUrl ( $value )

setThemeClass() public method

public setThemeClass ( string | null $class )
$class string | null Theme class name in namespace format