Class \Prado\Web\UI\TTheme

TTheme class

TTheme represents a particular theme. It is merely a collection of skins that are applicable to the corresponding controls.

Each theme is stored as a directory and files under that directory. The theme name is the directory name. When TTheme is created, the files whose name has the extension ".skin" are parsed and saved as controls skins.

A skin is essentially a list of initial property values that are to be applied to a control when the skin is applied. TSkinTemplate is used to turn off class and attribute validation. Each type of control can have multiple skins identified by the SkinID. If a skin does not have SkinID, it is the default skin that will be applied to controls that do not specify particular SkinID.

For globalization, Themes remove all css files that end in ".*rtl.css" or ".*rtl.(media).css". Then if there is Application Globalization, and globalization current culture is Right-to-left then the rtl css files are re-added at the end of the css files so rtl css has priority.

Whenever possible, TTheme will try to make use of available cache to save the parsing time.

To apply a theme to a particular control, call applySkin.

Class hierarchy

\Prado\Web\UI\TTheme implements ITheme

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct(string $themePath, string $themeUrl) : mixed` Constructor.
`public`	`applySkin(TControl $control) : bool` Applies the theme to a particular control. The control's class name and SkinID value will be used to identify which skin to be applied. If the control's SkinID is empty, the default skin will be applied.
`public`	`getBasePath() : string`
`public`	`getBaseUrl() : string`
`public`	`getJavaScriptFiles() : array<string\|int, mixed>`
`public`	`getName() : string`
`public`	`getSkins() : array<string\|int, mixed>`
`public`	`getStyleSheetFiles() : array<string\|int, mixed>`
`protected`	`postProcessCssRTL() : mixed` This post-processes the theme for RTL. It loops through all the css files, removes all the '.rtl.css' and '.rtl.(media).css' files, then if there is globalization and globalization is RTL then re-adds the rtl css at the end.
`protected`	`setBasePath(string $value) : mixed`
`protected`	`setBaseUrl(string $value) : mixed`
`protected`	`setJavaScriptFiles(array<string\|int, mixed> $value) : mixed`
`protected`	`setName(string $value) : mixed`
`protected`	`setSkins(array<string\|int, mixed> $value) : mixed`
`protected`	`setStyleSheetFiles(array<string\|int, mixed> $value) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, publishAsset, publishFilePath, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Constants summary
`public mixed`	`SKIN_FILE_EXT` Extension name of skin files	`'.skin'`
`public mixed`	`THEME_CACHE_PREFIX` prefix for cache variable name used to store parsed themes	`'prado:theme:'`

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\TTheme

Class hierarchy