VariantDirectories

Extends \BaseThemeDirectories Implements \VariantDirectoriesInterface

Class VariantDirectories

package

Default

Methods

BaseThemeDirectories constructor.

__construct(\ThemeDirectoryRootInterface $root) 
inherited

create

create(\ThemeDirectoryRootInterface $root) : boolean|mixed|\VariantDirectories
static

Arguments

Response

boolean|mixed|\VariantDirectories

createWithCustomPrefix

createWithCustomPrefix(\ThemeDirectoryRootInterface $root, \ThemeId $themeId) : \VariantDirectories
static

Arguments

$themeId

\ThemeId

Response

\VariantDirectories

Return the custom HTML directory

getCustomHtml() : \ThemeDirectory|null
inherited

Response

\ThemeDirectory|null

Return the custom scripts directory

getCustomJs() : \ThemeDirectory|null
inherited

Response

\ThemeDirectory|null

Return the custom styles directory

getCustomStyles() : \ThemeDirectory|null
inherited

Response

\ThemeDirectory|null

Returns the fonts directory.

getFonts() : \ThemeDirectory|null
inherited

Response

\ThemeDirectory|null

Returns the html theme directory.

getHtml() : \ThemeDirectoryInterface
inherited

Returns the theme id

getId() : \ThemeId

Response

\ThemeId

Returns the images directory.

getImages() : \ThemeDirectory|null
inherited

Response

\ThemeDirectory|null

Returns the js theme directory.

getJs() : \ThemeDirectoryInterface
inherited

Returns the script extension directory

getJsExtensions() : \ThemeDirectory|null
inherited

Response

\ThemeDirectory|null

getPrefix

getPrefix() : string
inherited

Response

string

Returns the directory root.

getRoot() : \ThemeDirectoryRootInterface
inherited

Returns the styles theme directory.

getStyles() : \ThemeDirectoryInterface
inherited

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

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

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

Theme ID

id : \ThemeId
var

Type(s)

\ThemeId

Custom HTML directory

customHtml : \ThemeDirectory|null
inherited
var

Type(s)

\ThemeDirectory|null

Custom JS directory

customJs : \ThemeDirectory|null
inherited
var

Type(s)

\ThemeDirectory|null

Custom styles directory

customStyles : \ThemeDirectory|null
inherited
var

Type(s)

\ThemeDirectory|null

script extension directory

jsExtensions : \ThemeDirectory|null
inherited
var

Type(s)

\ThemeDirectory|null

Fonts directory

fonts : \ThemeDirectory|null
inherited
var

Type(s)

\ThemeDirectory|null

html

html : \ThemeDirectory
inherited
var

Type(s)

\ThemeDirectory

js

js : \ThemeDirectory
inherited
var

Type(s)

\ThemeDirectory

styles

styles : \ThemeDirectory
inherited
var

Type(s)

\ThemeDirectory

images

images : \ThemeDirectory
inherited
var

Type(s)

\ThemeDirectory

prefix

prefix : string
inherited
var

Type(s)

string

root

root : \ThemeDirectoryRootInterface
inherited