abstract class Broadcaster implements Broadcaster (View source)
| protected Closure|null | $authenticatedUserCallback | The callback to resolve the authenticated user information. | |
| protected array | $channels | The registered channel authenticators. | |
| protected array | $channelOptions | The registered channel options. | |
| protected BindingRegistrar | $bindingRegistrar | The binding registrar instance. |
| array|null | resolveAuthenticatedUser(Request $request)
Resolve the authenticated user payload for the incoming connection request. | |
| void | resolveAuthenticatedUserUsing(Closure $callback)
Register the user retrieval callback used to authenticate connections. | |
| $this | channel(HasBroadcastChannel|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 the channel name from the request matches a pattern from registered channels. | |
| Collection | getChannels()
Get all of the registered channels. |
Resolve the authenticated user payload for the incoming connection request.
See: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.
Register the user retrieval callback used to authenticate connections.
See: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.
Register a channel authenticator.
Authenticate the incoming request for a given channel.
Extract the parameters from the given pattern and channel.
Extracts the parameters out of what the user passed to handle the channel authentication.
Extracts the parameters out of a class channel's "join" method.
Extract the channel keys from the incoming channel name.
Resolve the given parameter binding.
Resolve an explicit parameter binding if applicable.
Resolve an implicit parameter binding if applicable.
Determine if a given key and parameter is implicitly bindable.
Format the channel array into an array of strings.
Get the model binding registrar instance.
Normalize the given callback into a callable.
Retrieve the authenticated user using the configured guard (if any).
Retrieve options for a certain channel.
Check if the channel name from the request matches a pattern from registered channels.
Get all of the registered channels.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Broadcasting/Broadcasters/Broadcaster.html