SoftDeletes::findOne() - Code Metrics - Inspection of "Adding Soft Delete Functionality" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#285)

by Arman

created 2025-05-27 16:03 UTC

SoftDeletes::findOne() A

↳ Parent: SoftDeletes

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	7
rs	10
c	1
b	0
f	0

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.7
 */

namespace Quantum\Model\Traits;

use Quantum\Paginator\Exceptions\PaginatorException;
use Quantum\Tests\_root\shared\Models\Products;
use Quantum\App\Exceptions\BaseException;
use Quantum\Model\ModelCollection;
use Quantum\Paginator\Paginator;

/**
 * Trait SoftDeletes
 * @package Quantum\Model
 */
trait SoftDeletes
{

    /**
     * @var bool
     */
    protected $includeTrashed = false;

    /**
     * Soft delete the model by setting the deleted_at timestamp.
     * @return bool
     */
    public function delete(): bool
    {
        $this->prop($this->getDeleteAtColumn(), date('Y-m-d H:i:s'));
               prop($this->getDeleteAtColumn(), date('Y-m-d H:i:s'));
        return $this->save();
        return $this->/** @scrutinizer ignore-call */ save();

    }

    /**
     * Restore a soft deleted model.
     * @return bool
     */
    public function restore(): bool
    {
        $this->prop($this->getDeleteAtColumn(), null);
        return $this->save();
    }

    /**
     * Force delete the model from the database.
     * @return bool
     */
    public function forceDelete(): bool
    {
        return parent::delete();
    }

    /**
     * Include soft deleted records in the query.
     * @return static
     */
    public function withTrashed(): self
    {
        $this->includeTrashed = true;

        return $this;
    }

    /**
     * Return only soft deleted records.
     * @return static
     */
    public function onlyTrashed(): self
    {
        $this->includeTrashed = true;

        $this->ormInstance->isNotNull($this->getDeleteAtColumn());

        return $this;
    }

    /**
     * Get all non-deleted records unless withTrashed is called.
     * @return ModelCollection
     */
    public function get(): ModelCollection
    {
        $this->applySoftDeleteScope();

        return parent::get();
    }

    /**
     * Paginate non-deleted records unless withTrashed is called.
     * @param int $perPage
     * @param int $currentPage
     * @return Paginator
     * @throws BaseException
     * @throws PaginatorException
     */
    public function paginate(int $perPage, int $currentPage = 1): Paginator
    {
        $this->applySoftDeleteScope();

        return parent::paginate($perPage, $currentPage);
    }

    /**
     * Count all non-deleted records unless withTrashed() is called.
     * @return int
     */
    public function count(): int
    {
        $this->applySoftDeleteScope();

        return parent::count();
    }

    /**
     * Find one record by its ID, excluding soft deleted unless withTrashed() is called.
     * @param int $id
     * @return static
     */
    public function findOne(int $id): self
    {
        $this->applySoftDeleteScope();

        parent::findOne($id);

        return $this;
    }

    /**
     * Find one record by column and value, excluding soft deleted unless withTrashed() is called.
     * @param string $column
     * @param $value
     * @return static
     */
    public function findOneBy(string $column, $value): self
    {
        $this->applySoftDeleteScope();

        parent::findOneBy($column, $value);

        return $this;
    }

    /**
     * Get the first record, excluding soft deleted unless withTrashed() is called.
     * @return static
     */
    public function first(): self
    {
        $this->applySoftDeleteScope();

        parent::first();

        return $this;
    }

    /**
     * Apply soft delete scope to the current query if not including trashed.
     */
    protected function applySoftDeleteScope(): void
    {
        if (!$this->includeTrashed) {
            $this->ormInstance->isNull($this->getDeleteAtColumn());
        }
    }

    /**
     * Get the column name used for soft deletes.
     * @return string
     */
    protected function getDeleteAtColumn(): string
    {
        if (defined(static::class . '::DELETED_AT')) {
            return static::DELETED_AT;

        }

        return 'deleted_at';
    }
}

softberg / quantum-php-core

Pull Request — master (#285)

SoftDeletes::findOne() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like