SwitchLocaleController - Code Metrics - Inspection of "prepare ZF3" - gregorybesson/PlaygroundCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( e37f14...da7aa8 )

by greg

created 2016-03-06 20:28 UTC

SwitchLocaleController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	7
Bugs	0	Features	0

Metric	Value
wmc	4
c	7
b	0
f	0
lcom	1
cbo	4
dl	0
loc	39
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getServiceLocator()	5	1
A	switchAction()	11	2

<?php
namespace PlaygroundCore\Controller\Frontend;

use Zend\Mvc\Controller\AbstractActionController;
use Zend\ServiceManager\ServiceLocatorInterface;

class SwitchLocaleController extends AbstractActionController
{
    /**
     *
     * @var ServiceManager
     */
    protected $serviceLocator;

    public function __construct(ServiceLocatorInterface $locator)
    {
        $this->serviceLocator = $locator;

    }

    public function getServiceLocator()
    {
        
        return $this->serviceLocator;
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());
}
    }

    /**
    * switchAction : permet de switcher de langue en fonction d'un context (back/front)
    * locale : locale pour switch
    * context : (back/front)
    * referer : retour à la page
    *
    * @return Redirect $redirect redirect to referer
    */
    public function switchAction()
    {
        $lang = $this->getEvent()->getRouteMatch()->getParam('lang');
        $context = $this->getEvent()->getRouteMatch()->getParam('area');
        $redirect = (!empty($this->getEvent()->getRouteMatch()->getParam('redirect')))? urldecode($this->getEvent()->getRouteMatch()->getParam('redirect')) : '/'.$lang;

        $cookie = new \Zend\Http\Header\SetCookie('pg_locale_'.$context, $lang, time() + 60*60*24*365, '/');
        $this->getResponse()->getHeaders()->addHeader($cookie);
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 $this->redirect()->toUrl($redirect);
    }
}


1			<?php
2			namespace PlaygroundCore\Controller\Frontend;
3
4			use Zend\Mvc\Controller\AbstractActionController;
5			use Zend\ServiceManager\ServiceLocatorInterface;
6
7			class SwitchLocaleController extends AbstractActionController
8			{
9			/**
10			*
11			* @var ServiceManager
12			*/
13			protected $serviceLocator;
14
15			public function __construct(ServiceLocatorInterface $locator)
16			{
17			$this->serviceLocator = $locator;
			0 ignored issues – show Documentation Bug introduced 2016-03-06 20:31 UTC by Report Bug Copy Issue Report It seems like `$locator` of type `object<Zend\ServiceManag...erviceLocatorInterface>` is incompatible with the declared type `object<PlaygroundCore\Co...rontend\ServiceManager>` of property `$serviceLocator`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
18			}
19
20			public function getServiceLocator()
21			{
22
23			return $this->serviceLocator;
			0 ignored issues – show Bug Best Practice introduced 2016-03-06 20:31 UTC by Report Bug Copy Issue Report The return type of `return $this->serviceLocator;` (`PlaygroundCore\Controller\Frontend\ServiceManager`) is incompatible with the return type of the parent method `Zend\Mvc\Controller\Abst...ller::getServiceLocator` of type `Zend\ServiceManager\ServiceLocatorInterface`. 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...
24			}
25
26			/**
27			* switchAction : permet de switcher de langue en fonction d'un context (back/front)
28			* locale : locale pour switch
29			* context : (back/front)
30			* referer : retour à la page
31			*
32			* @return Redirect $redirect redirect to referer
33			*/
34			public function switchAction()
35			{
36			$lang = $this->getEvent()->getRouteMatch()->getParam('lang');
37			$context = $this->getEvent()->getRouteMatch()->getParam('area');
38			$redirect = (!empty($this->getEvent()->getRouteMatch()->getParam('redirect')))? urldecode($this->getEvent()->getRouteMatch()->getParam('redirect')) : '/'.$lang;
39
40			$cookie = new \Zend\Http\Header\SetCookie('pg_locale_'.$context, $lang, time() + 606024*365, '/');
41			$this->getResponse()->getHeaders()->addHeader($cookie);
			0 ignored issues – show Bug introduced 2015-12-19 15:36 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\ResponseInterface` as the method `getHeaders()` does only exist in the following implementations of said interface: `Zend\Http\PhpEnvironment\Response`, `Zend\Http\Response`, `Zend\Http\Response\Stream`. 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...
42
43			return $this->redirect()->toUrl($redirect);
44			}
45			}
46

gregorybesson / PlaygroundCore

Push — develop ( e37f14...da7aa8 )

SwitchLocaleController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like