ThemeDirectories

Implements \ThemeDirectoriesInterface

Class ThemeDirectories

package

Default

Methods

ThemeDirectories constructor.

__construct(\ThemeDirectoryRootInterface $root) 

Arguments

$root

\ThemeDirectoryRootInterface

Path to root directory of theme.

Named constructor of ThemeDirectories.

create(\ThemeDirectoryRootInterface $root) : \ThemeDirectories
static

Arguments

$root

\ThemeDirectoryRootInterface

Path to root directory of theme.

Response

\ThemeDirectories

New instance.

Returns the config theme directory.

getConfig() : \ThemeDirectoryInterface

Return the custom HTML directory

getCustomHtml() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Return the custom scripts directory

getCustomJs() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Return the custom styles directory

getCustomStyles() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Return the HTML directory

getHtml() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the images directory.

getImages() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Return the scripts directory

getJs() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the script extension directory

getJsExtensions() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Return the directory root

getRoot() : \ThemeDirectoryRootInterface

Returns the style edit theme directory.

getStyleEdit() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Return the styles directory

getStyles() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Tries to create an instance of ThemeDirectory by the given root- and sub path.

tryBuildThemeDirectory(\ThemeDirectoryRootInterface $root, string $path) : null|\ThemeDirectory

If no directory was found, null will be returned.

Arguments

$root

\ThemeDirectoryRootInterface

Path to root directory of theme.

$path

string

Sub directory path.

Response

null|\ThemeDirectory

Theme directory instance if given path exists.

Properties

Directory root

root : \ThemeDirectoryRootInterface

Configuration directory.

config : \ThemeDirectory
var

Type(s)

\ThemeDirectory

HTML directory

html : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

JavaScript directory

js : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

Styles directory

styles : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

Style Edit directory.

styleEdit : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

Images directory

images : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

Custom HTML directory

customHtml : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

Custom JS directory

customJs : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

Custom styles directory

customStyles : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null

script extension directory

jsExtensions : \ThemeDirectory|null
var

Type(s)

\ThemeDirectory|null