PHP Class flight\core\Dispatcher

Afficher le fichier Open project: mikecao/flight Class Usage Examples

Protected Properties

Свойство Type Description
$events array Mapped events.
$filters array Method filters.

Méthodes publiques

Méthode Description
callFunction ( string $func, array &$params = [] ) : mixed Calls a function.
clear ( string $name = null ) Clears an event. If no name is given, all events are removed.
execute ( callback $callback, array &$params = [] ) : mixed Executes a callback function.
filter ( array $filters, array &$params, mixed &$output ) Executes a chain of method filters.
get ( string $name ) : callback Gets an assigned callback.
has ( string $name ) : boolean Checks if an event has been set.
hook ( string $name, string $type, callback $callback ) Hooks a callback to an event.
invokeMethod ( mixed $func, array &$params = [] ) : mixed Invokes a method.
reset ( ) Resets the object to the initial state.
run ( string $name, array $params = [] ) : string Dispatches an event.
set ( string $name, callback $callback ) Assigns a callback to an event.

Method Details

callFunction() public static méthode

Calls a function.
public static callFunction ( string $func, array &$params = [] ) : mixed
$func string Name of function to call
$params array Function parameters
Résultat mixed Function results

clear() public méthode

Clears an event. If no name is given, all events are removed.
public clear ( string $name = null )
$name string Event name

execute() public static méthode

Executes a callback function.
public static execute ( callback $callback, array &$params = [] ) : mixed
$callback callback Callback function
$params array Function parameters
Résultat mixed Function results

filter() public méthode

Executes a chain of method filters.
public filter ( array $filters, array &$params, mixed &$output )
$filters array Chain of filters
$params array Method parameters
$output mixed Method output

get() public méthode

Gets an assigned callback.
public get ( string $name ) : callback
$name string Event name
Résultat callback $callback Callback function

has() public méthode

Checks if an event has been set.
public has ( string $name ) : boolean
$name string Event name
Résultat boolean Event status

hook() public méthode

Hooks a callback to an event.
public hook ( string $name, string $type, callback $callback )
$name string Event name
$type string Filter type
$callback callback Callback function

invokeMethod() public static méthode

Invokes a method.
public static invokeMethod ( mixed $func, array &$params = [] ) : mixed
$func mixed Class method
$params array Class method parameters
Résultat mixed Function results

reset() public méthode

Resets the object to the initial state.
public reset ( )

run() public méthode

Dispatches an event.
public run ( string $name, array $params = [] ) : string
$name string Event name
$params array Callback parameters
Résultat string Output of callback

set() public méthode

Assigns a callback to an event.
public set ( string $name, callback $callback )
$name string Event name
$callback callback Callback function

Property Details

$events protected_oe property

Mapped events.
protected array $events
Résultat array

$filters protected_oe property

Method filters.
protected array $filters
Résultat array