Broadcaster
abstract class Broadcaster implements Broadcaster (View source)
Properties
| protected array | $channels | The registered channel authenticators. | |
| protected array | $channelOptions | The registered channel options. | |
| protected BindingRegistrar | $bindingRegistrar | The binding registrar instance. |
Methods
| $this | channel(string $channel, callable|string $callback, array $options = []) Register a channel authenticator. | |
| mixed | verifyUserCanAccessChannel(Request $request, string $channel) Authenticate the incoming request for a given channel. | |
| array | extractAuthParameters(string $pattern, string $channel, callable|string $callback) Extract the parameters from the given pattern and channel. | |
| ReflectionParameter[] | extractParameters(callable|string $callback) Extracts the parameters out of what the user passed to handle the channel authentication. | |
| ReflectionParameter[] | extractParametersFromClass(string $callback) Extracts the parameters out of a class channel's "join" method. | |
| array | extractChannelKeys(string $pattern, string $channel) Extract the channel keys from the incoming channel name. | |
| mixed | resolveBinding(string $key, string $value, array $callbackParameters) Resolve the given parameter binding. | |
| mixed | resolveExplicitBindingIfPossible(string $key, mixed $value) Resolve an explicit parameter binding if applicable. | |
| mixed | resolveImplicitBindingIfPossible(string $key, mixed $value, array $callbackParameters) Resolve an implicit parameter binding if applicable. | |
| bool | isImplicitlyBindable(string $key, ReflectionParameter $parameter) Determine if a given key and parameter is implicitly bindable. | |
| array | formatChannels(array $channels) Format the channel array into an array of strings. | |
| BindingRegistrar | binder() Get the model binding registrar instance. | |
| callable | normalizeChannelHandlerToCallable(mixed $callback) Normalize the given callback into a callable. | |
| mixed | retrieveUser(Request $request, string $channel) Retrieve the authenticated user using the configured guard (if any). | |
| array | retrieveChannelOptions(string $channel) Retrieve options for a certain channel. | |
| bool | channelNameMatchesPattern(string $channel, string $pattern) Check if channel name from request match a pattern from registered channels. |
Details
$this channel(string $channel, callable|string $callback, array $options = [])
Register a channel authenticator.
protected mixed verifyUserCanAccessChannel(Request $request, string $channel)
Authenticate the incoming request for a given channel.
protected array extractAuthParameters(string $pattern, string $channel, callable|string $callback)
Extract the parameters from the given pattern and channel.
protected ReflectionParameter[] extractParameters(callable|string $callback)
Extracts the parameters out of what the user passed to handle the channel authentication.
protected ReflectionParameter[] extractParametersFromClass(string $callback)
Extracts the parameters out of a class channel's "join" method.
protected array extractChannelKeys(string $pattern, string $channel)
Extract the channel keys from the incoming channel name.
protected mixed resolveBinding(string $key, string $value, array $callbackParameters)
Resolve the given parameter binding.
protected mixed resolveExplicitBindingIfPossible(string $key, mixed $value)
Resolve an explicit parameter binding if applicable.
protected mixed resolveImplicitBindingIfPossible(string $key, mixed $value, array $callbackParameters)
Resolve an implicit parameter binding if applicable.
protected bool isImplicitlyBindable(string $key, ReflectionParameter $parameter)
Determine if a given key and parameter is implicitly bindable.
protected array formatChannels(array $channels)
Format the channel array into an array of strings.
protected BindingRegistrar binder()
Get the model binding registrar instance.
protected callable normalizeChannelHandlerToCallable(mixed $callback)
Normalize the given callback into a callable.
protected mixed retrieveUser(Request $request, string $channel)
Retrieve the authenticated user using the configured guard (if any).
protected array retrieveChannelOptions(string $channel)
Retrieve options for a certain channel.
protected bool channelNameMatchesPattern(string $channel, string $pattern)
Check if channel name from request match a pattern from registered channels.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Broadcasting/Broadcasters/Broadcaster.html