Zemit\Mvc\Model\SoftDelete

Complexity

Total Complexity

13

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setSoftDeleteBehavior()	0	4	1
A	initializeSoftDelete()	0	4	1
A	isDeleted()	0	5	1
A	disableSoftDelete()	0	3	1
A	enableSoftDelete()	0	3	1
B	restore()	0	40	7
A	getSoftDeleteBehavior()	0	3	1

<?php

/**
 * This file is part of the Zemit Framework.
 *
 * (c) Zemit Team <contact@zemit.com>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

namespace Zemit\Mvc\Model;

use Zemit\Mvc\Model\AbstractTrait\AbstractBehavior;
use Zemit\Mvc\Model\AbstractTrait\AbstractEventsManager;
use Zemit\Mvc\Model\Behavior;

trait SoftDelete
{
    use AbstractBehavior;
    use AbstractEventsManager;
    use Attribute;
    
    public Behavior\SoftDelete $softDeleteBehavior;
    
    /**
     * Initializing SoftDelete
     */
    public function initializeSoftDelete(array $options = []): void
    {
        $options ??= $this->getOptionsManager()->get('softDelete');

It seems like getOptionsManager() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->setSoftDeleteBehavior(new Behavior\SoftDelete($options));
    }
    
    /**
     * Return the soft delete behavior instance
     */
    public function getSoftDeleteBehavior(): ?Behavior\SoftDelete
    {
        return $this->softDeleteBehavior;
    }
    
    /**
     * Set the SoftDeleteBehavior variable
     * Attach the SoftDelete behavior class
     */
    public function setSoftDeleteBehavior(Behavior\SoftDelete $softDeleteBehavior): void
    {
        $this->softDeleteBehavior = $softDeleteBehavior;
        $this->addBehavior($softDeleteBehavior);
    }
    
    /**
     * Disable the soft delete for the current instance
     * Note: Zemit SoftDelete behavior must be attached
     */
    public function disableSoftDelete(): void
    {
        $this->getSoftDeleteBehavior()->disable();
    }
    
    /**
     * Enable the soft delete for the current instance
     * Note: Zemit SoftDelete behavior must be attached
     */
    public function enableSoftDelete(): void
    {
        $this->getSoftDeleteBehavior()->enable();
    }
    
    /**
     * Helper method to check if the row is soft deleted
     */
    public function isDeleted(?string $field = null, ?int $deletedValue = null): bool
    {
        $field ??= self::DELETED_FIELD;

The constant Zemit\Mvc\Model\SoftDelete::DELETED_FIELD was not found. Maybe you did not declare it correctly or list all dependencies?

        $deletedValue ??= self::YES;

The constant Zemit\Mvc\Model\SoftDelete::YES was not found. Maybe you did not declare it correctly or list all dependencies?

        return $this->getAttribute($field) === $deletedValue;
    }
    
    /**
     * Restore a previously Soft-deleted entry
     * Events:
     * - beforeRestore
     * - notRestored
     * - afterRestore
     *
     * @throws \Exception
     * @todo add a check from orm.events setup state
     */
    public function restore(?string $field = null, ?int $notDeletedValue = null): bool
    {
        $ormEvents = (bool)ini_get('orm.events');
        
        if ($ormEvents) {
            $this->skipped = false;

The property skipped does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            
            // fire event, allowing to stop options or skip the current operation
            if ($this->fireEventCancel('beforeRestore') === false) {
                return false;
            }
            
            if ($this->skipped) {
                return true;
            }
        }
        
        // get settings
        $field ??= self::DELETED_FIELD;

The constant Zemit\Mvc\Model\SoftDelete::DELETED_FIELD was not found. Maybe you did not declare it correctly or list all dependencies?

        $notDeletedValue ??= self::NO;

The constant Zemit\Mvc\Model\SoftDelete::NO was not found. Maybe you did not declare it correctly or list all dependencies?

        
        // restore
        $this->assign([$field => $notDeletedValue], [$field]);

It seems like assign() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $save = $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        
        // check if the entity was really restored
        $value = $this->getAttribute($field);
        $restored = $save && $value === $notDeletedValue;
        
        // fire events
        if ($ormEvents) {
            if (!$restored) {
                $this->fireEvent('notRestored');
            }
            else {
                $this->fireEvent('afterRestore');
            }
        }
        
        return $restored;
    }
}