NotificationController::update() - Code Metrics - Inspection of "Added notifications pages and api calls" - librenms/librenmsv2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#38)

by Neil

created 2016-03-01 02:17 UTC

NotificationController::update() C

↳ Parent: NotificationController

Complexity

Conditions	8
Paths	6

Size

Total Lines	31
Code Lines	17

Duplication

Lines	14
Ratio	45.16 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	14
loc	31
rs	5.3846
cc	8
eloc	17
nc	6
nop	3

<?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::read([$request->user()->user_id])->limit()->get();

            $notifications = Notification::select('notifications.*','key')->leftJoin('notifications_attribs', 'notifications.notifications_id', '=', 'notifications_attribs.notifications_id')->where('user_id', $user_id)->where(['key'=>'read', 'value'=> 1]);

        }
        else {
            //$notifications = Notification::unread()->limit()->get();

            $notifications = Notification::select('notifications.*','key')->leftJoin('notifications_attribs', 'notifications.notifications_id', '=', 'notifications_attribs.notifications_id')->whereNull('user_id')->orWhere(['key'=>'sticky', 'value'=> 1])->get();
        }

        if ($request->query('displayFormat') == 'human') {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
        }
        return $notifications;
    }

    public function update(Request $request, $id, $action)
    {
        if ($action === 'read' || $action === 'sticky')
        {
            if (NotificationAttrib::where('notifications_id', $id)->delete() >= 0)
            {
                $read = new NotificationAttrib;
                $read->notifications_id = $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.");
        }
    }

}
                $read->user_id          = $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.");
        }
    }

}
                $read->key              = $action;
<?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.");
        }
    }

}
                $read->value            = 1;
<?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 ($read->save())

                {
                    return $this->response->array(array('statusText'=>'OK'));
                }
                else {
                    return $this->response->errorInternal();
                }
            }
        }
        elseif ($action === 'unread' || $action === 'unsticky')
        {
            if (NotificationAttrib::where('notifications_id', $id)->delete() >= 0)

            {
                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::read([$request->user()->user_id])->limit()->get();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-01 02:23 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
30		$notifications = Notification::select('notifications.*','key')->leftJoin('notifications_attribs', 'notifications.notifications_id', '=', 'notifications_attribs.notifications_id')->where('user_id', $user_id)->where(['key'=>'read', 'value'=> 1]);
		0 ignored issues – show Bug introduced 2016-03-01 02:23 UTC by Report Bug Copy Issue Report The variable `$user_id` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
31		}
32		else {
33		//$notifications = Notification::unread()->limit()->get();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-01 02:23 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
34		$notifications = Notification::select('notifications.*','key')->leftJoin('notifications_attribs', 'notifications.notifications_id', '=', 'notifications_attribs.notifications_id')->whereNull('user_id')->orWhere(['key'=>'sticky', 'value'=> 1])->get();
35		}
36
37		if ($request->query('displayFormat') == 'human') {
		0 ignored issues – show Unused Code introduced 2016-03-01 01:02 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
38		}
39		return $notifications;
40		}
41
42		public function update(Request $request, $id, $action)
43		{
44		if ($action === 'read' \|\| $action === 'sticky')
45		{
46		if (NotificationAttrib::where('notifications_id', $id)->delete() >= 0)
47		{
48		$read = new NotificationAttrib;
49		$read->notifications_id = $id;
		0 ignored issues – show Documentation introduced 2016-03-01 01:02 UTC by Report Bug Copy Issue Report The property `notifications_id` does not exist on `object<App\NotificationAttrib>`. 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...
50		$read->user_id = $request->user()->user_id;
		0 ignored issues – show Documentation introduced 2016-03-01 01:02 UTC by Report Bug Copy Issue Report The property `user_id` does not exist on `object<App\NotificationAttrib>`. 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...
51		$read->key = $action;
		0 ignored issues – show Documentation introduced 2016-03-01 01:02 UTC by Report Bug Copy Issue Report The property `key` does not exist on `object<App\NotificationAttrib>`. 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...
52		$read->value = 1;
		0 ignored issues – show Documentation introduced 2016-03-01 01:02 UTC by Report Bug Copy Issue Report The property `value` does not exist on `object<App\NotificationAttrib>`. 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...
53	View Code Duplication	if ($read->save())
		0 ignored issues – show 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		{
55		return $this->response->array(array('statusText'=>'OK'));
56		}
57		else {
58		return $this->response->errorInternal();
59		}
60		}
61		}
62		elseif ($action === 'unread' \|\| $action === 'unsticky')
63		{
64	View Code Duplication	if (NotificationAttrib::where('notifications_id', $id)->delete() >= 0)
		0 ignored issues – show 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...
65		{
66		return $this->response->array(array('statusText'=>'OK'));
67		}
68		else {
69		return $this->response->errorInternal();
70		}
71		}
72		}
73
74		}
75

librenms / librenmsv2

Pull Request — develop (#38)

NotificationController::update() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like