Theme
in package
implements
ThemeInterface
Class Theme
Interfaces, Classes and Traits
- ThemeInterface
- Interface ThemeInterface
Table of Contents
- $directories : ThemeDirectoriesInterface
- Theme directories
- $id : ThemeId
- Theme ID
- $parentTheme : null|Theme
- Parent theme
- __construct() : mixed
- Theme constructor.
- create() : Theme
- Create theme instance
- getConfig() : ThemeDirectoryInterface
- Returns the config theme directory.
- getCustomHtml() : ThemeDirectory|null
- Returns the custom HTML directory.
- getCustomJs() : ThemeDirectory|null
- Returns the custom scripts directory.
- getCustomStyles() : ThemeDirectory|null
- Returns the custom styles directory.
- getFonts() : ThemeDirectory|null
- Returns the fonts directory.
- getHtml() : ThemeDirectory|null
- Returns the HTML directory.
- getId() : ThemeId
- Returns the theme id
- getImages() : ThemeDirectory|null
- Returns the images directory.
- getJs() : ThemeDirectory|null
- Returns the scripts directory.
- getJsExtensions() : ThemeDirectory|null
- Returns the script extension directory
- getParentTheme() : Theme|null
- Return the parent theme
- getPrefix() : ThemeDirectoriesInterface|null
- Returns the variants directory
- getRoot() : ThemeDirectoryRootInterface
- Returns the directory. root
- getStyleEdit() : ThemeDirectory|null
- Returns the style edit theme directory.
- getStyles() : ThemeDirectory|null
- Returns the styles directory.
- getVariants() : ThemeDirectoriesInterface|null
- Returns the variants directory
- hasParent() : bool
- Return whether there is a parent theme
- toMainTheme() : MainThemeInterface
- Convert to main theme
Properties
$directories
Theme directories
protected
ThemeDirectoriesInterface
$directories
$id
Theme ID
protected
ThemeId
$id
$parentTheme
Parent theme
protected
null|Theme
$parentTheme
Methods
__construct()
Theme constructor.
public
__construct(ThemeId $id, ThemeDirectoriesInterface $directories[, ThemeInterface|null $parentTheme = null ]) : mixed
Parameters
- $id : ThemeId
-
Theme ID
- $directories : ThemeDirectoriesInterface
-
Theme directories
- $parentTheme : ThemeInterface|null = null
-
Parent theme
Return values
mixed —create()
Create theme instance
public
static create(ThemeId $id, ThemeDirectoriesInterface $directories[, ThemeInterface|null $parentTheme = null ]) : Theme
Parameters
- $id : ThemeId
-
Theme ID
- $directories : ThemeDirectoriesInterface
-
Theme directories
- $parentTheme : ThemeInterface|null = null
-
Parent theme
Return values
Theme —New instance.
getConfig()
Returns the config theme directory.
public
getConfig() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —getCustomHtml()
Returns the custom HTML directory.
public
getCustomHtml() : ThemeDirectory|null
Return values
ThemeDirectory|null —getCustomJs()
Returns the custom scripts directory.
public
getCustomJs() : ThemeDirectory|null
Return values
ThemeDirectory|null —getCustomStyles()
Returns the custom styles directory.
public
getCustomStyles() : ThemeDirectory|null
Return values
ThemeDirectory|null —getFonts()
Returns the fonts directory.
public
getFonts() : ThemeDirectory|null
Return values
ThemeDirectory|null —getHtml()
Returns the HTML directory.
public
getHtml() : ThemeDirectory|null
Return values
ThemeDirectory|null —getId()
Returns the theme id
public
getId() : ThemeId
Return values
ThemeId —getImages()
Returns the images directory.
public
getImages() : ThemeDirectory|null
Return values
ThemeDirectory|null —getJs()
Returns the scripts directory.
public
getJs() : ThemeDirectory|null
Return values
ThemeDirectory|null —getJsExtensions()
Returns the script extension directory
public
getJsExtensions() : ThemeDirectory|null
Return values
ThemeDirectory|null —getParentTheme()
Return the parent theme
public
getParentTheme() : Theme|null
Return values
Theme|null —getPrefix()
Returns the variants directory
public
getPrefix() : ThemeDirectoriesInterface|null
Return values
ThemeDirectoriesInterface|null —getRoot()
Returns the directory. root
public
getRoot() : ThemeDirectoryRootInterface
Return values
ThemeDirectoryRootInterface —getStyleEdit()
Returns the style edit theme directory.
public
getStyleEdit() : ThemeDirectory|null
Return values
ThemeDirectory|null —getStyles()
Returns the styles directory.
public
getStyles() : ThemeDirectory|null
Return values
ThemeDirectory|null —getVariants()
Returns the variants directory
public
getVariants() : ThemeDirectoriesInterface|null
Return values
ThemeDirectoriesInterface|null —hasParent()
Return whether there is a parent theme
public
hasParent() : bool
Return values
bool —toMainTheme()
Convert to main theme
public
toMainTheme() : MainThemeInterface