Laravel Read Only Model Trait

Observers-ReadOnly.php

<?php

namespace app\Observers;

use Illuminate\Database\Eloquent\Model;

class ReadOnly
{
    /**
     * Listen to the Model creating event.
     *
     * @param  Model  $model
     * @return void
     */
    public function creating($model)
    {
        throw (new ReadOnlyException)->setModel(get_class($model));
    }

    /**
     * Listen to the Model updating event.
     *
     * @param  Model  $model
     * @return void
     */
    public function updating($model)
    {
        throw (new ReadOnlyException)->setModel(get_class($model));
    }

    /**
     * Listen to the Model saving event.
     *
     * @param  Model  $model
     * @return void
     */
    public function saving($model)
    {
        throw (new ReadOnlyException)->setModel(get_class($model));
    }

    /**
     * Listen to the Model deleting event.
     *
     * @param  Model  $model
     * @return void
     */
    public function deleting($model)
    {
        throw (new ReadOnlyException)->setModel(get_class($model));
    }
}

Observers-ReadOnlyException.php

<?php

namespace app\Observers;

use RuntimeException;

class ReadOnlyException extends RuntimeException
{
    /**
     * Name of the affected Eloquent model.
     *
     * @var string
     */
    protected $model;

    /**
     * Set the affected Eloquent model.
     *
     * @param  string  $model
     * @return $this
     */
    public function setModel($model)
    {
        $this->model = $model;

        $this->message = "Not allowed to persist changes in read-only model [{$model}].";

        return $this;
    }

    /**
     * Get the affected Eloquent model.
     *
     * @return string
     */
    public function getModel()
    {
        return $this->model;
    }
}

Trait-ReadOnly.php

<?php

namespace app\Traits;

use app\Observers\ReadOnly as ReadOnlyObserver;

trait ReadOnly
{
    /**
     * Boot the read only trait for a model.
     *
     * @return void
     */
    public static function bootReadOnly()
    {
        static::observe(ReadOnlyObserver::class);
    }
}

Note: Gist does not allow to use / character in file name to specify a subfolder. I substituted it by a - character. In our current project, all these are under a Models folder:

• Traits/ReadOnly.php
• Observers/ReadOnly.php
• Observers/ReadOnlyException.php