API Documentation
Back to top  

Theme

Implements \ThemeInterface

Class Theme

package

Default

Methods

Theme constructor.

__construct(\ThemeId $id, \ThemeDirectoriesInterface $directories, \ThemeInterface|null $parentTheme = null)

Arguments

$id

\ThemeId

Theme ID

$directories

\ThemeDirectoriesInterface

Theme directories

$parentTheme

\ThemeInterface|null

Parent theme

Create theme instance

create(\ThemeId $id, \ThemeDirectoriesInterface $directories, \ThemeInterface|null $parentTheme = null) : \Theme
static

Arguments

$id

\ThemeId

Theme ID

$directories

\ThemeDirectoriesInterface

Theme directories

$parentTheme

\ThemeInterface|null

Parent theme

Response

\Theme

New instance.

Returns the config theme directory.

getConfig() : \ThemeDirectoryInterface

Response

\ThemeDirectoryInterface

Returns the custom HTML directory.

getCustomHtml() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the custom scripts directory.

getCustomJs() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the custom styles directory.

getCustomStyles() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the fonts directory.

getFonts() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the HTML directory.

getHtml() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the theme id

getId() : \ThemeId

Response

\ThemeId

Returns the images directory.

getImages() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the scripts directory.

getJs() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the script extension directory

getJsExtensions() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Return the parent theme

getParentTheme() : \Theme|null

Response

\Theme|null

Returns the variants directory

getPrefix() : \ThemeDirectoriesInterface|null

Response

\ThemeDirectoriesInterface|null

Returns the directory. root

getRoot() : \ThemeDirectoryRootInterface

Response

\ThemeDirectoryRootInterface

Returns the style edit theme directory.

getStyleEdit() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the styles directory.

getStyles() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the variants directory

getVariants() : \ThemeDirectoriesInterface|null

Response

\ThemeDirectoriesInterface|null

Return whether there is a parent theme

hasParent() : boolean

Response

boolean

Convert to main theme

toMainTheme() : \MainThemeInterface

Response

\MainThemeInterface

Properties

Theme ID

id : \ThemeId
var

Type(s)

\ThemeId

Theme directories

directories : \ThemeDirectoriesInterface
var

Type(s)

\ThemeDirectoriesInterface

Parent theme

parentTheme : null|\Theme
var

Type(s)

null|\Theme