NotificationController - Code Metrics - Inspection of "Adds the ability to create new notifications" - librenms/librenmsv2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#48)

by Neil

created 2016-03-07 17:04 UTC

NotificationController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	71
Duplicated Lines	18.31 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	7
Bugs	1	Features	2

Metric	Value
wmc	10
c	7
b	1
f	2
lcom	1
cbo	5
dl	13
loc	71
rs	10

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	2	1
A	index()	0	11	2
B	update()	6	23	5
A	create()	7	15	2

How to fix Duplicated Code

<?php

namespace App\Api\Controllers;

use Dingo\Api\Http;
use Dingo\Api\Routing\Helpers;
use App\User;
use App\Notification;
use App\NotificationAttrib;
use Illuminate\Http\Request;

class NotificationController extends Controller
{

    use Helpers;

    public function __construct() {
    }

    /**
     * Display a listing of all notifications
     *
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request, $type = null)
    {
        if ($type === 'archive')
        {
            $notifications = Notification::IsArchived($request)->get();

        }
        else {
            $notifications = Notification::IsUnread()->get();

        }
        return $notifications;
    }

    public function update(Request $request, $id, $action)

    {

        $notification = Notification::find($id);
        $enable = strpos($action, 'un') === false;
        if(!$enable) {
            $action = substr($action, 2);
        }

        if ($action == 'read') {
           $result = $notification->markRead($enable);
        }
        elseif ($action == 'sticky') {
           $result = $notification->markSticky(false);
        }

        if ($result === false) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            return $this->response->errorInternal();
        }
        else {
            return $this->response->array(array('statusText' => 'OK'));
        }
    }

    /**
     * Create a new notification
     *
     * @return \Illuminate\Http\Response
     */
    public function create(Request $request)
    {
        $notification = new Notification;
        $notification->title    = $request->title;
<?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.");
        }
    }

}
        $notification->body     = $request->body;
<?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.");
        }
    }

}
        $notification->checksum = hash('sha512',$request->user()->user_id.'.LOCAL.'.$request->title);
<?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.");
        }
    }

}
        $notification->source   = $request->user()->user_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.");
        }
    }

}
        if ($notification->save())

        {
            return $this->response->array(array('statusText' => 'OK'));
        }
        else {
            return $this->response->errorInternal();
        }
    }

}


1		<?php
2
3		namespace App\Api\Controllers;
4
5		use Dingo\Api\Http;
6		use Dingo\Api\Routing\Helpers;
7		use App\User;
8		use App\Notification;
9		use App\NotificationAttrib;
10		use Illuminate\Http\Request;
11
12		class NotificationController extends Controller
13		{
14
15		use Helpers;
16
17		public function __construct() {
18		}
19
20		/**
21		* Display a listing of all notifications
22		*
23		* @return \Illuminate\Http\Response
24		*/
25		public function index(Request $request, $type = null)
26		{
27		if ($type === 'archive')
28		{
29		$notifications = Notification::IsArchived($request)->get();
		0 ignored issues – show Bug introduced 2016-03-03 11:41 UTC by Report Bug Copy Issue Report The method `IsArchived()` does not exist on `App\Notification`. Did you maybe mean `scopeIsArchived()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
30		}
31		else {
32		$notifications = Notification::IsUnread()->get();
		0 ignored issues – show Bug introduced 2016-03-03 11:41 UTC by Report Bug Copy Issue Report The method `IsUnread()` does not exist on `App\Notification`. Did you maybe mean `scopeIsUnread()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
33		}
34		return $notifications;
35		}
36
37		public function update(Request $request, $id, $action)
		1 ignored issue – show Unused Code introduced 2016-03-03 20:30 UTC by Report Bug Copy Issue Report The parameter `$request` 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...
38		{
39
40		$notification = Notification::find($id);
41		$enable = strpos($action, 'un') === false;
42		if(!$enable) {
43		$action = substr($action, 2);
44		}
45
46		if ($action == 'read') {
47		$result = $notification->markRead($enable);
48		}
49		elseif ($action == 'sticky') {
50		$result = $notification->markSticky(false);
51		}
52
53	View Code Duplication	if ($result === false) {
		0 ignored issues – show Bug introduced 2016-03-03 20:30 UTC by Report Bug Copy Issue Report The variable `$result` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Duplication introduced 2016-03-01 01:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
54		return $this->response->errorInternal();
55		}
56		else {
57		return $this->response->array(array('statusText' => 'OK'));
58		}
59		}
60
61		/**
62		* Create a new notification
63		*
64		* @return \Illuminate\Http\Response
65		*/
66		public function create(Request $request)
67		{
68		$notification = new Notification;
69		$notification->title = $request->title;
		1 ignored issue – show Documentation introduced 2016-03-07 17:11 UTC by Report Bug Copy Issue Report The property `title` does not exist on `object<App\Notification>`. 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... Bug introduced 2016-03-07 17:11 UTC by Report Bug Copy Issue Report The property `title` does not seem to exist in `Illuminate\Http\Request`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
70		$notification->body = $request->body;
		1 ignored issue – show Documentation introduced 2016-03-07 17:11 UTC by Report Bug Copy Issue Report The property `body` does not exist on `object<App\Notification>`. 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... Bug introduced 2016-03-07 17:11 UTC by Report Bug Copy Issue Report The property `body` does not seem to exist in `Illuminate\Http\Request`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
71		$notification->checksum = hash('sha512',$request->user()->user_id.'.LOCAL.'.$request->title);
		0 ignored issues – show Documentation introduced 2016-03-07 17:11 UTC by Report Bug Copy Issue Report The property `checksum` does not exist on `object<App\Notification>`. 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...
72		$notification->source = $request->user()->user_id;
		0 ignored issues – show Documentation introduced 2016-03-07 17:11 UTC by Report Bug Copy Issue Report The property `source` does not exist on `object<App\Notification>`. 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...
73	View Code Duplication	if ($notification->save())
		0 ignored issues – show Duplication introduced 2016-03-07 17:11 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74		{
75		return $this->response->array(array('statusText' => 'OK'));
76		}
77		else {
78		return $this->response->errorInternal();
79		}
80		}
81
82		}
83

librenms / librenmsv2

Pull Request — develop (#48)

NotificationController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like