Skin
in package
Skin Base class Used for defining skins.
Tags
Table of Contents
- $defaultPublicSkinPath : string
- $defaultSkinPath : string
- $publicSkinPath : string
- $skinPath : string
- $skinCache : self
- __construct() : mixed
- Constructor.
- getActive() : mixed
- Returns the active skin.
- getLayoutPaths() : array<string|int, mixed>
- Returns an array of paths where skin layouts can be found.
- getPath() : string
- Looks up a path to a skin-based file, if it doesn't exist, the default path is used.
- skinDetails() : mixed
- Returns information about this skin, including name and description.
Properties
$defaultPublicSkinPath
public
string
$defaultPublicSkinPath
The default public skin path.
$defaultSkinPath
public
string
$defaultSkinPath
The default skin path, usually the root level of modules/backend.
$publicSkinPath
public
string
$publicSkinPath
The public path to this skin.
$skinPath
public
string
$skinPath
The absolute path to this skin.
$skinCache
private
static self
$skinCache
Cache of the active skin.
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —getActive()
Returns the active skin.
public
static getActive() : mixed
Return values
mixed —getLayoutPaths()
Returns an array of paths where skin layouts can be found.
public
getLayoutPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPath()
Looks up a path to a skin-based file, if it doesn't exist, the default path is used.
public
getPath([string $path = null ][, bool $isPublic = false ]) : string
Parameters
- $path : string = null
- $isPublic : bool = false
Return values
string —skinDetails()
Returns information about this skin, including name and description.
public
abstract skinDetails() : mixed