PageController::index() - Code Metrics - Inspection of "Re-add scrutinizer" - XetaIO/Xetaravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (a6481d)

by Fèvre

created 2017-05-04 00:12 UTC

PageController::index() A

↳ Parent: PageController

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	10
nc	1
nop	0

<?php
namespace Xetaravel\Http\Controllers;

use Xetaravel\Models\Article;
use Xetaravel\Models\Comment;
use Illuminate\Support\Facades\Auth;

class PageController extends Controller
{
    /**
     * Show the home page.
     *
     * @return \Illuminate\Http\Response

     */
    public function index()
    {
        $articles = Article::with('category', 'user')
            ->latest()
            ->limit(6)
            ->get();

        $comments = Comment::with('article', 'user')
            ->latest()
            ->limit(4)
            ->get();

        return view('page.index', ['articles' => $articles, 'comments' => $comments]);
    }

    /**
     * Display the banished page.
     *
     * @return \Illuminate\Http\Response

     */
    public function banished()
    {
        if (!Auth::user()->hasRole('banished')) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            return redirect()
                ->route('page_index');
        }

        return view('page.banished');
    }
}


1			<?php
2			namespace Xetaravel\Http\Controllers;
3
4			use Xetaravel\Models\Article;
5			use Xetaravel\Models\Comment;
6			use Illuminate\Support\Facades\Auth;
7
8			class PageController extends Controller
9			{
10			/**
11			* Show the home page.
12			*
13			* @return \Illuminate\Http\Response
			0 ignored issues – show Documentation introduced 2017-05-04 00:08 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\View\View\|\I...\Contracts\View\Factory`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
14			*/
15			public function index()
16			{
17			$articles = Article::with('category', 'user')
18			->latest()
19			->limit(6)
20			->get();
21
22			$comments = Comment::with('article', 'user')
23			->latest()
24			->limit(4)
25			->get();
26
27			return view('page.index', ['articles' => $articles, 'comments' => $comments]);
28			}
29
30			/**
31			* Display the banished page.
32			*
33			* @return \Illuminate\Http\Response
			0 ignored issues – show Documentation introduced 2017-05-04 00:08 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\Http\Redirec...\Contracts\View\Factory`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
34			*/
35			public function banished()
36			{
37			if (!Auth::user()->hasRole('banished')) {
			0 ignored issues – show Bug introduced 2017-05-03 18:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `hasRole()` does only exist in the following implementations of said interface: `Xetaravel\Models\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
38			return redirect()
39			->route('page_index');
40			}
41
42			return view('page.banished');
43			}
44			}
45

XetaIO / Xetaravel

Branch — master (a6481d)

PageController::index() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like