1. trait
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Eloquent
  7. \
  8. Concerns
  9. \
  10. HasEvents

HasEvents

trait HasEvents

Properties

protected array $events

The event map for the model.
protected array $observables

User exposed observable events.

Methods

static void
observe(object|string $class)

Register an 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
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
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.

Details

at line 33
static void observe(object|string $class)

Register an observer with the Model.

Parameters

object|string $class

Return Value

void

at line 54
array getObservableEvents()

Get the observable event names.

Return Value

array

at line 72
$this setObservableEvents(array $observables)

Set the observable event names.

Parameters

array $observables

Return Value

$this

at line 85
void addObservableEvents(array|mixed $observables)

Add an observable event name.

Parameters

array|mixed $observables

Return Value

void

at line 98
void removeObservableEvents(array|mixed $observables)

Remove an observable event name.

Parameters

array|mixed $observables

Return Value

void

at line 112
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

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

Fire the given event for the model.

Parameters

string $event
bool $halt

Return Value

mixed

at line 159
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

at line 178
protected mixed filterModelEventResults(mixed $result)

Filter the model event results.

Parameters

mixed $result

Return Value

mixed

at line 195
static void saving(Closure|string $callback)

Register a saving model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 206
static void saved(Closure|string $callback)

Register a saved model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 217
static void updating(Closure|string $callback)

Register an updating model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 228
static void updated(Closure|string $callback)

Register an updated model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 239
static void creating(Closure|string $callback)

Register a creating model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 250
static void created(Closure|string $callback)

Register a created model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 261
static void deleting(Closure|string $callback)

Register a deleting model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 272
static void deleted(Closure|string $callback)

Register a deleted model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 282
static void flushEventListeners()

Remove all of the event listeners for the model.

Return Value

void

at line 300
static Dispatcher getEventDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher

at line 311
static void setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance.

Parameters

Dispatcher $dispatcher

Return Value

void

at line 321
static void unsetEventDispatcher()

Unset the event dispatcher for models.

Return Value

void