Диспечер
класс Диспечер реализует Диспечер (Просмотреть исходный код)
Трейты
| Макрообъект |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Макрообъекта |
| защищенный Контейнер | $container | Экземпляр контейнера IoC. | |
| защищенный массив | $listeners | Зарегистрированные обработчики событий. | |
| защищенный массив | $wildcards | Обработчики с подстановочными знаками. | |
| защищенный массив | $wildcardsCache | Кэшированные обработчики с подстановочными знаками. | |
| защищенный вызываемый объект | $queueResolver | Экземпляр решателя очереди. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверить, зарегистрировано ли макро. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обработать вызовы к классу. | from Macroable |
| void | __construct(Container $container = null)
Создать новый экземпляр диспетчера событий. | |
| void | listen(string|array $events, Closure|string $listener)
Зарегистрировать обработчик событий с диспетчером. | |
| void | setupWildcardListen(string $event, Closure|string $listener)
Настроить обработчик с подстановкой. | |
| bool | hasListeners(string $eventName)
Определить, есть ли обработчики для данного события. | |
| bool | hasWildcardListeners(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 | 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(Closure|string $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)
Создать вызываемый объект для помещения обработчика события в очередь. | |
| bool | handlerWantsToBeQueued(string $class, array $arguments)
Определить, хочет ли обработчик события быть помещен в очередь. | |
| void | queueHandler(string $class, string $method, array $arguments)
Поместить обработчик класса в очередь. | |
| array | createListenerAndJob(string $class, string $method, array $arguments)
Создать обработчик и задание для обработчика в очереди. | |
| mixed | propagateListenerOptions(mixed $listener, mixed $job)
Распространить параметры обработчика на задание. | |
| void | forget(string $event)
Удалить набор обработчиков из диспетчера. | |
| void | forgetPushed()
Удалить все отложенные обработчики. | |
| Factory | resolveQueue()
Получить реализацию очереди из решателя. | |
| $this | setQueueResolver(callable $resolver)
Установить реализацию решателя очереди. |
Details
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
void __construct(Container $container = null)
Создать новый экземпляр диспетчера событий.
void listen(string|array $events, Closure|string $listener)
Зарегистрировать обработчик событий в диспетчере.
protected void setupWildcardListen(string $event, Closure|string $listener)
Настройка обратного вызова обработчика с подстановочным знаком.
bool hasListeners(string $eventName)
Определить, есть ли обработчики для заданного события.
bool hasWildcardListeners(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 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)
Транслировать указанный класс события.
массив getListeners(строка $eventName)
Получить всех слушателей для заданного имени события.
защищённый массив getWildcardListeners(строка $eventName)
Получить слушателей с подстановочными символами для события.
защищённый массив addInterfaceListeners(строка $eventName, массив $listeners = [])
Добавить слушателей для интерфейсов события в данный массив.
Closure makeListener(Closure|строка $listener, bool $wildcard = false)
Зарегистрировать слушателя события в диспетчере.
Closure createClassListener(строка $listener, bool $wildcard = false)
Создать слушателя на основе класса, используя контейнер IoC.
защищённый вызываемый объект createClassCallable(строка $listener)
Создать вызываемый объект для события на основе класса.
защищённый массив parseClassCallable(строка $listener)
Разбор слушателя класса на класс и метод.
защищённый bool handlerShouldBeQueued(строка $class)
Определить, должен ли обработчик события быть помещён в очередь.
защищённый Closure createQueuedHandlerCallable(строка $class, строка $method)
Создать вызываемый объект для помещения обработчика события в очередь.
защищённый bool handlerWantsToBeQueued(строка $class, массив $arguments)
Определить, хочет ли обработчик события быть помещён в очередь.
защищённый void queueHandler(строка $class, строка $method, массив $arguments)
Поместить обработчик класса в очередь.
защищённый массив createListenerAndJob(строка $class, строка $method, массив $arguments)
Создать слушателя и задачу для слушателя в очереди.
защищённый смешанный propagateListenerOptions(смешанный $listener, смешанный $job)
Распространить опции слушателя на задачу.
void forget(строка $event)
Удалить набор слушателей из диспетчера.
void forgetPushed()
Забыть все помещённые слушателей.
защищённый Factory resolveQueue()
Получить реализацию очереди из решателя.
$this setQueueResolver(вызываемый объект $resolver)
Установить реализацию решателя очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Events/Dispatcher.html