Completed
Push — develop ( f7252d...97603d )
by Mohamed
04:44
created

AdministrationController   A

Complexity

Total Complexity 1

Size/Duplication

Total Lines 24
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 5

Test Coverage

Coverage 0%

Importance

Changes 4
Bugs 0 Features 1
Metric Value
wmc 1
c 4
b 0
f 1
lcom 1
cbo 5
dl 0
loc 24
ccs 0
cts 12
cp 0
rs 10

1 Method

Rating   Name   Duplication   Size   Complexity  
A getIndex() 0 12 1
1
<?php
2
3
/*
4
 * This file is part of the Tinyissue package.
5
 *
6
 * (c) Mohamed Alsharaf <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Tinyissue\Http\Controllers;
13
14
use Tinyissue\Model\Project;
15
use Tinyissue\Model\Tag;
16
use Tinyissue\Model\User;
17
18
/**
19
 * AdministrationController is the controller class for managing request related the application system admin
20
 *
21
 * @author Mohamed Alsharaf <[email protected]>
22
 */
23
class AdministrationController extends Controller
24
{
25
    /**
26
     * Show general application stats
27
     *
28
     * @param Tag     $tag
29
     * @param Project $project
30
     * @param User    $user
31
     *
32
     * @return \Illuminate\View\View
33
     */
34
    public function getIndex(Tag $tag, Project $project, User $user)
35
    {
36
        return view('administration.index', [
0 ignored issues
show
Bug Compatibility introduced by
The expression view('administration.ind...gs' => $tag->count())); of type Illuminate\View\View|Ill...\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 36 which is incompatible with the return type documented by Tinyissue\Http\Controlle...ionController::getIndex of type Illuminate\View\View.
Loading history...
37
            'users'             => $user->countUsers(),
38
            'active_projects'   => $project->countOpenProjects(),
39
            'archived_projects' => $project->countArchivedProjects(),
40
            'open_issues'       => $project->countOpenIssues(),
41
            'closed_issues'     => $project->countClosedIssues(),
42
            'projects'          => $this->auth->user()->projects()->get(),
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Auth\Authenticatable as the method projects() does only exist in the following implementations of said interface: Tinyissue\Model\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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
43
            'tags'              => $tag->count(),
44
        ]);
45
    }
46
}
47