Controller - Code Metrics - Inspection of "rename folder/namespace WEB to Web" - Porto-SAP/Hello-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#80)

unknown

created 2017-01-20 05:56 UTC

Controller A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes

Metric	Value
wmc	6
lcom	0
cbo	5
dl	0
loc	56
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	showLoginPage()	4	1
A	loginAdmin()	14	3
A	viewDashboardPage()	4	1
A	logoutAdmin()	6	1

<?php

namespace App\Containers\Authentication\UI\Web\Controllers;

use App\Containers\Authentication\Actions\WebAdminLoginAction;
use App\Containers\Authentication\Actions\WebLogoutAction;
use App\Containers\Authentication\Exceptions\AuthenticationFailedException;
use App\Containers\Authentication\UI\Web\Requests\LoginRequest;
use App\Containers\Authentication\UI\Web\Requests\ViewDashboardRequest;
use App\Port\Controller\Abstracts\PortWebController;

/**
 * Class Controller
 *
 * @author  Mahmoud Zalt  <[email protected]>
 */
class Controller extends PortWebController
{

    /**
     * @return  \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function showLoginPage()
    {
        return view('login');
    }

    /**
     * @param \App\Containers\Authentication\UI\Web\Requests\LoginRequest $request
     * @param \App\Containers\Authentication\Actions\WebAdminLoginAction  $action
     *
     * @return  $this|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function loginAdmin(LoginRequest $request, WebAdminLoginAction $action)
    {
        try {
            $result = $action->run($request->email, $request->password, $request->remember_me);
<?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.");
        }
    }

}
        } catch (AuthenticationFailedException $e) {
            return redirect('login')->with('status', $e->getMessage());
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        if (is_array($result)) {
            return view('login')->with($result);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        return redirect('dashboard');
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @param \App\Containers\Authentication\UI\Web\Requests\ViewDashboardRequest $request
     *
     * @return  \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function viewDashboardPage(ViewDashboardRequest $request)

    {
        return view('dashboard');
    }

    /**
     * @param \App\Containers\Authentication\Actions\WebLogoutAction $action
     *
     * @return  \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function logoutAdmin(WebLogoutAction $action)
    {
        $loggedOut = $action->run();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        return view('login');
    }


}


1			<?php
2
3			namespace App\Containers\Authentication\UI\Web\Controllers;
4
5			use App\Containers\Authentication\Actions\WebAdminLoginAction;
6			use App\Containers\Authentication\Actions\WebLogoutAction;
7			use App\Containers\Authentication\Exceptions\AuthenticationFailedException;
8			use App\Containers\Authentication\UI\Web\Requests\LoginRequest;
9			use App\Containers\Authentication\UI\Web\Requests\ViewDashboardRequest;
10			use App\Port\Controller\Abstracts\PortWebController;
11
12			/**
13			* Class Controller
14			*
15			* @author Mahmoud Zalt <[email protected]>
16			*/
17			class Controller extends PortWebController
18			{
19
20			/**
21			* @return \Illuminate\Contracts\View\Factory\|\Illuminate\View\View
22			*/
23			public function showLoginPage()
24			{
25			return view('login');
26			}
27
28			/**
29			* @param \App\Containers\Authentication\UI\Web\Requests\LoginRequest $request
30			* @param \App\Containers\Authentication\Actions\WebAdminLoginAction $action
31			*
32			* @return $this\|\Illuminate\Contracts\View\Factory\|\Illuminate\View\View
33			*/
34			public function loginAdmin(LoginRequest $request, WebAdminLoginAction $action)
35			{
36			try {
37			$result = $action->run($request->email, $request->password, $request->remember_me);
			0 ignored issues – show Documentation introduced 2017-01-20 05:59 UTC by Report Bug Copy Issue Report The property `email` does not exist on `object<App\Containers\Au...\Requests\LoginRequest>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2017-01-20 05:59 UTC by Report Bug Copy Issue Report The property `password` does not exist on `object<App\Containers\Au...\Requests\LoginRequest>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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... Documentation introduced 2017-01-20 05:59 UTC by Report Bug Copy Issue Report The property `remember_me` does not exist on `object<App\Containers\Au...\Requests\LoginRequest>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
38			} catch (AuthenticationFailedException $e) {
39			return redirect('login')->with('status', $e->getMessage());
			0 ignored issues – show Bug Best Practice introduced 2017-01-20 05:59 UTC by Report Bug Copy Issue Report The return type of `return redirect('login')...us', $e->getMessage());` (`Illuminate\Http\RedirectResponse`) is incompatible with the return type documented by `App\Containers\Authentic...\Controller::loginAdmin` of type `App\Containers\Authentic...ry\|Illuminate\View\View`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
40			}
41
42			if (is_array($result)) {
43			return view('login')->with($result);
			0 ignored issues – show Bug introduced 2016-09-09 20:46 UTC by Report Bug Copy Issue Report The method `with` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
44			}
45
46			return redirect('dashboard');
			0 ignored issues – show Bug Best Practice introduced 2017-01-20 05:59 UTC by Report Bug Copy Issue Report The return type of `return redirect('dashboard');` (`Illuminate\Http\RedirectResponse`) is incompatible with the return type documented by `App\Containers\Authentic...\Controller::loginAdmin` of type `App\Containers\Authentic...ry\|Illuminate\View\View`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
47			}
48
49			/**
50			* @param \App\Containers\Authentication\UI\Web\Requests\ViewDashboardRequest $request
51			*
52			* @return \Illuminate\Contracts\View\Factory\|\Illuminate\View\View
53			*/
54			public function viewDashboardPage(ViewDashboardRequest $request)
			0 ignored issues – show Unused Code introduced 2016-12-30 15:28 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...
55			{
56			return view('dashboard');
57			}
58
59			/**
60			* @param \App\Containers\Authentication\Actions\WebLogoutAction $action
61			*
62			* @return \Illuminate\Contracts\View\Factory\|\Illuminate\View\View
63			*/
64			public function logoutAdmin(WebLogoutAction $action)
65			{
66			$loggedOut = $action->run();
			0 ignored issues – show Unused Code introduced 2016-12-31 05:33 UTC by Report Bug Copy Issue Report `$loggedOut` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
67
68			return view('login');
69			}
70
71
72			}
73

Porto-SAP / Hello-API

Pull Request — master (#80)

Controller A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like