PHP Класс flight\core\Dispatcher

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$events array Mapped events.
$filters array Method filters.

Открытые методы

Метод Описание
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.

Описание методов

callFunction() публичный статический Метод

Calls a function.
public static callFunction ( string $func, array &$params = [] ) : mixed
$func string Name of function to call
$params array Function parameters
Результат mixed Function results

clear() публичный Метод

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

execute() публичный статический Метод

Executes a callback function.
public static execute ( callback $callback, array &$params = [] ) : mixed
$callback callback Callback function
$params array Function parameters
Результат mixed Function results

filter() публичный Метод

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() публичный Метод

Gets an assigned callback.
public get ( string $name ) : callback
$name string Event name
Результат callback $callback Callback function

has() публичный Метод

Checks if an event has been set.
public has ( string $name ) : boolean
$name string Event name
Результат boolean Event status

hook() публичный Метод

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() публичный статический Метод

Invokes a method.
public static invokeMethod ( mixed $func, array &$params = [] ) : mixed
$func mixed Class method
$params array Class method parameters
Результат mixed Function results

reset() публичный Метод

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

run() публичный Метод

Dispatches an event.
public run ( string $name, array $params = [] ) : string
$name string Event name
$params array Callback parameters
Результат string Output of callback

set() публичный Метод

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

Описание свойств

$events защищенное свойство

Mapped events.
protected array $events
Результат array

$filters защищенное свойство

Method filters.
protected array $filters
Результат array