Broadcaster

# resolveAuthenticatedUser ( $request ) : array|null

Resolve the authenticated user payload for the incoming connection request.

Parameters

• $request Request

# resolveAuthenticatedUserUsing ( Closure $callback ) : void

Register the user retrieval callback used to authenticate connections.

Parameters

• $callback Closure

# channel ( $channel , $callback , $options ) : $this

Register a channel authenticator.

Parameters

• $channel HasBroadcastChannel |string
• $callback callable|string
• $options array

# verifyUserCanAccessChannel ( $request , $channel ) : mixed

Authenticate the incoming request for a given channel.

Parameters

• $request Request
• $channel string

# extractAuthParameters ( $pattern , $channel , $callback ) : array

Extract the parameters from the given pattern and channel.

Parameters

• $pattern string
• $channel string
• $callback callable|string

# extractParameters ( $callback ) : ReflectionParameter[]

Extracts the parameters out of what the user passed to handle the channel authentication.

Parameters

• $callback callable|string

# extractParametersFromClass ( $callback ) : ReflectionParameter[]

Extracts the parameters out of a class channel's "join" method.

Parameters

• $callback string

# extractChannelKeys ( $pattern , $channel ) : array

Extract the channel keys from the incoming channel name.

Parameters

• $pattern string
• $channel string

# resolveBinding ( $key , $value , $callbackParameters ) : mixed

Resolve the given parameter binding.

Parameters

• $key string
• $value string
• $callbackParameters array

# resolveExplicitBindingIfPossible ( $key , $value ) : mixed

Resolve an explicit parameter binding if applicable.

Parameters

• $key string
• $value mixed

# resolveImplicitBindingIfPossible ( $key , $value , $callbackParameters ) : mixed

Resolve an implicit parameter binding if applicable.

Parameters

• $key string
• $value mixed
• $callbackParameters array

# isImplicitlyBindable ( $key , $parameter ) : bool

Determine if a given key and parameter is implicitly bindable.

Parameters

• $key string
• $parameter ReflectionParameter

# formatChannels ( array $channels ) : array

Format the channel array into an array of strings.

Parameters

• $channels array

# binder ( ) : BindingRegistrar

Get the model binding registrar instance.

# normalizeChannelHandlerToCallable ( $callback ) : callable

Normalize the given callback into a callable.

Parameters

• $callback mixed

# retrieveUser ( $request , $channel ) : mixed

Retrieve the authenticated user using the configured guard (if any).

Parameters

• $request Request
• $channel string

# retrieveChannelOptions ( $channel ) : array

Retrieve options for a certain channel.

Parameters

• $channel string

# channelNameMatchesPattern ( $channel , $pattern ) : bool

Check if the channel name from the request matches a pattern from registered channels.

Parameters

• $channel string
• $pattern string

# getChannels ( ) : Illuminate\...\Collection

Get all of the registered channels.