BroadcastManager

класс BroadcastManager реализует Factory mixin Broadcaster (View source)

Свойства

protected Container	$app	Экземпляр приложения.
protected array	$drivers	Массив разрешённых драйверов broadcast.
protected array	$customCreators	Зарегистрированные пользовательские создатели драйверов.

Методы

void

__construct(Container $app)

Создать новый экземпляр менеджера.

void

routes(array $attributes = null)

Зарегистрировать маршруты для обработки broadcast аутентификации и сокетов.

string|null

socket(Request|null $request = null)

Получить ID сокета для данного запроса.

PendingBroadcast

event(mixed|null $event = null)

Начать трансляцию события.

void

queue(mixed $event)

Поместить данное событие в очередь для трансляции.

Broadcaster

connection(string|null $driver = null)

Получить экземпляр драйвера.

mixed

driver(string|null $name = null)

Получить экземпляр драйвера.

Broadcaster

get(string $name)

Попытка получить соединение из локального кэша.

Broadcaster

resolve(string $name)

Разрешить заданный broadcaster.

mixed

callCustomCreator(array $config)

Вызвать пользовательский создатель драйвера.

Broadcaster

createPusherDriver(array $config)

Создать экземпляр драйвера.

Broadcaster

createAblyDriver(array $config)

Создать экземпляр драйвера.

Broadcaster

createRedisDriver(array $config)

Создать экземпляр драйвера.

Broadcaster

createLogDriver(array $config)

Создать экземпляр драйвера.

Broadcaster

createNullDriver(array $config)

Создать экземпляр драйвера.

array

getConfig(string $name)

Получить конфигурацию соединения.

string

getDefaultDriver()

Получить имя драйвера по умолчанию.

void

setDefaultDriver(string $name)

Установить имя драйвера по умолчанию.

void

purge(string|null $name = null)

Отключить данный диск и удалить из локального кэша.

$this

extend(string $driver, Closure $callback)

Зарегистрировать пользовательскую функцию-создатель драйвера.

Application

getApplication()

Получить экземпляр приложения, используемый менеджером.

$this

setApplication(Application $app)

Установить экземпляр приложения, используемый менеджером.

$this

forgetDrivers()

Забыть все разрешённые экземпляры драйверов.

mixed

__call(string $method, array $parameters)

Динамически вызвать экземпляр драйвера по умолчанию.

Подробности

void __construct(Container $app)

Создать новый экземпляр менеджера.

Параметры

Container

$app

Возвращаемое значение

void

void routes(array $attributes = null)

Зарегистрировать маршруты для обработки broadcast аутентификации и сокетов.

Параметры

array

$attributes

Возвращаемое значение

void

string|null socket(Request|null $request = null)

Получить ID сокета для данного запроса.

Параметры

Request|null

$request

Возвращаемое значение

string|null

PendingBroadcast event(mixed|null $event = null)

Начать трансляцию события.

Параметры

mixed|null

$event

Возвращаемое значение

PendingBroadcast

void queue(mixed $event)

Поместить данное событие в очередь для трансляции.

Параметры

mixed

$event

Возвращаемое значение

void

Broadcaster connection(string|null $driver = null)

Получить экземпляр драйвера.

Параметры

string|null

$driver

Возвращаемое значение

Broadcaster

mixed driver(string|null $name = null)

Получить экземпляр драйвера.

Параметры

string|null

$name

Возвращаемое значение

mixed

protected Broadcaster get(string $name)

Попробовать получить соединение из локального кэша.

Параметры

string

$name

Возвращаемое значение

Broadcaster

protected Broadcaster resolve(string $name)

Разрешить указанный драйвер.

Параметры

string

$name

Возвращаемое значение

Broadcaster

Исключения

InvalidArgumentException

protected mixed callCustomCreator(array $config)

Вызвать пользовательского создателя драйвера.

Параметры

array

$config

Возвращаемое значение

mixed

protected Broadcaster createPusherDriver(array $config)

Создать экземпляр драйвера.

Параметры

array

$config

Возвращаемое значение

Broadcaster

protected Broadcaster createAblyDriver(array $config)

Создать экземпляр драйвера.

Параметры

array

$config

Возвращаемое значение

Broadcaster

protected Broadcaster createRedisDriver(array $config)

Создать экземпляр драйвера.

Параметры

array

$config

Возвращаемое значение

Broadcaster

protected Broadcaster createLogDriver(array $config)

Создать экземпляр драйвера.

Параметры

array

$config

Возвращаемое значение

Broadcaster

protected Broadcaster createNullDriver(array $config)

Создать экземпляр драйвера.

Параметры

array

$config

Возвращаемое значение

Broadcaster

protected array getConfig(string $name)

Получить конфигурацию соединения.

Параметры

string

$name

Возвращаемое значение

array

string getDefaultDriver()

Получить имя драйвера по умолчанию.

Возвращаемое значение

string

void setDefaultDriver(string $name)

Установить имя драйвера по умолчанию.

Параметры

string

$name

Возвращаемое значение

void

void purge(string|null $name = null)

Отключить указанный диск и удалить из локального кэша.

Параметры

string|null

$name

Возвращаемое значение

void

$this extend(string $driver, Closure $callback)

Зарегистрировать пользовательскую функцию-замыкание для создания драйвера.

Параметры

string	$driver
Closure	$callback

Возвращаемое значение

$this

Application getApplication()

Получить экземпляр приложения, используемый менеджером.

Возвращаемое значение

Application

$this setApplication(Application $app)

Установить экземпляр приложения, используемый менеджером.

Параметры

Application

$app

Возвращаемое значение

$this

$this forgetDrivers()

Забыть все разрешенные экземпляры драйвера.

Возвращаемое значение

$this

mixed __call(string $method, array $parameters)

Динамически вызвать экземпляр драйвера по умолчанию.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Broadcasting/BroadcastManager.html