RoleAttachedEvent
class RoleAttachedEvent
Traits
Properties
| string|null | $socket | The socket ID for the user that raised the event. |
from InteractsWithSockets |
Methods
Dispatch the event with the given arguments.
Dispatch the event with the given arguments if the given truth test passes.
Dispatch the event with the given arguments unless the given truth test passes.
Broadcast the event with the given arguments.
Exclude the current user from receiving the broadcast.
Broadcast the event to everyone.
Get the property value prepared for serialization.
Get the restored property value after deserialization.
Get the query for model restoration.
Internally the HasRoles trait passes an array of role ids (e.g. ints or UUIDs).
Details
in
Dispatchable at line 14
static mixed
dispatch(mixed ...$arguments)
Dispatch the event with the given arguments.
in
Dispatchable at line 22
static mixed
dispatchIf(bool $boolean, mixed ...$arguments)
Dispatch the event with the given arguments if the given truth test passes.
in
Dispatchable at line 30
static mixed
dispatchUnless(bool $boolean, mixed ...$arguments)
Dispatch the event with the given arguments unless the given truth test passes.
in
Dispatchable at line 38
static PendingBroadcast
broadcast(mixed ...$arguments)
Broadcast the event with the given arguments.
in
InteractsWithSockets at line 19
InteractsWithSockets
dontBroadcastToCurrentUser()
Exclude the current user from receiving the broadcast.
in
InteractsWithSockets at line 29
InteractsWithSockets
broadcastToEveryone()
Broadcast the event to everyone.
in
SerializesAndRestoresModelIdentifiers at line 20
protected mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization.
in
SerializesAndRestoresModelIdentifiers at line 54
protected mixed
getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization.
in
SerializesAndRestoresModelIdentifiers at line 68
protected Collection
restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance.
in
SerializesAndRestoresModelIdentifiers at line 109
Model
restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance.
in
SerializesAndRestoresModelIdentifiers at line 123
protected Builder
getQueryForModelRestoration(Model $model, array|int|string $ids)
Get the query for model restoration.
in
SerializesModels at line 18
array
__serialize()
Prepare the instance values for serialization.
in
SerializesModels at line 68
void
__unserialize(array $values)
Restore the model after serialization.
in
SerializesModels at line 101
protected mixed
getPropertyValue(ReflectionProperty $property)
Get the property value for the given property.
at line 27
__construct(Model $model, mixed $rolesOrIds)
Internally the HasRoles trait passes an array of role ids (e.g. ints or UUIDs).
Theoretically one could register the event to other places passing other types. So a Listener should inspect the type of $rolesOrIds received before using.