Craft Themes (4.x)

TemplateBlockOptions extends BlockOptions
in package

Options for the template block

Table of Contents

EVENT_OPTIONS_DEFINITIONS  = 'options-definitions'
$_block  : BlockInterface
$_defaultValues  : array<string|int, mixed>
$_definitions  : array<string|int, mixed>
$_values  : array<string|int, mixed>
__get()  : mixed
__isset()  : mixed
__set()  : mixed
attributes()  : mixed
defineDefaultValues()  : array<string|int, mixed>
defineOptions()  : array<string|int, mixed>
defineRules()  : array<string|int, mixed>
fields()  : array<string|int, mixed>
getBlock()  : BlockInterface
Block getter
getConfig()  : array<string|int, mixed>
getDefaultValues()  : array<string|int, mixed>
Get all default values
getDefinitions()  : array<string|int, mixed>
Get the options definitions.
getValue()  : mixed
Get the value for an option
getValues()  : array<string|int, mixed>
Get all values
hasOption()  : bool
Is an options defined
replaceValues()  : mixed
Replace all values
setBlock()  : mixed
Block setter
setValue()  : mixed
Set value for an option
setValues()  : mixed
Set all values
register()  : mixed
Register options definitions and default values
reservedWords()  : array<string|int, mixed>
Reserved words that options can't take

Constants

Properties

Methods

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Tags
inheritDoc
Return values
mixed —

__isset()

public __isset(mixed $name) : mixed
Parameters
$name : mixed
Tags
inheritDoc
Return values
mixed —

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Tags
inheritDoc
Return values
mixed —

attributes()

public attributes() : mixed
Tags
inheritDoc
Return values
mixed —

defineDefaultValues()

public defineDefaultValues() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed> —

defineOptions()

public defineOptions() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed> —

defineRules()

public defineRules() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed> —

fields()

public fields() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed> —

getConfig()

public getConfig() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed> —

getDefaultValues()

Get all default values

public getDefaultValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getDefinitions()

Get the options definitions.

public getDefinitions() : array<string|int, mixed>

Throws an event to allow other plugins to modify the options

Return values
array<string|int, mixed> —

getValue()

Get the value for an option

public getValue(string $name) : mixed
Parameters
$name : string
Return values
mixed —

getValues()

Get all values

public getValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —

hasOption()

Is an options defined

public hasOption(string $name) : bool
Parameters
$name : string
Return values
bool —

replaceValues()

Replace all values

public replaceValues(array<string|int, mixed> $values) : mixed
Parameters
$values : array<string|int, mixed>
Return values
mixed —

setValue()

Set value for an option

public setValue(string $name, mixed $value) : mixed
Parameters
$name : string
$value : mixed
Return values
mixed —

setValues()

Set all values

public setValues(array<string|int, mixed> $values) : mixed
Parameters
$values : array<string|int, mixed>
Return values
mixed —

register()

Register options definitions and default values

protected register() : mixed
Return values
mixed —

reservedWords()

Reserved words that options can't take

protected reservedWords() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results