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

Afficher le fichier Open project: pradosoft/prado Class Usage Examples

Méthodes publiques

Méthode	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 méthode

public getAvailableThemes ( ) : array
Résultat	array	list of available theme names

getBasePath() public méthode

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

getBaseUrl() public méthode

public getBaseUrl ( ) : string
Résultat	string	the base URL for all themes.

getTheme() public méthode

public getTheme ( $name ) : TTheme
Résultat	TTheme	the theme retrieved

getThemeClass() public méthode

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

init() public méthode

This method is required by IModule and is invoked by application.

public init ( $config )

setBasePath() public méthode

public setBasePath ( $value )

setBaseUrl() public méthode

public setBaseUrl ( $value )

setThemeClass() public méthode

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