class HookRenderBlockEvent extends BaseHookRenderEvent

Class HookRenderBlockEvent

Methods

__construct($code, array $arguments = array(), array $fields = array())

No description

$this
setCode( string $code)

Set the code of the hook

string
getCode()

Get the code of the hook

$this
setArguments( array $arguments)

Set all arguments

array
getArguments()

Get all arguments

$this
setArgument( string $key, string $value)

add or replace an argument

mixed|null
getArgument( string $key, string|null $default = null)

Get an argument

bool
hasArgument($key)

Check if an argument exists with this key

$this
add( array $data)

Add a new fragment as an array

$this
addFragment( Fragment $fragment)

Add a new fragment

get()

Get all contents

array
getFields()

No description

setFields( array $fields)

No description

Details

at line 31
__construct($code, array $arguments = array(), array $fields = array())

Parameters

$code
array $arguments
array $fields

in BaseHookRenderEvent at line 43
$this setCode( string $code)

Set the code of the hook

Parameters

string $code

Return Value

$this

in BaseHookRenderEvent at line 55
string getCode()

Get the code of the hook

Return Value

string

in BaseHookRenderEvent at line 66
$this setArguments( array $arguments)

Set all arguments

Parameters

array $arguments

Return Value

$this

in BaseHookRenderEvent at line 78
array getArguments()

Get all arguments

Return Value

array all arguments

in BaseHookRenderEvent at line 90
$this setArgument( string $key, string $value)

add or replace an argument

Parameters

string $key
string $value

Return Value

$this

in BaseHookRenderEvent at line 103
mixed|null getArgument( string $key, string|null $default = null)

Get an argument

Parameters

string $key
string|null $default

Return Value

mixed|null the value of the argument or $default if it not exists

in BaseHookRenderEvent at line 114
bool hasArgument($key)

Check if an argument exists with this key

Parameters

$key

Return Value

bool true if it exists, else false

at line 44
$this add( array $data)

Add a new fragment as an array

Parameters

array $data

Return Value

$this

at line 59
$this addFragment( Fragment $fragment)

Add a new fragment

Parameters

Fragment $fragment

Return Value

$this

at line 74
FragmentBag get()

Get all contents

Return Value

FragmentBag

at line 82
array getFields()

Return Value

array

at line 90
setFields( array $fields)

Parameters

array $fields