ResourceRegistrar::getResourceName() - Code Metrics - Inspection of "Made method name check to fit all Laravel 5.* vers..." - cariboufute/locale-route - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0bdd85...3b978d )

by Frédéric

created 2017-02-10 15:26 UTC

ResourceRegistrar::getResourceName() A

↳ Parent: ResourceRegistrar

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	3
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
ccs	3
cts	4
cp	0.75
crap	2.0625

<?php

namespace CaribouFute\LocaleRoute\Routing;

use CaribouFute\LocaleRoute\Routing\LocaleRouter;
use CaribouFute\LocaleRoute\Traits\ConfigParams;
use Illuminate\Routing\ResourceRegistrar as IlluminateResourceRegistrar;
use Illuminate\Routing\Router as IlluminateRouter;
use Illuminate\Translation\Translator;

class ResourceRegistrar extends IlluminateResourceRegistrar
{
    use ConfigParams;

    protected $localeRouter;
    protected $translator;

    public function __construct(LocaleRouter $localeRouter, IlluminateRouter $router, Translator $translator)
    {
        $this->localeRouter = $localeRouter;
        $this->translator = $translator;

        parent::__construct($router);
    }

    protected function getLocaleResourceAction($controller, $method)
    {
        return $controller . '@' . $method;
    }

    /**
     *  Get resource name for both Laravel 5.4 (getResourceRouteName) and Laravel <5.4 (getResourceName)
     *  @param $resource: the resource name
     *  @param $method: the controller method
     *  @param $options: different options
     *  @return the route name
     */
    protected function getResourceName($resource, $method, $options)
    {
        if (method_exists($this, 'getResourceRouteName')) {
            return $this->getResourceRouteName($resource, $method, $options);
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());
}
        } else {
            return parent::getResourceName($resource, $method, $options);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        }
    }

    protected function addResourceIndex($name, $base, $controller, $options)
    {
        $uri = $this->getResourceUri($name);
        $name = $this->getResourceName($name, 'index', $options);
        $action = $this->getLocaleResourceAction($controller, 'index');

        return $this->localeRouter->get($name, $action, $uri);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    protected function addResourceCreate($name, $base, $controller, $options)
    {
        $base = $this->getResourceUri($name);
        $uris = $this->getLocaleUris($base, 'create', $options);
        $name = $this->getResourceName($name, 'create', $options);
        $action = $this->getLocaleResourceAction($controller, 'create');

        return $this->localeRouter->get($name, $action, $uris);
    }

    protected function getLocaleUris($base, $label, $options)
    {
        $uris = [];

        foreach ($this->locales($options) as $locale) {
            $uris[$locale] = $base . '/' . $this->getTranslation($locale, $label);
        }

        return $uris;
    }

    protected function getTranslation($locale, $label)
    {
        $untranslated = 'route-labels.' . $label;
        $translated = $this->translator->get($untranslated, [], $locale);
        return $translated === $untranslated ? $label : $translated;
    }

    protected function addResourceShow($name, $base, $controller, $options)
    {
        $uri = $this->getResourceUri($name) . '/{' . $base . '}';
        $name = $this->getResourceName($name, 'show', $options);
        $action = $this->getLocaleResourceAction($controller, 'show');

        return $this->localeRouter->get($name, $action, $uri);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    protected function addResourceEdit($name, $base, $controller, $options)
    {
        $base = $this->getResourceUri($name) . '/{' . $base . '}';
        $uris = $this->getLocaleUris($base, 'edit', $options);
        $name = $this->getResourceName($name, 'edit', $options);
        $action = $this->getLocaleResourceAction($controller, 'edit');

        return $this->localeRouter->get($name, $action, $uris);
    }

}


1		<?php
2
3		namespace CaribouFute\LocaleRoute\Routing;
4
5		use CaribouFute\LocaleRoute\Routing\LocaleRouter;
6		use CaribouFute\LocaleRoute\Traits\ConfigParams;
7		use Illuminate\Routing\ResourceRegistrar as IlluminateResourceRegistrar;
8		use Illuminate\Routing\Router as IlluminateRouter;
9		use Illuminate\Translation\Translator;
10
11		class ResourceRegistrar extends IlluminateResourceRegistrar
12		{
13		use ConfigParams;
14
15		protected $localeRouter;
16		protected $translator;
17
18	3	public function __construct(LocaleRouter $localeRouter, IlluminateRouter $router, Translator $translator)
19		{
20	3	$this->localeRouter = $localeRouter;
21	3	$this->translator = $translator;
22
23	3	parent::__construct($router);
24	3	}
25
26	3	protected function getLocaleResourceAction($controller, $method)
27		{
28	3	return $controller . '@' . $method;
29		}
30
31		/**
32		* Get resource name for both Laravel 5.4 (getResourceRouteName) and Laravel <5.4 (getResourceName)
33		* @param $resource: the resource name
34		* @param $method: the controller method
35		* @param $options: different options
36		* @return the route name
37		*/
38	3	protected function getResourceName($resource, $method, $options)
39		{
40	3	if (method_exists($this, 'getResourceRouteName')) {
41	3	return $this->getResourceRouteName($resource, $method, $options);
		0 ignored issues – show Bug Best Practice introduced 2017-02-10 15:32 UTC by Report Bug Copy Issue Report The return type of `return $this->getResourc...ce, $method, $options);` (`string`) is incompatible with the return type documented by `CaribouFute\LocaleRoute\...istrar::getResourceName` of type `CaribouFute\LocaleRoute\Routing\the`. 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...
42		} else {
43		return parent::getResourceName($resource, $method, $options);
		0 ignored issues – show Bug introduced 2017-02-10 15:32 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Illuminate\Routing\ResourceRegistrar` as the method `getResourceName()` does only exist in the following sub-classes of `Illuminate\Routing\ResourceRegistrar`: `CaribouFute\LocaleRoute\Routing\ResourceRegistrar`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
44		}
45		}
46
47	1	protected function addResourceIndex($name, $base, $controller, $options)
48		{
49	1	$uri = $this->getResourceUri($name);
50	1	$name = $this->getResourceName($name, 'index', $options);
51	1	$action = $this->getLocaleResourceAction($controller, 'index');
52
53	1	return $this->localeRouter->get($name, $action, $uri);
		0 ignored issues – show Documentation introduced 2016-11-27 19:02 UTC by Report Bug Copy Issue Report `$uri` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
54		}
55
56	3	protected function addResourceCreate($name, $base, $controller, $options)
57		{
58	3	$base = $this->getResourceUri($name);
59	3	$uris = $this->getLocaleUris($base, 'create', $options);
60	3	$name = $this->getResourceName($name, 'create', $options);
61	3	$action = $this->getLocaleResourceAction($controller, 'create');
62
63	3	return $this->localeRouter->get($name, $action, $uris);
64		}
65
66	3	protected function getLocaleUris($base, $label, $options)
67		{
68	3	$uris = [];
69
70	3	foreach ($this->locales($options) as $locale) {
71	3	$uris[$locale] = $base . '/' . $this->getTranslation($locale, $label);
72		}
73
74	3	return $uris;
75		}
76
77	3	protected function getTranslation($locale, $label)
78		{
79	3	$untranslated = 'route-labels.' . $label;
80	3	$translated = $this->translator->get($untranslated, [], $locale);
81	3	return $translated === $untranslated ? $label : $translated;
82		}
83
84	2	protected function addResourceShow($name, $base, $controller, $options)
85		{
86	2	$uri = $this->getResourceUri($name) . '/{' . $base . '}';
87	2	$name = $this->getResourceName($name, 'show', $options);
88	2	$action = $this->getLocaleResourceAction($controller, 'show');
89
90	2	return $this->localeRouter->get($name, $action, $uri);
		0 ignored issues – show Documentation introduced 2016-11-27 19:02 UTC by Report Bug Copy Issue Report `$uri` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
91		}
92
93	3	protected function addResourceEdit($name, $base, $controller, $options)
94		{
95	3	$base = $this->getResourceUri($name) . '/{' . $base . '}';
96	3	$uris = $this->getLocaleUris($base, 'edit', $options);
97	3	$name = $this->getResourceName($name, 'edit', $options);
98	3	$action = $this->getLocaleResourceAction($controller, 'edit');
99
100	3	return $this->localeRouter->get($name, $action, $uris);
101		}
102
103		}
104

cariboufute / locale-route

Push — master ( 0bdd85...3b978d )

ResourceRegistrar::getResourceName() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like