The object passed to invokable class name handlers.
More...
The object passed to invokable class name handlers.
Definition at line 12 of file Hook.php.
Elgg\HooksRegistrationService\Hook::__construct |
( |
PublicContainer |
$dic, |
|
|
|
$name, |
|
|
|
$type, |
|
|
|
$value, |
|
|
|
$params |
|
) |
| |
Constructor.
- Parameters
-
PublicContainer | $dic | DI container |
string | $name | Hook name |
string | $type | Hook type |
mixed | $value | Hook value |
mixed | $params | Hook params |
Definition at line 31 of file Hook.php.
Elgg\HooksRegistrationService\Hook::elgg |
( |
| ) |
|
{Get the DI container.
- Returns
- PublicContainer
}
Implements Elgg\Hook.
Definition at line 115 of file Hook.php.
Elgg\HooksRegistrationService\Hook::getEntityParam |
( |
| ) |
|
{Gets the "entity" key from the params if it holds an Elgg entity.
- Returns
- |null
}
Implements Elgg\Hook.
Definition at line 93 of file Hook.php.
Elgg\HooksRegistrationService\Hook::getName |
( |
| ) |
|
{Get the name of the hook.
- Returns
- string
}
Implements Elgg\Hook.
Definition at line 42 of file Hook.php.
Elgg\HooksRegistrationService\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.
- Parameters
-
string | $key | The key of the value in the params array |
mixed | $default | The value to return if missing |
- Returns
- mixed
}
Implements Elgg\Hook.
Definition at line 82 of file Hook.php.
Elgg\HooksRegistrationService\Hook::getParams |
( |
| ) |
|
{Get the parameters passed to the trigger call.
- Returns
- mixed
}
Implements Elgg\Hook.
Definition at line 75 of file Hook.php.
Elgg\HooksRegistrationService\Hook::getType |
( |
| ) |
|
{Get the type of the hook.
- Returns
- string
}
Implements Elgg\Hook.
Definition at line 49 of file Hook.php.
Elgg\HooksRegistrationService\Hook::getUserParam |
( |
| ) |
|
{Gets the "user" key from the params if it holds an Elgg user.
- Returns
- |null
}
Implements Elgg\Hook.
Definition at line 104 of file Hook.php.
Elgg\HooksRegistrationService\Hook::getValue |
( |
| ) |
|
{Get the current value of the hook.
- Returns
- mixed
}
Implements Elgg\Hook.
Definition at line 56 of file Hook.php.
Elgg\HooksRegistrationService\Hook::setValue |
( |
|
$value | ) |
|
Update the value.
- Parameters
-
- Returns
- void
Definition at line 68 of file Hook.php.
const Elgg\HooksRegistrationService\Hook::EVENT_TYPE = 'hook' |
The documentation for this class was generated from the following file:
- engine/classes/Elgg/HooksRegistrationService/Hook.php