Loggable::builderMatchesChange() - Code Metrics - SierraTecnologia/Audit - Measure and Improve Code Quality continuously with Scrutinizer

Loggable::builderMatchesChange() B
last analyzed 2021-05-30 00:16 UTC

↳ Parent: Loggable

Complexity

Conditions	6
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	29
rs	8.8337
c	0
b	0
f	0
cc	6
nc	1
nop	2

<?php

namespace Audit\Traits;

// Deps
use App;
use Facilitador\Models\Admin;
use Audit\Models\Change;
use MediaManager\Models\Image;
use Facilitador;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\SoftDeletingScope;
use Muleta\Traits\Models\SerializeWithImages;
use Muleta\Traits\Models\CanSerializeTransform;

/**
 * Enable logging changes to models
 */
trait Loggable
{
    /**
     * The name of the scope that is applied to make trashed versions to be
     * viewable
     *
     * @var string
     */
    static public $LOGGABLE_SCOPE = 'view trashed versions';

    /**
     * Previous (to the change referenced in the request query) changes made
     * to this model
     *
     * @var Collection
     */
    private $previous_changes;

    /**
     * Get the polymorphic relationship to Changes
     *
     * @return Illuminate\Database\Eloquent\Relations\Relation
     */
    public function changes()
    {
        return $this->morphMany(Change::class, 'loggable', 'model', 'key');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

     /**
      * Boot events
      *
      * @return void
      */
    public static function bootLoggable()
    {
        // Add scope that will fetch trashed versions of models when the
        // Change::QUERY_KEY is present.
        static::addGlobalScope(
            static::$LOGGABLE_SCOPE, function (Builder $builder) {
                static::showTrashedVersion($builder);
            }
        );

        // Substitute attribute values from changes on load
        static::retrieved(
            function ($model) {
                $model->replaceAttributesWithChange();
            }
        );
    }

    /**
     * Should this model log it's changes.  Defaults to true if the change
     * happened while handling an admin request or via the console but not
     * during a non-http unit test.
     *
     * @param  string $action Like "deleted", "updated", etc
     * @return boolean
     */
    public function shouldLogChange($action)

    {
        return Facilitador::handling()
            || (App::runningInConsole() && request()->path() == '/');
    }

    /**
     * Show trashed models for matching change
     *
     * @param  Builder $builder
     * @return void
     */
    private static function showTrashedVersion(Builder $builder)
    {
        if (($change = static::lookupRequestedChange())
            && static::builderMatchesChange($change, $builder)
        ) {
            $builder->withoutGlobalScope(SoftDeletingScope::class);
        }
    }

    /**
     * Get a Change record mentioned in the query, if appropriate
     *
     * @return Change|void
     */
    private static function lookupRequestedChange()
    {
        // Only run if the query param is present
        if (!$change_id = request(Change::QUERY_KEY)) {
            return;
        }

        // Don't execute for classes that result in recusirve queries when the
        // Change model gets built below
        $class = get_called_class();
        if (in_array($class, [Change::class, Admin::class, Image::class])) {
            return;
        }

        // Check whether the referenced Change is for this class
        $change = Change::find($change_id);
        if ($class == $change->model) {
            return $change;
        }
    }

    /**
     * Does the Change referenced in the GET query match the conditions already
     * applied in the query builder?
     *
     * @param  Change  $change
     * @param  Builder $builder
     * @return boolean
     */
    private static function builderMatchesChange(Change $change, Builder $builder)
    {
        $class = $change->model;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $route_key_name = (new $class)->getRouteKeyName();
        return collect($builder->getQuery()->wheres)
            ->contains(
                function ($where) use ($change, $route_key_name) {

                    // If the builder is keyed to a simple "id" in the route, return
                    // whether the Change matches it.
                    if ($route_key_name == 'id') {
                        return $where['column'] == $route_key_name
                        && $where['operator'] == '='
                        && $where['value'] == $change->key;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

                        // Otherwise compare against model logged by the change. The
                        // scope needs to be removed to prevent recursion.
                    } else {
                        $value = $change->changedModel()
                            ->withoutGlobalScope(static::$LOGGABLE_SCOPE)
                            ->first()
                            ->$route_key_name;
                        return $where['column'] == $route_key_name
                        && $where['operator'] == '='
                        && $where['value'] == $value;
                    }
                }
            );
    }

    /**
     * Replace all the attributes with those from the specified Change specified
     * in the reqeust query.
     *
     * @return void
     */
    private function replaceAttributesWithChange()

    {
        if (($change = static::lookupRequestedChange())
            && $change->key == $this->getKey()
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        ) {
            $this->attributes = array_merge(
class MyClass { }

$x = new MyClass();
$x->foo = true;
                $this->attributes,
                $this->attributesAtChange($change)
            );
        }
    }

    /**
     * Get the attributes of the model at a given Change
     *
     * @param  Change $change
     * @return array
     */
    private function attributesAtChange(Change $change)
    {
        return $this->previousChanges($change)
            ->reduce(
                function ($attributes, $change) {
                    return array_merge($attributes, $change->changed);
                }, []
            );
    }

    /**
     * Get the list of pervious changes of this model, storing it to reduce
     * future lookups
     *
     * @param  Change $change
     * @return Collection
     */
    private function previousChanges(Change $change)
    {
        return $this->changes()
            ->where('changes.id', '<=', $change->id)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->orderBy('changes.id', 'asc')
            ->get();

    }

}


1			<?php
2
3			namespace Audit\Traits;
4
5			// Deps
6			use App;
7			use Facilitador\Models\Admin;
8			use Audit\Models\Change;
9			use MediaManager\Models\Image;
10			use Facilitador;
11			use Illuminate\Database\Eloquent\Builder;
12			use Illuminate\Database\Eloquent\SoftDeletingScope;
13			use Muleta\Traits\Models\SerializeWithImages;
14			use Muleta\Traits\Models\CanSerializeTransform;
15
16			/**
17			* Enable logging changes to models
18			*/
19			trait Loggable
20			{
21			/**
22			* The name of the scope that is applied to make trashed versions to be
23			* viewable
24			*
25			* @var string
26			*/
27			static public $LOGGABLE_SCOPE = 'view trashed versions';
28
29			/**
30			* Previous (to the change referenced in the request query) changes made
31			* to this model
32			*
33			* @var Collection
34			*/
35			private $previous_changes;
36
37			/**
38			* Get the polymorphic relationship to Changes
39			*
40			* @return Illuminate\Database\Eloquent\Relations\Relation
41			*/
42			public function changes()
43			{
44			return $this->morphMany(Change::class, 'loggable', 'model', 'key');
			0 ignored issues – show Bug introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report It seems like `morphMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
45			}
46
47			/**
48			* Boot events
49			*
50			* @return void
51			*/
52			public static function bootLoggable()
53			{
54			// Add scope that will fetch trashed versions of models when the
55			// Change::QUERY_KEY is present.
56			static::addGlobalScope(
57			static::$LOGGABLE_SCOPE, function (Builder $builder) {
58			static::showTrashedVersion($builder);
59			}
60			);
61
62			// Substitute attribute values from changes on load
63			static::retrieved(
64			function ($model) {
65			$model->replaceAttributesWithChange();
66			}
67			);
68			}
69
70			/**
71			* Should this model log it's changes. Defaults to true if the change
72			* happened while handling an admin request or via the console but not
73			* during a non-http unit test.
74			*
75			* @param string $action Like "deleted", "updated", etc
76			* @return boolean
77			*/
78			public function shouldLogChange($action)
			0 ignored issues – show Unused Code introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report The parameter `$action` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
79			{
80			return Facilitador::handling()
81			\|\| (App::runningInConsole() && request()->path() == '/');
82			}
83
84			/**
85			* Show trashed models for matching change
86			*
87			* @param Builder $builder
88			* @return void
89			*/
90			private static function showTrashedVersion(Builder $builder)
91			{
92			if (($change = static::lookupRequestedChange())
93			&& static::builderMatchesChange($change, $builder)
94			) {
95			$builder->withoutGlobalScope(SoftDeletingScope::class);
96			}
97			}
98
99			/**
100			* Get a Change record mentioned in the query, if appropriate
101			*
102			* @return Change\|void
103			*/
104			private static function lookupRequestedChange()
105			{
106			// Only run if the query param is present
107			if (!$change_id = request(Change::QUERY_KEY)) {
108			return;
109			}
110
111			// Don't execute for classes that result in recusirve queries when the
112			// Change model gets built below
113			$class = get_called_class();
114			if (in_array($class, [Change::class, Admin::class, Image::class])) {
115			return;
116			}
117
118			// Check whether the referenced Change is for this class
119			$change = Change::find($change_id);
120			if ($class == $change->model) {
121			return $change;
122			}
123			}
124
125			/**
126			* Does the Change referenced in the GET query match the conditions already
127			* applied in the query builder?
128			*
129			* @param Change $change
130			* @param Builder $builder
131			* @return boolean
132			*/
133			private static function builderMatchesChange(Change $change, Builder $builder)
134			{
135			$class = $change->model;
			0 ignored issues – show Documentation introduced 2020-12-21 20:07 UTC by Report Bug Copy Issue Report The property `model` does not exist on `object<Audit\Models\Change>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
136			$route_key_name = (new $class)->getRouteKeyName();
137			return collect($builder->getQuery()->wheres)
138			->contains(
139			function ($where) use ($change, $route_key_name) {
140
141			// If the builder is keyed to a simple "id" in the route, return
142			// whether the Change matches it.
143			if ($route_key_name == 'id') {
144			return $where['column'] == $route_key_name
145			&& $where['operator'] == '='
146			&& $where['value'] == $change->key;
			0 ignored issues – show Documentation introduced 2020-12-21 20:07 UTC by Report Bug Copy Issue Report The property `key` does not exist on `object<Audit\Models\Change>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
147
148			// Otherwise compare against model logged by the change. The
149			// scope needs to be removed to prevent recursion.
150			} else {
151			$value = $change->changedModel()
152			->withoutGlobalScope(static::$LOGGABLE_SCOPE)
153			->first()
154			->$route_key_name;
155			return $where['column'] == $route_key_name
156			&& $where['operator'] == '='
157			&& $where['value'] == $value;
158			}
159			}
160			);
161			}
162
163			/**
164			* Replace all the attributes with those from the specified Change specified
165			* in the reqeust query.
166			*
167			* @return void
168			*/
169			private function replaceAttributesWithChange()
			0 ignored issues – show Unused Code introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
170			{
171			if (($change = static::lookupRequestedChange())
172			&& $change->key == $this->getKey()
			0 ignored issues – show Bug introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report It seems like `getKey()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history... Documentation introduced 2020-12-21 20:07 UTC by Report Bug Copy Issue Report The property `key` does not exist on `object<Audit\Models\Change>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
173			) {
174			$this->attributes = array_merge(
			0 ignored issues – show Bug introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report The property `attributes` 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...
175			$this->attributes,
176			$this->attributesAtChange($change)
177			);
178			}
179			}
180
181			/**
182			* Get the attributes of the model at a given Change
183			*
184			* @param Change $change
185			* @return array
186			*/
187			private function attributesAtChange(Change $change)
188			{
189			return $this->previousChanges($change)
190			->reduce(
191			function ($attributes, $change) {
192			return array_merge($attributes, $change->changed);
193			}, []
194			);
195			}
196
197			/**
198			* Get the list of pervious changes of this model, storing it to reduce
199			* future lookups
200			*
201			* @param Change $change
202			* @return Collection
203			*/
204			private function previousChanges(Change $change)
205			{
206			return $this->changes()
207			->where('changes.id', '<=', $change->id)
			0 ignored issues – show Documentation introduced 2020-12-21 20:07 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Audit\Models\Change>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
208			->orderBy('changes.id', 'asc')
209			->get();
210
211			}
212
213			}
214

SierraTecnologia / Audit

Loggable::builderMatchesChange() B last analyzed 2021-05-30 00:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Loggable::builderMatchesChange() B
last analyzed 2021-05-30 00:16 UTC