MainThemeDirectories
extends VariableThemeDirectories
in package
implements
MainThemeDirectoriesInterface
Class MainThemeDirectories
Interfaces, Classes and Traits
- MainThemeDirectoriesInterface
- Interface MainThemeDirectoriesInterface
Table of Contents
- $config : ThemeDirectory
- $fonts : ThemeDirectory
- $html : ThemeDirectory
- $images : ThemeDirectory
- $js : ThemeDirectory
- $prefix : string
- $root : ThemeDirectoryRootInterface
- $styleEdit : ThemeDirectory
- $styles : ThemeDirectory
- $variant : ThemeDirectory
- $variants : ThemeDirectory|null
- variants directory
- __construct() : mixed
- MainThemeDirectories constructor.
- create() : MainThemeDirectories
- Named constructor of MainThemeDirectories.
- getConfig() : ThemeDirectoryInterface
- Returns the config theme directory.
- getFonts() : ThemeDirectoryInterface
- Returns the fonts theme directory.
- getHtml() : ThemeDirectoryInterface
- Returns the html theme directory.
- getImages() : ThemeDirectory|null
- Returns the images directory.
- getJs() : ThemeDirectoryInterface
- Returns the js theme directory.
- getPrefix() : string
- getRoot() : ThemeDirectoryRootInterface
- Returns the directory root.
- getStyleEdit() : ThemeDirectory|null
- Returns the style edit theme directory.
- getStyles() : ThemeDirectoryInterface
- Returns the styles theme directory.
- getVariants() : ThemeDirectory|null
- Returns the variants directory
- tryBuildThemeDirectory() : null|ThemeDirectory
- Tries to create an instance of ThemeDirectory by the given root- and sub path.
Properties
$config
protected
ThemeDirectory
$config
$fonts
protected
ThemeDirectory
$fonts
$html
protected
ThemeDirectory
$html
$images
protected
ThemeDirectory
$images
$js
protected
ThemeDirectory
$js
$prefix
protected
string
$prefix
$root
protected
ThemeDirectoryRootInterface
$root
$styleEdit
protected
ThemeDirectory
$styleEdit
$styles
protected
ThemeDirectory
$styles
$variant
protected
ThemeDirectory
$variant
$variants
variants directory
protected
ThemeDirectory|null
$variants
Methods
__construct()
MainThemeDirectories constructor.
public
__construct(ThemeDirectoryRootInterface $root) : mixed
Parameters
- $root : ThemeDirectoryRootInterface
-
Path to root of theme.
Return values
mixed —create()
Named constructor of MainThemeDirectories.
public
static create(ThemeDirectoryRootInterface $root) : MainThemeDirectories
Parameters
- $root : ThemeDirectoryRootInterface
Return values
MainThemeDirectories —New instance.
getConfig()
Returns the config theme directory.
public
getConfig() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —getFonts()
Returns the fonts theme directory.
public
getFonts() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —getHtml()
Returns the html theme directory.
public
getHtml() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —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 —getPrefix()
public
getPrefix() : string
Return values
string —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 theme directory.
public
getStyles() : ThemeDirectoryInterface
Return values
ThemeDirectoryInterface —getVariants()
Returns the variants directory
public
getVariants() : ThemeDirectory|null
Return values
ThemeDirectory|null —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.