ModelStateTrait.php

<?php

namespace Bluora\LaravelModelTraits;

use Carbon\Carbon;
use HnhDigital\NullCarbon\NullCarbon;
use Illuminate\Database\Eloquent\SoftDeletingScope;

trait ModelStateTrait
{
    /**
     * Remove soft delete scope.
     *
     * @return void
     */
    public static function bootModelStateTrait()
    {
        static::addGlobalScope(new ModelStateScope());
    }

    /**
     * Get the created at column.
     *
     * @return string
     */
    public function getStateCreatedAtColumn()
    {
        return 'created_at';
    }

    /**
     * Get the updated at column.
     *
     * @return string
     */
    public function getStateUpdatedAtColumn()
    {
        return 'updated_at';
    }

    /**
     * Get the archived at column.
     *
     * @return string
     */
    public function getStateArchivedAtColumn()
    {
        return 'archived_at';
    }

    /**
     * Get the deleted at column.
     *
     * @return string
     */
    public function getStateDeletedAtColumn()
    {
        return 'deleted_at';
    }

    /**
     * Get the created at column.
     *
     * @return string
     */
    public function getColumnWithTable($column)
    {
        return $this->getTable().'.'.$column;
    }

    public static $mode_active = '0';
    public static $mode_archived = '1';
    public static $mode_deleted = '2';

    /**
     * Scope a query to only include specific models.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeMode($query, $mode = '0')
    {
        $query->withoutGlobalScope(SoftDeletingScope::class);
        switch ($mode) {
            case static::$mode_archived:
                $query = $query->onlyArchived();
                break;
            case static::$mode_deleted:
                $query = $query->onlyDeleted();
                break;
            case static::$mode_active:
            default:
                $query = $query->onlyActive();
                break;
        }

        return $query;
    }

    /**
     * Scope a query to only include active models.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOnlyActive($query, $type = true)
    {
        return $query->onlyArchived(!$type);
    }

    /**
     * Scope a query to only include archived models.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOnlyArchived($query, $type = true)
    {
        if (static::getStateDeletedAtColumn()) {
            $query = $query->whereNull(static::getColumnWithTable(static::getStateDeletedAtColumn()));
        }
        if (static::getStateArchivedAtColumn()) {
            if ($type === true) {
                $query = $query->whereNotNull(static::getColumnWithTable(static::getStateArchivedAtColumn()));
            } else {
                $query = $query->whereNull(static::getColumnWithTable(static::getStateArchivedAtColumn()));
            }
        }

        return $query;
    }

    /**
     * Scope a query to only include deleted models.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOnlyDeleted($query, $type = true)
    {
        if (static::getStateDeletedAtColumn()) {
            if ($type === true) {
                $query = $query->whereNotNull(static::getColumnWithTable(static::getStateDeletedAtColumn()));
            } else {
                $query = $query->whereNull(static::getColumnWithTable(static::getStateDeletedAtColumn()));
            }
        }

        return $query;
    }

    /**
     * Activate this model.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function activateModel($save = true)
    {
        if (static::getStateArchivedAtColumn()) {
            $this->{static::getStateArchivedAtColumn()} = null;
        }
        if (static::getStateDeletedAtColumn()) {
            $this->{static::getStateDeletedAtColumn()} = null;
        }
        if ($save && (static::getStateArchivedAtColumn() || static::getStateDeletedAtColumn())) {
            $this->save();
        }
    }

    /**
     * Archive this model.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function archiveModel($save = true)
    {
        if (static::getStateArchivedAtColumn()) {
            $this->{static::getStateArchivedAtColumn()} = Carbon::now()->toDateTimeString();
            if (static::getStateDeletedAtColumn()) {
                $this->{static::getStateDeletedAtColumn()} = null;
            }
            if ($save) {
                $this->save();
            }
        }
    }

    /**
     * Delete this model.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function deleteModel($save = true)
    {
        if (static::getStateDeletedAtColumn()) {
            $this->{static::getStateDeletedAtColumn()} = Carbon::now()->toDateTimeString();
            if ($save) {
                $this->save();
            }
        }
    }

    public function removeModel()
    {
        $this->deleteModel();
    }

    /**
     * Is this model active?
     *
     * @return string
     */
    public function getIsActiveAttribute()
    {
        $archived_at = $this->{static::getStateArchivedAtColumn(false)};
        $deleted_at = $this->{static::getStateDeletedAtColumn(false)};

        if (($archived_at instanceof NullCarbon || is_null($archived_at) || $archived_at === false)
            && ($deleted_at instanceof NullCarbon || is_null($deleted_at) || $deleted_at === false)) {
            return true;
        }
    }

    /**
     * Is this model archived?
     *
     * @return string
     */
    public function getIsArchivedAttribute()
    {
        $archived_at = $this->{static::getStateArchivedAtColumn(false)};
        $deleted_at = $this->{static::getStateDeletedAtColumn(false)};

        if (!($archived_at instanceof NullCarbon || is_null($archived_at) || $archived_at === false)
            && ($deleted_at instanceof NullCarbon || is_null($deleted_at) || $deleted_at === false)) {
            return true;
        }
    }

    /**
     * Is this model deleted?
     *
     * @return string
     */
    public function getIsDeletedAttribute()
    {
        $deleted_at = $this->{static::getStateDeletedAtColumn(false)};

        if ($deleted_at instanceof NullCarbon || is_null($deleted_at) || $deleted_at === false) {
            return false;
        }

        return true;
    }

    /**
     * Is this model removed?
     * Alias for deleted.
     *
     * @return string
     */
    public function getIsRemovedAttribute()
    {
        return $this->is_deleted;
    }

    /**
     * Is this model active?
     *
     * @return string
     */
    public function getStateNameAttribute()
    {
        if ($this->is_active) {
            return 'active';
        } elseif ($this->is_archived) {
            return 'archived';
        } else {
            return 'removed';
        }
    }
}