1. class
  2. Thelia
  3. Core
  4. Event
  5. Hook
  6. HookRenderEvent

HookRenderEvent

class HookRenderEvent extends BaseHookRenderEvent

HookRenderEvent is used by the hook template engine plugin function.

Class HookRenderEvent

Methods

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

No description

$this
setCode( string $code)

Set the code of the hook

from  BaseHookRenderEvent
string
getCode()

Get the code of the hook

from  BaseHookRenderEvent
$this
setArguments( array $arguments)

Set all arguments

from  BaseHookRenderEvent
array
getArguments()

Get all arguments

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

add or replace an argument

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

Get an argument

from  BaseHookRenderEvent
bool
hasArgument($key)

Check if an argument exists with this key

from  BaseHookRenderEvent
$this
add( string $content)

Add a new fragment

array
get()

Get an array of all the fragments

string
dump( string $glue = '', string $before = '', string $after = '')

Concatenates all fragments in a string.

Details

at line 27
__construct($code, array $arguments = array())

Parameters

$code
array $arguments

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 39
$this add( string $content)

Add a new fragment

Parameters

string $content

Return Value

$this

at line 51
array get()

Get an array of all the fragments

Return Value

array

at line 64
string dump( string $glue = '', string $before = '', string $after = '')

Concatenates all fragments in a string.

Parameters

string $glue the glue between fragments
string $before the text before the concatenated string
string $after the text after the concatenated string

Return Value

string the concatenate string