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

Changes::isToIgnore() B
last analyzed 2021-05-30 00:16 UTC

↳ Parent: Changes

Complexity

Conditions	8
Paths	11

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	29
rs	8.2114
c	0
b	0
f	0
cc	8
nc	11
nop	2

<?php

namespace Audit\Observers;

// Deps

use Audit\Models\Change;
use Event;
use Route;

/**
 * Create a log of all model changing events
 */
class Changes
{
    /**
     * Only log the following events
     *
     * @param array
     */
    protected $supported = ['created', 'updated', 'deleted'];

    protected $action = false;

    /**
     * Handle all Eloquent model events
     *
     * @param string $event
     * @param array  $payload Contains:
     *                        -
     *                        Audit\Models\Base
     *                        $model
     */
    public function handle($event, $payload)
    {
        list($model) = $payload;
        if ($this->isToIgnore($model, $event)) {
            return;
        }


        // If `log_changes` was configed as a callable, see if this model event
        // should not be logged
        if ($check = \Illuminate\Support\Facades\Config::get('sitec.site.log_changes')) {
            if (is_bool($check) && !$check) {
                return;
            }
            // Get the admin acting on the record
            $admin =  $this->getUser();
            if (is_callable($check)) {
                if (!call_user_func($check, $model, $this->action, $admin)) {
                    return;
                }
            }
        } else {
            return;
        }

        // Check with the model itself to see if it should be logged
        if (method_exists($model, 'shouldLogChange')) {
            if (!$model->shouldLogChange($this->action)) {
                return;
            }
            // Default to not logging changes if there is no shouldLogChange()
        } else {
            return;
        }
        \Log::debug('[Audit] Log Changes: '.get_class($model));
        // \Log::debug('[Audit] Log Changes: '.print_r($event, true).print_r($payload, true));

        // Log the event
        Change::log($model, $this->action, $admin);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    protected function getUser()
    {
        return app('facilitador.user');
    }

    protected function isToIgnore($model, $event)
    {
        // Don't log changes to pivot models.  Even though a user may have initiated
        // this, it's kind of meaningless to them.  These events can happen when a
        // user messes with drag and drop positioning.
        if (!empty($this->getDontLog())) {
            foreach ($this->getDontLog() as $logClass) {
                if (is_a($model, $logClass)) {
                    return true;
                }
            }
        }
        if (!empty($this->getDontLogAlias())) {
            foreach ($this->getDontLogAlias() as $logClassAlias) {
                if (strpos($event, $logClassAlias) !== false) {
                    return true;
                }
            }
        }

        // Get the action of the event
        preg_match('#eloquent\.(\w+)#', $event, $matches);
        $this->action = $matches[1];
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        if (!in_array($this->action, $this->supported)) {
            return true;
        }

        return false;
    }

    protected function getDontLog()
    {
        return \Illuminate\Support\Facades\Config::get(
            'sitec.audit.dontLog',
            [
                \Aschmelyun\Larametrics\Models\LarametricsLog::class,
                \Illuminate\Database\Eloquent\Relations\Pivot::class,
            ]
        );
    }

    protected function getDontLogAlias()
    {
        return \Illuminate\Support\Facades\Config::get(
            'sitec.audit.dontLogAlias',
            [
                'Tracking\Models',
                'Analytics',
                'Spatie\Analytics',
                'Wnx\LaravelStats',
                'Aschmelyun\Larametrics\Models',
                'Laravel\Horizon',
                'Support\Models\Application',
                'Support\Models\Ardent',
                'Support\Models\Code',
            ]
        );
    }
}


1			<?php
2
3			namespace Audit\Observers;
4
5			// Deps
6
7			use Audit\Models\Change;
8			use Event;
9			use Route;
10
11			/**
12			* Create a log of all model changing events
13			*/
14			class Changes
15			{
16			/**
17			* Only log the following events
18			*
19			* @param array
20			*/
21			protected $supported = ['created', 'updated', 'deleted'];
22
23			protected $action = false;
24
25			/**
26			* Handle all Eloquent model events
27			*
28			* @param string $event
29			* @param array $payload Contains:
30			* -
31			* Audit\Models\Base
32			* $model
33			*/
34			public function handle($event, $payload)
35			{
36			list($model) = $payload;
37			if ($this->isToIgnore($model, $event)) {
38			return;
39			}
40
41
42			// If `log_changes` was configed as a callable, see if this model event
43			// should not be logged
44			if ($check = \Illuminate\Support\Facades\Config::get('sitec.site.log_changes')) {
45			if (is_bool($check) && !$check) {
46			return;
47			}
48			// Get the admin acting on the record
49			$admin = $this->getUser();
50			if (is_callable($check)) {
51			if (!call_user_func($check, $model, $this->action, $admin)) {
52			return;
53			}
54			}
55			} else {
56			return;
57			}
58
59			// Check with the model itself to see if it should be logged
60			if (method_exists($model, 'shouldLogChange')) {
61			if (!$model->shouldLogChange($this->action)) {
62			return;
63			}
64			// Default to not logging changes if there is no shouldLogChange()
65			} else {
66			return;
67			}
68			\Log::debug('[Audit] Log Changes: '.get_class($model));
69			// \Log::debug('[Audit] Log Changes: '.print_r($event, true).print_r($payload, true));
70
71			// Log the event
72			Change::log($model, $this->action, $admin);
			0 ignored issues – show Documentation introduced 2020-12-21 20:07 UTC by Report Bug Copy Issue Report `$this->action` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
73			}
74
75			protected function getUser()
76			{
77			return app('facilitador.user');
78			}
79
80			protected function isToIgnore($model, $event)
81			{
82			// Don't log changes to pivot models. Even though a user may have initiated
83			// this, it's kind of meaningless to them. These events can happen when a
84			// user messes with drag and drop positioning.
85			if (!empty($this->getDontLog())) {
86			foreach ($this->getDontLog() as $logClass) {
87			if (is_a($model, $logClass)) {
88			return true;
89			}
90			}
91			}
92			if (!empty($this->getDontLogAlias())) {
93			foreach ($this->getDontLogAlias() as $logClassAlias) {
94			if (strpos($event, $logClassAlias) !== false) {
95			return true;
96			}
97			}
98			}
99
100			// Get the action of the event
101			preg_match('#eloquent\.(\w+)#', $event, $matches);
102			$this->action = $matches[1];
			0 ignored issues – show Documentation Bug introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report The property `$action` was declared of type `boolean`, but `$matches[1]` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
103			if (!in_array($this->action, $this->supported)) {
104			return true;
105			}
106
107			return false;
108			}
109
110			protected function getDontLog()
111			{
112			return \Illuminate\Support\Facades\Config::get(
113			'sitec.audit.dontLog',
114			[
115			\Aschmelyun\Larametrics\Models\LarametricsLog::class,
116			\Illuminate\Database\Eloquent\Relations\Pivot::class,
117			]
118			);
119			}
120
121			protected function getDontLogAlias()
122			{
123			return \Illuminate\Support\Facades\Config::get(
124			'sitec.audit.dontLogAlias',
125			[
126			'Tracking\Models',
127			'Analytics',
128			'Spatie\Analytics',
129			'Wnx\LaravelStats',
130			'Aschmelyun\Larametrics\Models',
131			'Laravel\Horizon',
132			'Support\Models\Application',
133			'Support\Models\Ardent',
134			'Support\Models\Code',
135			]
136			);
137			}
138			}
139

SierraTecnologia / Audit

Changes::isToIgnore() B last analyzed 2021-05-30 00:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Changes::isToIgnore() B
last analyzed 2021-05-30 00:16 UTC