class Theme (View source)

The Theme type is a custom data type that stores all meta data of an installed theme.

Properties

$author The theme author.
$description The theme description.
$license The theme license.
$masks A multidimensional mask array.
$name The theme name.
$path The theme path.
$readme The theme readme path.
$templates The templates array.
$tooltips The tooltips array.
$version The theme version.

Methods

__construct(string $themeJSON, array $composerInstalled)

The constructor.

array
getMask(string $mask)

Get the UI mask (page or shared) for hiding variables in the dashboard.

string
getTooltip(string $key)

Return the tooltip for the requested variable name (key in the data array).

Details

__construct(string $themeJSON, array $composerInstalled)

The constructor.

Parameters

string $themeJSON
array $composerInstalled

array getMask(string $mask)

Get the UI mask (page or shared) for hiding variables in the dashboard.

Parameters

string $mask "page" or "shared"

Return Value

array The mask array

string getTooltip(string $key)

Return the tooltip for the requested variable name (key in the data array).

Parameters

string $key

Return Value

string The tooltip text