RouteServiceProvider   A
last analyzed

Complexity

Total Complexity 3

Size/Duplication

Total Lines 32
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1
Metric Value
wmc 3
lcom 0
cbo 1
dl 0
loc 32
rs 10

3 Methods

Rating   Name   Duplication   Size   Complexity  
A getFrontendRoute() 0 4 1
A getBackendRoute() 0 4 1
A getApiRoute() 0 4 1
1
<?php namespace Modules\Media\Providers;
2
3
use Modules\Core\Providers\RoutingServiceProvider as CoreRoutingServiceProvider;
4
5
class RouteServiceProvider extends CoreRoutingServiceProvider
6
{
7
    /**
8
     * The root namespace to assume when generating URLs to actions.
9
     * @var string
10
     */
11
    protected $namespace = 'Modules\Media\Http\Controllers';
12
13
    /**
14
     * @return string
15
     */
16
    protected function getFrontendRoute()
17
    {
18
        return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type declared by the abstract method Modules\Core\Providers\R...vider::getFrontendRoute of type string.

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...
19
    }
20
21
    /**
22
     * @return string
23
     */
24
    protected function getBackendRoute()
25
    {
26
        return __DIR__ . '/../Http/backendRoutes.php';
27
    }
28
29
    /**
30
     * @return string
31
     */
32
    protected function getApiRoute()
33
    {
34
        return __DIR__ . '/../Http/apiRoutes.php';
35
    }
36
}
37