Elgg
Version 4.3
|
Models an event passed to hook handlers. More...
Public Member Functions | |
getName () | |
Get the name of the hook. More... | |
getType () | |
Get the type of the hook. More... | |
getValue () | |
Get the current value of the hook. More... | |
getParams () | |
Get the parameters passed to the trigger call. More... | |
getParam ($key, $default=null) | |
Get an element of the params array. More... | |
getEntityParam () | |
Gets the "entity" key from the params if it holds an Elgg entity. More... | |
getUserParam () | |
Gets the "user" key from the params if it holds an Elgg user. More... | |
elgg () | |
Get the DI container. More... | |
Elgg\Hook::elgg | ( | ) |
Elgg\Hook::getEntityParam | ( | ) |
Gets the "entity" key from the params if it holds an Elgg entity.
Implemented in Elgg\HooksRegistrationService\Hook.
Elgg\Hook::getName | ( | ) |
Elgg\Hook::getParam | ( | $key, | |
$default = null |
|||
) |
Get an element of the params array.
If the params array is not an array, the default will always be returned.
string | $key | The key of the value in the params array |
mixed | $default | The value to return if missing |
Implemented in Elgg\HooksRegistrationService\Hook.
Elgg\Hook::getParams | ( | ) |
Get the parameters passed to the trigger call.
Implemented in Elgg\HooksRegistrationService\Hook.
Elgg\Hook::getType | ( | ) |
Elgg\Hook::getUserParam | ( | ) |
Gets the "user" key from the params if it holds an Elgg user.
Implemented in Elgg\HooksRegistrationService\Hook.
Elgg\Hook::getValue | ( | ) |