Диспечер
класс Dispatcher реализует Dispatcher (View source)
Свойства
| protected Container | $container | Экземпляр контейнера IoC. | |
| protected array | $listeners | Зарегистрированные слушатели событий. | |
| protected array | $wildcards | Слушатели с подстановочными знаками. | |
| protected callable | $queueResolver | Экземпляр обработчика очереди. |
Методы
| void | __construct(Container $container = null) Создать новый экземпляр диспечера событий. | |
| void | listen(string|array $events, mixed $listener) Зарегистрировать слушателя события в диспечере. | |
| void | setupWildcardListen(string $event, mixed $listener) Настроить слушателя с подстановочным знаком. | |
| bool | hasListeners(string $eventName) Определить, есть ли слушатели для данного события. | |
| void | push(string $event, array $payload = []) Зарегистрировать событие и полезную нагрузку для последующего срабатывания. | |
| void | flush(string $event) Очистить набор отложенных событий. | |
| void | subscribe(object|string $subscriber) Зарегистрировать подписчика событий в диспечере. | |
| mixed | resolveSubscriber(object|string $subscriber) Разрешить экземпляр подписчика. | |
| array|null | until(string|object $event, mixed $payload = []) Срабатывать событие до тех пор, пока не будет возвращен первый ненулевой ответ. | |
| array|null | fire(string|object $event, mixed $payload = [], bool $halt = false) Сгенерировать событие и вызвать слушателей. | |
| array|null | dispatch(string|object $event, mixed $payload = [], bool $halt = false) Сгенерировать событие и вызвать слушателей. | |
| array | parseEventAndPayload(mixed $event, mixed $payload) Обработать заданное событие и полезную нагрузку и подготовить их к отправке. | |
| bool | shouldBroadcast(array $payload) Определить, содержит ли полезная нагрузка транслируемое событие. | |
| bool | broadcastWhen(mixed $event) Проверить, должно ли событие транслироваться по условию. | |
| void | broadcastEvent(ShouldBroadcast $event) Транслировать указанный класс события. | |
| array | getListeners(string $eventName) Получить всех слушателей для данного имени события. | |
| array | getWildcardListeners(string $eventName) Получить слушателей с подстановочными знаками для события. | |
| array | addInterfaceListeners(string $eventName, array $listeners = []) Добавить слушателей для интерфейсов события в заданный массив. | |
| Closure | makeListener(string|Closure $listener, bool $wildcard = false) Зарегистрировать слушателя события в диспечере. | |
| Closure | createClassListener(string $listener, bool $wildcard = false) Создать слушателя на основе класса, используя контейнер IoC. | |
| callable | createClassCallable(string $listener) Создать вызываемый объект события на основе класса. | |
| array | parseClassCallable(string $listener) Разобрать слушателя класса на класс и метод. | |
| bool | handlerShouldBeQueued(string $class) Определить, должен ли обработчик события быть помещен в очередь. | |
| Closure | createQueuedHandlerCallable(string $class, string $method) Создать вызываемый объект для помещения обработчика события в очередь. | |
| void | callQueueMethodOnHandler(string $class, string $method, array $arguments) Вызвать метод очереди для обработчика класса. | |
| void | queueHandler(string $class, string $method, array $arguments) Поместить обработчик класса в очередь. | |
| array | createListenerAndJob(string $class, string $method, array $arguments) Создать слушателя и задачу для слушателя в очереди. | |
| mixed | propogateListenerOptions(mixed $listener, mixed $job) Распространить параметры слушателя на задачу. | |
| void | forget(string $event) Удалить набор слушателей из диспечера. | |
| void | forgetPushed() Забыть всех отложенных слушателей. | |
| Queue | resolveQueue() Получить реализацию очереди из обработчика. | |
| $this | setQueueResolver(callable $resolver) Установить реализацию обработчика очереди. |
Подробное описание
void __construct(Container $container = null)
Создать новый экземпляр диспечера событий.
void listen(string|array $events, mixed $listener)
Зарегистрировать слушателя события в диспечере.
protected void setupWildcardListen(string $event, mixed $listener)
Настроить слушателя с подстановочным знаком.
bool hasListeners(string $eventName)
Определить, есть ли слушатели для данного события.
void push(string $event, array $payload = [])
Зарегистрировать событие и полезную нагрузку для последующего запуска.
void flush(string $event)
Очистить набор отложенных событий.
void subscribe(object|string $subscriber)
Зарегистрировать подписчика на события с диспетчером.
protected mixed resolveSubscriber(object|string $subscriber)
Разрешить экземпляр подписчика.
array|null until(string|object $event, mixed $payload = [])
Запустить событие до получения первого ненулевого ответа.
array|null fire(string|object $event, mixed $payload = [], bool $halt = false)
Запустить событие и вызвать слушателей.
array|null dispatch(string|object $event, mixed $payload = [], bool $halt = false)
Запустить событие и вызвать слушателей.
protected array parseEventAndPayload(mixed $event, mixed $payload)
Проанализировать заданное событие и полезную нагрузку и подготовить их к отправке.
protected bool shouldBroadcast(array $payload)
Определить, содержит ли полезная нагрузка транслируемое событие.
protected bool broadcastWhen(mixed $event)
Проверка, должно ли событие транслироваться по условию.
protected void broadcastEvent(ShouldBroadcast $event)
Транслировать указанный класс события.
array getListeners(string $eventName)
Получить всех слушателей для заданного имени события.
protected array getWildcardListeners(string $eventName)
Получить слушателей с подстановочными знаками для события.
protected array addInterfaceListeners(string $eventName, array $listeners = [])
Добавить слушателей для интерфейсов события в заданный массив.
Closure makeListener(string|Closure $listener, bool $wildcard = false)
Зарегистрировать слушателя событий с диспетчером.
Closure createClassListener(string $listener, bool $wildcard = false)
Создать слушателя на основе класса с использованием контейнера IoC.
protected callable createClassCallable(string $listener)
Создать вызываемый объект на основе класса.
protected array parseClassCallable(string $listener)
Разбить слушателя класса на класс и метод.
protected bool handlerShouldBeQueued(string $class)
Определить, должен ли обработчик событий быть помещён в очередь.
protected Closure createQueuedHandlerCallable(string $class, string $method)
Создать вызываемый объект для размещения обработчика событий в очереди.
protected void callQueueMethodOnHandler(string $class, string $method, array $arguments)
Вызвать метод очереди в классе-обработчике.
protected void queueHandler(string $class, string $method, array $arguments)
Разместить класс-обработчик в очереди.
protected array createListenerAndJob(string $class, string $method, array $arguments)
Создать обработчик и задачу для обработчика в очереди.
protected mixed propogateListenerOptions(mixed $listener, mixed $job)
Передать параметры обработчика в задачу.
void forget(string $event)
Удалить набор обработчиков из диспетчера.
void forgetPushed()
Забыть все добавленные обработчики.
protected Queue resolveQueue()
Получить реализацию очереди из резолвера.
$this setQueueResolver(callable $resolver)
Установить реализацию резолвера очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Events/Dispatcher.html
