LogsActivity::shouldLogChanges() - Code Metrics - Inspection of "wip" - spatie/laravel-activitylog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c404ca...15b880 )

by Freek

created 2016-06-25 09:26 UTC

LogsActivity::shouldLogChanges() A

↳ Parent: LogsActivity

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php

namespace Spatie\Activitylog\Traits;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Spatie\Activitylog\ActivityLogger;

trait LogsActivity
{
    use DetectsChanges;

    protected static function bootLogsActivity()
    {
        collect(static::eventsToBeRecorded())->each(function ($eventName) {

            return static::$eventName(function (Model $model) use ($eventName) {

                $description = $model->getDescriptionForEvent($eventName);

                if ($description == '') {
                    return;
                }

                $extraProperties = [];

                if ($model->shouldLogChanges()) {
                    $extraProperties['changes'] = $model->getChangedValues();
                }

                app(ActivityLogger::class)
                    ->performedOn($model)
                    ->withExtraProperties($extraProperties)
                    ->log($description);
            });

        });
    }

    public function shouldLogChanges(): bool
    {
        if (!isset($this->logChangesOnAttributes)) {
            return false;
        }

        return count($this->logChangesOnAttributes);
class MyClass { }

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

    public function causesActivity(): MorphTo
    {
        return $this->morphTo();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function getDescriptionForEvent(string $eventName): string
    {
        return $eventName;
    }

    /*
     * Get the event names that should be recorded.
     */
    protected static function eventsToBeRecorded(): array
    {
        if (isset(static::$recordEvents)) {
            return static::$recordEvents;
        }

        return [
            'created',
            'updated',
            'deleted',
        ];
    }
}


1			<?php
2
3			namespace Spatie\Activitylog\Traits;
4
5			use Illuminate\Database\Eloquent\Model;
6			use Illuminate\Database\Eloquent\Relations\MorphTo;
7			use Spatie\Activitylog\ActivityLogger;
8
9			trait LogsActivity
10			{
11			use DetectsChanges;
12
13			protected static function bootLogsActivity()
14			{
15			collect(static::eventsToBeRecorded())->each(function ($eventName) {
16
17			return static::$eventName(function (Model $model) use ($eventName) {
18
19			$description = $model->getDescriptionForEvent($eventName);
20
21			if ($description == '') {
22			return;
23			}
24
25			$extraProperties = [];
26
27			if ($model->shouldLogChanges()) {
28			$extraProperties['changes'] = $model->getChangedValues();
29			}
30
31			app(ActivityLogger::class)
32			->performedOn($model)
33			->withExtraProperties($extraProperties)
34			->log($description);
35			});
36
37			});
38			}
39
40			public function shouldLogChanges(): bool
41			{
42			if (!isset($this->logChangesOnAttributes)) {
43			return false;
44			}
45
46			return count($this->logChangesOnAttributes);
			0 ignored issues – show Bug introduced 2016-06-25 09:28 UTC by Report Bug Copy Issue Report The property `logChangesOnAttributes` 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...
47			}
48
49			public function causesActivity(): MorphTo
50			{
51			return $this->morphTo();
			0 ignored issues – show Bug introduced 2016-06-23 22:55 UTC by Report Bug Copy Issue Report It seems like `morphTo()` 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...
52			}
53
54			public function getDescriptionForEvent(string $eventName): string
55			{
56			return $eventName;
57			}
58
59			/*
60			* Get the event names that should be recorded.
61			*/
62			protected static function eventsToBeRecorded(): array
63			{
64			if (isset(static::$recordEvents)) {
65			return static::$recordEvents;
66			}
67
68			return [
69			'created',
70			'updated',
71			'deleted',
72			];
73			}
74			}
75

spatie / laravel-activitylog

Push — master ( c404ca...15b880 )

LogsActivity::shouldLogChanges() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like