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

Completed

Push — master ( 685eb3...3e4363 )

by Freek

created 2016-06-25 14:26 UTC

LogsActivity::getDescriptionForEvent() A

↳ Parent: LogsActivity

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Spatie\Activitylog\Traits;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Support\Collection;
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;
                }

                app(ActivityLogger::class)
                    ->performedOn($model)
                    ->withProperties($model->getPropertiesToBeLogged())
                    ->log($description);
            });

        });
    }

    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(): Collection
    {
        if (isset(static::$recordEvents)) {
            return collect(static::$recordEvents);
        }

        return collect([
            '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 Illuminate\Support\Collection;
8			use Spatie\Activitylog\ActivityLogger;
9
10			trait LogsActivity
11			{
12			use DetectsChanges;
13
14			protected static function bootLogsActivity()
15			{
16			collect(static::eventsToBeRecorded())->each(function ($eventName) {
17
18			return static::$eventName(function (Model $model) use ($eventName) {
19
20			$description = $model->getDescriptionForEvent($eventName);
21
22			if ($description == '') {
23			return;
24			}
25
26			app(ActivityLogger::class)
27			->performedOn($model)
28			->withProperties($model->getPropertiesToBeLogged())
29			->log($description);
30			});
31
32			});
33			}
34
35			public function causesActivity(): MorphTo
36			{
37			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...
38			}
39
40			public function getDescriptionForEvent(string $eventName): string
41			{
42			return $eventName;
43			}
44
45			/*
46			* Get the event names that should be recorded.
47			*/
48			protected static function eventsToBeRecorded(): Collection
49			{
50			if (isset(static::$recordEvents)) {
51			return collect(static::$recordEvents);
52			}
53
54			return collect([
55			'created',
56			'updated',
57			'deleted',
58			]);
59			}
60			}
61

spatie / laravel-activitylog

Push — master ( 685eb3...3e4363 )

LogsActivity::getDescriptionForEvent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like