VariantDirectories
extends BaseThemeDirectories
in package
implements
VariantDirectoriesInterface
Uses
CustomThemeDirectoriesTrait
Class VariantDirectories
Interfaces, Classes and Traits
- VariantDirectoriesInterface
- Interface ThemeVariantInterface
Table of Contents
- $customHtml : ThemeDirectory|null
- Custom HTML directory
- $customJs : ThemeDirectory|null
- Custom JS directory
- $customStyles : ThemeDirectory|null
- Custom styles directory
- $fonts : ThemeDirectory|null
- Fonts directory
- $html : ThemeDirectory
- $id : ThemeId
- Theme ID
- $images : ThemeDirectory
- $js : ThemeDirectory
- $jsExtensions : ThemeDirectory|null
- script extension directory
- $prefix : string
- $root : ThemeDirectoryRootInterface
- $styles : ThemeDirectory
- __construct() : mixed
- VariantDirectories constructor.
- create() : bool|mixed|VariantDirectories
- createWithCustomPrefix() : VariantDirectories
- getCustomHtml() : ThemeDirectory|null
- Return the custom HTML directory
- getCustomJs() : ThemeDirectory|null
- Return the custom scripts directory
- getCustomStyles() : ThemeDirectory|null
- Return the custom styles directory
- getFonts() : ThemeDirectory|null
- Returns the fonts directory.
- getHtml() : ThemeDirectoryInterface
- Returns the html theme directory.
- getId() : ThemeId
- Returns the theme id
- getImages() : ThemeDirectory|null
- Returns the images directory.
- getJs() : ThemeDirectoryInterface
- Returns the js theme directory.
- getJsExtensions() : ThemeDirectory|null
- Returns the script extension directory
- getPrefix() : string
- getRoot() : ThemeDirectoryRootInterface
- Returns the directory root.
- getStyles() : ThemeDirectoryInterface
- Returns the styles theme directory.
- tryBuildThemeDirectory() : null|ThemeDirectory
- Tries to create an instance of ThemeDirectory by the given root- and sub path.
Properties
$customHtml
Custom HTML directory
protected
ThemeDirectory|null
$customHtml
$customJs
Custom JS directory
protected
ThemeDirectory|null
$customJs
$customStyles
Custom styles directory
protected
ThemeDirectory|null
$customStyles
$fonts
Fonts directory
protected
ThemeDirectory|null
$fonts
$html
protected
ThemeDirectory
$html
$id
Theme ID
protected
ThemeId
$id
$images
protected
ThemeDirectory
$images
$js
protected
ThemeDirectory
$js
$jsExtensions
script extension directory
protected
ThemeDirectory|null
$jsExtensions
$prefix
protected
string
$prefix
$root
protected
ThemeDirectoryRootInterface
$root
$styles
protected
ThemeDirectory
$styles
Methods
__construct()
VariantDirectories constructor.
public
__construct(ThemeDirectoryRootInterface $root) : mixed
Parameters
- $root : ThemeDirectoryRootInterface
Return values
mixed —create()
public
static create(ThemeDirectoryRootInterface $root) : bool|mixed|VariantDirectories
Parameters
- $root : ThemeDirectoryRootInterface
Return values
bool|mixed|VariantDirectories —createWithCustomPrefix()
public
static createWithCustomPrefix(ThemeDirectoryRootInterface $root, ThemeId $themeId) : VariantDirectories
Parameters
- $root : ThemeDirectoryRootInterface
- $themeId : ThemeId
Return values
VariantDirectories —getCustomHtml()
Return the custom HTML directory
public
getCustomHtml() : ThemeDirectory|null
Return values
ThemeDirectory|null —getCustomJs()
Return the custom scripts directory
public
getCustomJs() : ThemeDirectory|null
Return values
ThemeDirectory|null —getCustomStyles()
Return 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 theme directory.
public
getHtml() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —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 js theme directory.
public
getJs() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —getJsExtensions()
Returns the script extension directory
public
getJsExtensions() : ThemeDirectory|null
Return values
ThemeDirectory|null —getPrefix()
public
getPrefix() : string
Return values
string —getRoot()
Returns the directory root.
public
getRoot() : ThemeDirectoryRootInterface
Return values
ThemeDirectoryRootInterface —getStyles()
Returns the styles theme directory.
public
getStyles() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —tryBuildThemeDirectory()
Tries to create an instance of ThemeDirectory by the given root- and sub path.
protected
tryBuildThemeDirectory(ThemeDirectoryRootInterface $root, string $path) : null|ThemeDirectory
If no directory was found, null will be returned.
Parameters
- $root : ThemeDirectoryRootInterface
-
Path to root directory of theme.
- $path : string
-
Sub directory path.
Return values
null|ThemeDirectory —Theme directory instance if given path exists.