CascadeSoftDeletes::bootCascadeSoftDeletes() - Code Metrics - michaeldyrynda/laravel-cascade-soft-deletes - Measure and Improve Code Quality continuously with Scrutinizer

CascadeSoftDeletes::bootCascadeSoftDeletes() A
last analyzed 2020-03-22 06:58 UTC

↳ Parent: CascadeSoftDeletes

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
ccs	5
cts	5
cp	1
cc	1
nc	1
nop	0
crap	1

<?php

namespace Iatstuti\Database\Support;

use LogicException;
use Illuminate\Support\Str;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\Relation;

trait CascadeSoftDeletes
{
    /**
     * Boot the trait.
     *
     * Listen for the deleting event of a soft deleting model, and run
     * the delete operation for any configured relationship methods.
     *
     * @throws \LogicException
     */
    protected static function bootCascadeSoftDeletes()
    {
        static::deleting(function ($model) {
            $model->validateCascadingSoftDelete();

            $model->runCascadingDeletes();
        });
    }


    /**
     * Validate that the calling model is correctly setup for cascading soft deletes.
     *
     * @throws \Iatstuti\Database\Support\CascadeSoftDeleteException
     */
    protected function validateCascadingSoftDelete()
    {
        if (! $this->implementsSoftDeletes()) {
            throw CascadeSoftDeleteException::softDeleteNotImplemented(get_called_class());
        }

        if ($invalidCascadingRelationships = $this->hasInvalidCascadingRelationships()) {
            throw CascadeSoftDeleteException::invalidRelationships($invalidCascadingRelationships);
        }
    }


    /**
     * Run the cascading soft delete for this model.
     *
     * @return void
     */
    protected function runCascadingDeletes()
    {
        foreach ($this->getActiveCascadingDeletes() as $relationship) {
            $this->cascadeSoftDeletes($relationship);
        }
    }


    /**
     * Cascade delete the given relationship on the given mode.
     *
     * @param  string  $relationship
     * @return return

     */
    protected function cascadeSoftDeletes($relationship)
    {
        $delete = $this->forceDeleting ? 'forceDelete' : 'delete';
class MyClass { }

$x = new MyClass();
$x->foo = true;

        foreach ($this->{$relationship}()->get() as $model) {
            $model->pivot ? $model->pivot->{$delete}() : $model->{$delete}();
        }
    }


    /**
     * Determine if the current model implements soft deletes.
     *
     * @return bool
     */
    protected function implementsSoftDeletes()
    {
        return method_exists($this, 'runSoftDelete');
    }


    /**
     * Determine if the current model has any invalid cascading relationships defined.
     *
     * A relationship is considered invalid when the method does not exist, or the relationship
     * method does not return an instance of Illuminate\Database\Eloquent\Relations\Relation.
     *
     * @return array
     */
    protected function hasInvalidCascadingRelationships()
    {
        return array_filter($this->getCascadingDeletes(), function ($relationship) {
            return ! method_exists($this, $relationship) || ! $this->{$relationship}() instanceof Relation;
        });
    }


    /**
     * Fetch the defined cascading soft deletes for this model.
     *
     * @return array
     */
    protected function getCascadingDeletes()
    {
        return isset($this->cascadeDeletes) ? (array) $this->cascadeDeletes : [];
    }


    /**
     * For the cascading deletes defined on the model, return only those that are not null.
     *
     * @return array
     */
    protected function getActiveCascadingDeletes()
    {
        return array_filter($this->getCascadingDeletes(), function ($relationship) {
            return ! is_null($this->{$relationship});
        });
    }
}


1		<?php
2
3		namespace Iatstuti\Database\Support;
4
5		use LogicException;
6		use Illuminate\Support\Str;
7		use Illuminate\Database\Eloquent\Model;
8		use Illuminate\Database\Eloquent\Relations\BelongsToMany;
9		use Illuminate\Database\Eloquent\Relations\Relation;
10
11		trait CascadeSoftDeletes
12		{
13		/**
14		* Boot the trait.
15		*
16		* Listen for the deleting event of a soft deleting model, and run
17		* the delete operation for any configured relationship methods.
18		*
19	10	* @throws \LogicException
20		*/
21		protected static function bootCascadeSoftDeletes()
22	10	{
23	1	static::deleting(function ($model) {
24	1	$model->validateCascadingSoftDelete();
25	1
26	1	$model->runCascadingDeletes();
27		});
28		}
29	9
30	3
31	3	/**
32	3	* Validate that the calling model is correctly setup for cascading soft deletes.
33	3	*
34	3	* @throws \Iatstuti\Database\Support\CascadeSoftDeleteException
35		*/
36		protected function validateCascadingSoftDelete()
37	6	{
38		if (! $this->implementsSoftDeletes()) {
39	6	throw CascadeSoftDeleteException::softDeleteNotImplemented(get_called_class());
40	6	}
41	1
42	1	if ($invalidCascadingRelationships = $this->hasInvalidCascadingRelationships()) {
43	6	throw CascadeSoftDeleteException::invalidRelationships($invalidCascadingRelationships);
44	5	}
45	6	}
46
47	6
48	9	/**
49	7	* Run the cascading soft delete for this model.
50		*
51		* @return void
52		*/
53		protected function runCascadingDeletes()
54		{
55		foreach ($this->getActiveCascadingDeletes() as $relationship) {
56		$this->cascadeSoftDeletes($relationship);
57	10	}
58		}
59	10
60
61		/**
62		* Cascade delete the given relationship on the given mode.
63		*
64		* @param string $relationship
65		* @return return
		0 ignored issues – show Documentation introduced 2019-09-06 05:16 UTC by Report Bug Copy Issue Report Should the return type not be `return\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
66		*/
67		protected function cascadeSoftDeletes($relationship)
68		{
69		$delete = $this->forceDeleting ? 'forceDelete' : 'delete';
		0 ignored issues – show Bug introduced 2019-09-06 05:16 UTC by Report Bug Copy Issue Report The property `forceDeleting` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
70
71	9	foreach ($this->{$relationship}()->get() as $model) {
72		$model->pivot ? $model->pivot->{$delete}() : $model->{$delete}();
73		}
74	9	}
75	9
76
77		/**
78		* Determine if the current model implements soft deletes.
79		*
80		* @return bool
81		*/
82		protected function implementsSoftDeletes()
83		{
84	9	return method_exists($this, 'runSoftDelete');
85		}
86	9
87
88		/**
89		* Determine if the current model has any invalid cascading relationships defined.
90		*
91		* A relationship is considered invalid when the method does not exist, or the relationship
92		* method does not return an instance of Illuminate\Database\Eloquent\Relations\Relation.
93		*
94		* @return array
95		*/
96		protected function hasInvalidCascadingRelationships()
97	6	{
98	6	return array_filter($this->getCascadingDeletes(), function ($relationship) {
99	6	return ! method_exists($this, $relationship) \|\| ! $this->{$relationship}() instanceof Relation;
100		});
101		}
102
103
104		/**
105		* Fetch the defined cascading soft deletes for this model.
106		*
107		* @return array
108		*/
109		protected function getCascadingDeletes()
110		{
111		return isset($this->cascadeDeletes) ? (array) $this->cascadeDeletes : [];
112		}
113
114
115		/**
116		* For the cascading deletes defined on the model, return only those that are not null.
117		*
118		* @return array
119		*/
120		protected function getActiveCascadingDeletes()
121		{
122		return array_filter($this->getCascadingDeletes(), function ($relationship) {
123		return ! is_null($this->{$relationship});
124		});
125		}
126		}
127

michaeldyrynda / laravel-cascade-soft-deletes

CascadeSoftDeletes::bootCascadeSoftDeletes() A last analyzed 2020-03-22 06:58 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CascadeSoftDeletes::bootCascadeSoftDeletes() A
last analyzed 2020-03-22 06:58 UTC