Skip to content

BaseHooks

  • Full name: \Qubus\EventDispatcher\ActionFilter\BaseHooks
  • This class is an Abstract class

Constants

Constant Visibility Type Value
PRIORITY_NEUTRAL public int 10
ARGUMENT_NEUTRAL public int 1

Properties

hooks

Holds the event hooks.

protected array $hooks

Methods

listen

Adds a hook.

public listen(string $hook, mixed $callback, int $priority = self::PRIORITY_NEUTRAL, int $arguments = self::ARGUMENT_NEUTRAL): \Qubus\EventDispatcher\ActionFilter\BaseHooks

Parameters:

Parameter Type Description
$hook string Hook name.
$callback mixed Function to execute.
$priority int Priority of the action.
$arguments int Number of arguments to accept.

remove

Removes a hook.

public remove(string $hook, mixed $callback, int $priority = self::PRIORITY_NEUTRAL): void

Parameters:

Parameter Type Description
$hook string Hook name.
$callback mixed Function to execute.
$priority int Priority of the action.

removeAll

Remove all hooks with given hook in collection. If no hook, clear all hooks.

public removeAll(string|null $hook = null): void

Parameters:

Parameter Type Description
$hook string|null Hook name.

getHooks

Gets a sorted list of all hooks.

public getHooks(): array

getFunction

Gets the function.

protected getFunction(mixed $callback): callable

Parameters:

Parameter Type Description
$callback mixed Callback.

Return Value:

A closure

Throws:

createHook

Figures out the hook.

protected createHook(mixed $args): \stdClass

Will return an object with two keys. One for the name and one for the arguments that will be passed to the hook itself.

Parameters:

Parameter Type Description
$args mixed

trigger

Fires a new action/filter.

protected trigger(string $action, mixed $args): mixed
  • This method is abstract.

Parameters:

Parameter Type Description
$action string Name of action
$args mixed Arguments passed to the action

Automatically generated on 2025-10-13