HasEvents

trait HasEvents (View source)

Properties

protected array $dispatchesEvents The event map for the model.
protected array $observables User exposed observable events.

Methods

static void observe(object|array|string $classes)

Register observers with the model.
void registerObserver(object|string $class)

Register a single observer with the model.
array getObservableEvents()

Get the observable event names.
$this setObservableEvents(array $observables)

Set the observable event names.
void addObservableEvents(array|mixed $observables)

Add an observable event name.
void removeObservableEvents(array|mixed $observables)

Remove an observable event name.
static void registerModelEvent(string $event, Closure|string $callback)

Register a model event with the dispatcher.
mixed fireModelEvent(string $event, bool $halt = true)

Fire the given event for the model.
mixed|null fireCustomModelEvent(string $event, string $method)

Fire a custom model event for the given event.
mixed filterModelEventResults(mixed $result)

Filter the model event results.
static void retrieved(Closure|string $callback)

Register a retrieved model event with the dispatcher.
static void saving(Closure|string $callback)

Register a saving model event with the dispatcher.
static void saved(Closure|string $callback)

Register a saved model event with the dispatcher.
static void updating(Closure|string $callback)

Register an updating model event with the dispatcher.
static void updated(Closure|string $callback)

Register an updated model event with the dispatcher.
static void creating(Closure|string $callback)

Register a creating model event with the dispatcher.
static void created(Closure|string $callback)

Register a created model event with the dispatcher.
static void replicating(Closure|string $callback)

Register a replicating model event with the dispatcher.
static void deleting(Closure|string $callback)

Register a deleting model event with the dispatcher.
static void deleted(Closure|string $callback)

Register a deleted model event with the dispatcher.
static void flushEventListeners()

Remove all of the event listeners for the model.
static Dispatcher getEventDispatcher()

Get the event dispatcher instance.
static void setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance.
static void unsetEventDispatcher()

Unset the event dispatcher for models.
static mixed withoutEvents(callable $callback)

Execute a callback without firing any model events for any model type.

Details

static void observe(object|array|string $classes)

Register observers with the model.

Parameters

object|array|string $classes

Return Value

void

Exceptions

RuntimeException

protected void registerObserver(object|string $class)

Register a single observer with the model.

Parameters

object|string $class

Return Value

void

Exceptions

RuntimeException

array getObservableEvents()

Get the observable event names.

Return Value

array

$this setObservableEvents(array $observables)

Set the observable event names.

Parameters

array $observables

Return Value

$this

void addObservableEvents(array|mixed $observables)

Add an observable event name.

Parameters

array|mixed $observables

Return Value

void

void removeObservableEvents(array|mixed $observables)

Remove an observable event name.

Parameters

array|mixed $observables

Return Value

void

static protected void registerModelEvent(string $event, Closure|string $callback)

Register a model event with the dispatcher.

Parameters

string $event
Closure|string $callback

Return Value

void

protected mixed fireModelEvent(string $event, bool $halt = true)

Fire the given event for the model.

Parameters

string $event
bool $halt

Return Value

mixed

protected mixed|null fireCustomModelEvent(string $event, string $method)

Fire a custom model event for the given event.

Parameters

string $event
string $method

Return Value

mixed|null

protected mixed filterModelEventResults(mixed $result)

Filter the model event results.

Parameters

mixed $result

Return Value

mixed

static void retrieved(Closure|string $callback)

Register a retrieved model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void saving(Closure|string $callback)

Register a saving model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void saved(Closure|string $callback)

Register a saved model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void updating(Closure|string $callback)

Register an updating model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void updated(Closure|string $callback)

Register an updated model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void creating(Closure|string $callback)

Register a creating model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void created(Closure|string $callback)

Register a created model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void replicating(Closure|string $callback)

Register a replicating model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void deleting(Closure|string $callback)

Register a deleting model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void deleted(Closure|string $callback)

Register a deleted model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

static void flushEventListeners()

Remove all of the event listeners for the model.

Return Value

void

static Dispatcher getEventDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance.

Parameters

Dispatcher $dispatcher

Return Value

void

static void unsetEventDispatcher()

Unset the event dispatcher for models.

Return Value

void

static mixed withoutEvents(callable $callback)

Execute a callback without firing any model events for any model type.

Parameters

callable $callback

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Database/Eloquent/Concerns/HasEvents.html