Filter

Full name: \Qubus\EventDispatcher\ActionFilter\Filter
Parent class: \Qubus\EventDispatcher\ActionFilter\BaseHooks
This class is marked as final and can't be subclassed
This class implements: \Qubus\EventDispatcher\ActionFilter\Filterable, \Qubus\EventDispatcher\ActionFilter\RemoveAllFilters
This class is a Final class

Properties

value

Holds the value of the filter.

protected mixed $value

Methods

addFilter

Adds a filter.

public addFilter(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 filter.
`$arguments`	int	Number of arguments to accept.

applyFilter

Runs a filter.

public applyFilter(mixed $args): mixed

Parameters:

Parameter	Type	Description
`$args`	mixed	First argument will be the name of the hook, and the rest will be args for the hook.

Throws:

Exception

removeFilter

Removes a filter.

public removeFilter(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 filter.

removeAllFilters

Removes all filters.

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

Parameters:

Parameter	Type	Description
`$hook`	string\|null	Hook name.

trigger

Filters a value.

protected trigger(string $filter, mixed $args): mixed

When a filter is triggered, all hooks are run in the order supplied when adding them.

Parameters:

Parameter	Type	Description
`$filter`	string	Name of filter.
`$args`	mixed	Arguments passed to the filter.

Return Value:

Returns value or false on error.

Throws:

Exception

Inherited 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:

Exception

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

2025-10-132025-10-13