Analogue\ORM\Plugins\SoftDeletes\SoftDeletesPlugin

Complexity

Total Complexity

5

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	8
Bugs	3	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getCustomEvents()	0	4	1
A	register()	0	14	2
B	registerSoftDelete()	0	37	2

<?php

namespace Analogue\ORM\Plugins\SoftDeletes;

use Carbon\Carbon;
use Analogue\ORM\System\Mapper;
use Analogue\ORM\Plugins\AnaloguePlugin;
use Analogue\ORM\System\Wrappers\Factory;

/**
 * This Plugin enables a softDeletes behaviour equivalent
 * to Eloquent ORM.
 */
class SoftDeletesPlugin extends AnaloguePlugin
{
    /**
     * Register the plugin
     *
     * @throws \Exception
     * @return void
     */
    public function register()
    {
        $host = $this;

        // Hook any mapper init and check the mapping include soft deletes.
        $this->manager->registerGlobalEvent('initialized', function (Mapper $mapper) use ($host) {
            $entityMap = $mapper->getEntityMap();

            if ($entityMap->usesSoftDeletes()) {
                $host->registerSoftDelete($mapper);
            }

        });
    }

    /**
     * By hooking to the mapper initialization event, we can extend it
     * with the softDelete capacity.
     *
     * @param  \Analogue\ORM\System\Mapper $mapper
     * @throws \Analogue\ORM\Exceptions\MappingException
     * @return bool|void
     */
    protected function registerSoftDelete(Mapper $mapper)
    {
        $entityMap = $mapper->getEntityMap();

        // Add Scopes
        $mapper->addGlobalScope(new SoftDeletingScope);

        $host = $this;

        // Register 'deleting' events
        $mapper->registerEvent('deleting', function ($entity) use ($entityMap, $host) {
            
            // Convert Entity into an EntityWrapper
            $factory = new Factory;

            $wrappedEntity = $factory->make($entity);

            $deletedAtField = $entityMap->getQualifiedDeletedAtColumn();

            if (!is_null($wrappedEntity->getEntityAttribute($deletedAtField))) {
                return true;
            } else {
                $time = new Carbon;

                $wrappedEntity->setEntityAttribute($deletedAtField, $time);

                $plainObject = $wrappedEntity->getObject();
                $host->manager->mapper(get_class($plainObject))->store($plainObject);

                return false;
            }

        });

        // Register RestoreCommand
        $mapper->addCustomCommand('Analogue\ORM\Plugins\SoftDeletes\Restore');
    }

    /**
     * Get custom events provided by the plugin
     *
     * @return string[]
     */
    public function getCustomEvents()
    {
        return ['restoring', 'restored'];
    }
}