Observer does not listen to "trashed" event from Model

[duemti]

Laravel Version

12

PHP Version

8.3.6

Database Driver & Version

No response

Description

From my double checking the source code, the soft deletion of a model triggers "deleted" and "trashed" events.
But in my Observer for the Model i only catch the "deleted" event.
I tested with a direct Listener in a Providers boot method and it did catch the "trashed" event.

Why the Observer is not catching the "trashed" event?

Steps To Reproduce

Create a Model with Soft Delete Trait.

Create a Observer for the Model.

Register the Observer using ObservedBy attribute in Model class.

Add "public function trashed(Model $object): void" method to Observer class.

Soft delete a record from DB using the Model with delete()

The trashed() method from Observer is not triggered by Model "trashed" event and is not executed.

EDIT:
For anyone interested, i solved this by adding $observables to the model class that has SoftDeletes Trait:

protected $observables = [
    'trashed',
];

Also a pull request #54987

[lmottasin]

Could you share any doc links where it says when using soft delete trashed event is fired. @duemti

[macropay-solutions]

Might be related #53616

[duemti]

Although it doesn't say exactly that, it is in the list of events fired by a model. Here

And just as i pointed in my opening post that i tested it directly that it fired indeed!

Also i understood so by my reading of source code of SoftDeletes Trait and Model Class.

Here is excerpt from Model.class source code responsible:

/**
     * Delete the model from the database.
     *
     * @return bool|null
     *
     * @throws \LogicException
     */
    public function delete()
    {
        $this->mergeAttributesFromCachedCasts();
        if (is_null($this->getKeyName())) {
            throw new LogicException('No primary key defined on model.');
        }
        // If the model doesn't exist, there is nothing to delete so we'll just return
        // immediately and not do anything else. Otherwise, we will continue with a
        // deletion process on the model, firing the proper events, and so forth.
        if (! $this->exists) {
            return;
        }
        if ($this->fireModelEvent('deleting') === false) {
            return false;
        }
        // Here, we'll touch the owning models, verifying these timestamps get updated
        // for the models. This will allow any caching to get broken on the parents
        // by the timestamp. Then we will go ahead and delete the model instance.
        $this->touchOwners();
        $this->performDeleteOnModel();
        // Once the model has been deleted, we will fire off the deleted event so that
        // the developers may hook into post-delete operations. We will then return
        // a boolean true as the delete is presumably successful on the database.
        $this->fireModelEvent('deleted', false);
        return true;
    }

Here is the excerpt from SoftDeletes Trait calss (with the over-written method 'performDeleteOnModel()'):

   /**
    * Perform the actual delete query on this model instance.
    *
    * @return mixed
    */
   protected function performDeleteOnModel()
   {
       if ($this->forceDeleting) {
           return tap($this->setKeysForSaveQuery($this->newModelQuery())->forceDelete(), function () {
               $this->exists = false;
           });
       }
       return $this->runSoftDelete();
   }

   /**
    * Perform the actual delete query on this model instance.
    *
    * @return void
    */
   protected function runSoftDelete()
   {
       $query = $this->setKeysForSaveQuery($this->newModelQuery());
       $time = $this->freshTimestamp();
       $columns = [$this->getDeletedAtColumn() => $this->fromDateTime($time)];
       $this->{$this->getDeletedAtColumn()} = $time;
       if ($this->usesTimestamps() && ! is_null($this->getUpdatedAtColumn())) {
           $this->{$this->getUpdatedAtColumn()} = $time;
           $columns[$this->getUpdatedAtColumn()] = $this->fromDateTime($time);
       }
       $query->update($columns);
       $this->syncOriginalAttributes(array_keys($columns));
       $this->fireModelEvent('trashed', false); //---------------------------------- HERE THE EVENT IS FIRED !!!
   }

Do you notice the $this->fireModelEvent('trashed', false); line?

So $model->delete() would call the overwritten performDeleteOnModel() which will call runSoftDelete() in which the "trashed" event is fired.

Also why are asking me that? I found the docs are not the best place to get all the info needed.
Do you not agree here that the docs are a little ambiguous here?
Alas, if you know something about this event just say it please! Wasted too much time on this already than i should.

[crynobone]

This is not a hug and observer documentation may need to include that it only register events under "observable".