API Documentation » \BaseThemeDirectories

package	Default

BaseThemeDirectories constructor.

__construct(\ThemeDirectoryRootInterface $root)

Arguments

$root

\ThemeDirectoryRootInterface

Returns the fonts directory.

getFonts() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the html theme directory.

getHtml() : \ThemeDirectoryInterface

Response

\ThemeDirectoryInterface

Returns the images directory.

getImages() : \ThemeDirectory|null

Response

\ThemeDirectory|null

Returns the js theme directory.

getJs() : \ThemeDirectoryInterface

Response

\ThemeDirectoryInterface

getPrefix

getPrefix() : string

Response

string

Returns the directory root.

getRoot() : \ThemeDirectoryRootInterface

Response

\ThemeDirectoryRootInterface

Returns the styles theme directory.

getStyles() : \ThemeDirectoryInterface

Response

\ThemeDirectoryInterface

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.

Fonts directory

fonts : \ThemeDirectory|null

var

Type(s)

\ThemeDirectory|null

html

html : \ThemeDirectory

var

Type(s)

\ThemeDirectory

js

js : \ThemeDirectory

var

Type(s)

\ThemeDirectory

styles

styles : \ThemeDirectory

var

Type(s)

\ThemeDirectory

images

images : \ThemeDirectory

var

Type(s)

\ThemeDirectory

prefix

prefix : string

var

Type(s)

string

root

root : \ThemeDirectoryRootInterface

var

Type(s)

\ThemeDirectoryRootInterface

BaseThemeDirectories

Methods

BaseThemeDirectories constructor.

Arguments

$root

Returns the fonts directory.

Response

Returns the html theme directory.

Response

Returns the images directory.

Response

Returns the js theme directory.

Response

getPrefix

Response

Returns the directory root.

Response

Returns the styles theme directory.

Response

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

Arguments

$root

$path

Response

Properties

Fonts directory

Type(s)

html

Type(s)

js

Type(s)

styles

Type(s)

images

Type(s)

prefix

Type(s)

root

Type(s)