LogsActivity::getDescriptionForEvent() - Code Metrics - Inspection of "v3.5.0" - spatie/laravel-activitylog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5bbd3f...3bee85 )

by Tom

created 2019-04-15 11:01 UTC

LogsActivity::getDescriptionForEvent() A

↳ Parent: LogsActivity

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Spatie\Activitylog\Traits;

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Spatie\Activitylog\ActivityLogger;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Spatie\Activitylog\ActivitylogServiceProvider;
use Illuminate\Database\Eloquent\Relations\MorphMany;

trait LogsActivity
{
    use DetectsChanges;

    protected $enableLoggingModelsEvents = true;

    protected static function bootLogsActivity()
    {
        static::eventsToBeRecorded()->each(function ($eventName) {
            return static::$eventName(function (Model $model) use ($eventName) {
                if (! $model->shouldLogEvent($eventName)) {
                    return;
                }

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

                $logName = $model->getLogNameToUse($eventName);

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

                $attrs = $model->attributeValuesToBeLogged($eventName);

                if ($model->isLogEmpty($attrs) && ! $model->shouldSubmitEmptyLogs()) {
                    return;
                }

                $logger = app(ActivityLogger::class)
                    ->useLog($logName)
                    ->performedOn($model)
                    ->withProperties($attrs);

                if (method_exists($model, 'tapActivity')) {
                    $logger->tap([$model, 'tapActivity'], $eventName);
                }

                $logger->log($description);
            });
        });
    }

    public function shouldSubmitEmptyLogs(): bool
    {
        return ! isset(static::$submitEmptyLogs) ? true : static::$submitEmptyLogs;
    }

    public function isLogEmpty($attrs): bool
    {
        return empty($attrs['attributes'] ?? []) && empty($attrs['old'] ?? []);
    }

    public function disableLogging()
    {
        $this->enableLoggingModelsEvents = false;

        return $this;
    }

    public function enableLogging()
    {
        $this->enableLoggingModelsEvents = true;

        return $this;
    }

    public function activities(): MorphMany
    {
        return $this->morphMany(ActivitylogServiceProvider::determineActivityModel(), 'subject');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

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

    public function getLogNameToUse(string $eventName = ''): string

    {
        if (isset(static::$logName)) {
            return static::$logName;
        }

        return config('activitylog.default_log_name');
    }

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

        $events = collect([
            'created',
            'updated',
            'deleted',
        ]);

        if (collect(class_uses_recursive(static::class))->contains(SoftDeletes::class)) {
            $events->push('restored');
        }

        return $events;
    }

    public function attributesToBeIgnored(): array
    {
        if (! isset(static::$ignoreChangedAttributes)) {
            return [];
        }

        return static::$ignoreChangedAttributes;
    }

    protected function shouldLogEvent(string $eventName): bool
    {
        if (! $this->enableLoggingModelsEvents) {
            return false;
        }

        if (! in_array($eventName, ['created', 'updated'])) {
            return true;
        }

        if (Arr::has($this->getDirty(), 'deleted_at')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if ($this->getDirty()['deleted_at'] === null) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                return false;
            }
        }

        //do not log update event if only ignored attributes are changed
        return (bool) count(Arr::except($this->getDirty(), $this->attributesToBeIgnored()));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1		<?php
2
3		namespace Spatie\Activitylog\Traits;
4
5		use Illuminate\Support\Arr;
6		use Illuminate\Support\Collection;
7		use Spatie\Activitylog\ActivityLogger;
8		use Illuminate\Database\Eloquent\Model;
9		use Illuminate\Database\Eloquent\SoftDeletes;
10		use Spatie\Activitylog\ActivitylogServiceProvider;
11		use Illuminate\Database\Eloquent\Relations\MorphMany;
12
13		trait LogsActivity
14		{
15		use DetectsChanges;
16
17		protected $enableLoggingModelsEvents = true;
18
19	168	protected static function bootLogsActivity()
20		{
21		static::eventsToBeRecorded()->each(function ($eventName) {
22		return static::$eventName(function (Model $model) use ($eventName) {
23	164	if (! $model->shouldLogEvent($eventName)) {
24	12	return;
25		}
26
27	160	$description = $model->getDescriptionForEvent($eventName);
28
29	160	$logName = $model->getLogNameToUse($eventName);
30
31	160	if ($description == '') {
32		return;
33		}
34
35	160	$attrs = $model->attributeValuesToBeLogged($eventName);
36
37	160	if ($model->isLogEmpty($attrs) && ! $model->shouldSubmitEmptyLogs()) {
38	4	return;
39		}
40
41	160	$logger = app(ActivityLogger::class)
42	160	->useLog($logName)
43	160	->performedOn($model)
44	160	->withProperties($attrs);
45
46	160	if (method_exists($model, 'tapActivity')) {
47	4	$logger->tap([$model, 'tapActivity'], $eventName);
48		}
49
50	160	$logger->log($description);
51	168	});
52	168	});
53	168	}
54
55	68	public function shouldSubmitEmptyLogs(): bool
56		{
57	68	return ! isset(static::$submitEmptyLogs) ? true : static::$submitEmptyLogs;
58		}
59
60	160	public function isLogEmpty($attrs): bool
61		{
62	160	return empty($attrs['attributes'] ?? []) && empty($attrs['old'] ?? []);
63		}
64
65	12	public function disableLogging()
66		{
67	12	$this->enableLoggingModelsEvents = false;
68
69	12	return $this;
70		}
71
72	4	public function enableLogging()
73		{
74	4	$this->enableLoggingModelsEvents = true;
75
76	4	return $this;
77		}
78
79	24	public function activities(): MorphMany
80		{
81	24	return $this->morphMany(ActivitylogServiceProvider::determineActivityModel(), 'subject');
		0 ignored issues – show Bug introduced 2016-10-13 19:21 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...
82		}
83
84	156	public function getDescriptionForEvent(string $eventName): string
85		{
86	156	return $eventName;
87		}
88
89	156	public function getLogNameToUse(string $eventName = ''): string
		0 ignored issues – show Unused Code introduced 2017-07-31 12:11 UTC by Report Bug Copy Issue Report The parameter `$eventName` 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...
90		{
91	156	if (isset(static::$logName)) {
92	4	return static::$logName;
93		}
94
95	152	return config('activitylog.default_log_name');
96		}
97
98		/*
99		* Get the event names that should be recorded.
100		*/
101	168	protected static function eventsToBeRecorded(): Collection
102		{
103	168	if (isset(static::$recordEvents)) {
104		return collect(static::$recordEvents);
105		}
106
107	168	$events = collect([
108	168	'created',
109		'updated',
110		'deleted',
111		]);
112
113	168	if (collect(class_uses_recursive(static::class))->contains(SoftDeletes::class)) {
114	68	$events->push('restored');
115		}
116
117	168	return $events;
118		}
119
120	160	public function attributesToBeIgnored(): array
121		{
122	160	if (! isset(static::$ignoreChangedAttributes)) {
123	160	return [];
124		}
125
126		return static::$ignoreChangedAttributes;
127		}
128
129	164	protected function shouldLogEvent(string $eventName): bool
130		{
131	164	if (! $this->enableLoggingModelsEvents) {
132	8	return false;
133		}
134
135	160	if (! in_array($eventName, ['created', 'updated'])) {
136	24	return true;
137		}
138
139	160	if (Arr::has($this->getDirty(), 'deleted_at')) {
		0 ignored issues – show Bug introduced 2016-10-10 13:17 UTC by Report Bug Copy Issue Report It seems like `getDirty()` 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...
140	4	if ($this->getDirty()['deleted_at'] === null) {
		0 ignored issues – show Bug introduced 2016-10-10 13:17 UTC by Report Bug Copy Issue Report It seems like `getDirty()` 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...
141	4	return false;
142		}
143		}
144
145		//do not log update event if only ignored attributes are changed
146	160	return (bool) count(Arr::except($this->getDirty(), $this->attributesToBeIgnored()));
		0 ignored issues – show Bug introduced 2016-10-10 13:17 UTC by Report Bug Copy Issue Report It seems like `getDirty()` 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...
147		}
148		}
149

spatie / laravel-activitylog

Push — master ( 5bbd3f...3bee85 )

LogsActivity::getDescriptionForEvent() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like