class Keys (View source)

The Keys class provides all methods to search all kind of content variables (keys of the data array) used in templates.

Properties

static $reserved Array with reserved variable keys.

Methods

static array
filterTextKeys(array $keys)

Get text variable keys from an array of keys.

static array
filterSettingKeys(array $keys)

Get settings variable keys from an array of keys.

static array
inCurrentTemplate(object $Page)

Find all variable keys in the currently used template and all included snippets (and ignore those keys in $this->reserved).

static array
inTemplate(string $file)

Find all variable keys in a template and all included snippets (and ignore those keys in $this->reserved).

static array
inTheme(object $Theme)

Find all variable keys in templates of a given theme.

Details

static array filterTextKeys(array $keys)

Get text variable keys from an array of keys.

Parameters

array $keys

Return Value

array The array with only text variables.

static array filterSettingKeys(array $keys)

Get settings variable keys from an array of keys.

Parameters

array $keys

Return Value

array The array with only settings variables.

static array inCurrentTemplate(object $Page)

Find all variable keys in the currently used template and all included snippets (and ignore those keys in $this->reserved).

Parameters

object $Page

Return Value

array Keys in the currently used template (without reserved keys)

static array inTemplate(string $file)

Find all variable keys in a template and all included snippets (and ignore those keys in $this->reserved).

Parameters

string $file

Return Value

array Keys in a given template (without reserved keys)

static array inTheme(object $Theme)

Find all variable keys in templates of a given theme.

Parameters

object $Theme

Return Value

array Keys in all templates of the given Theme (without reserved keys)