BackTo::setSessionContainer() - Code Metrics - atukai/AtBase - Measure and Improve Code Quality continuously with Scrutinizer

BackTo::setSessionContainer() A
last analyzed 2016-06-30 10:58 UTC

↳ Parent: BackTo

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

namespace AtBase\Mvc\Controller\Plugin;

use Zend\Mvc\Controller\Plugin\AbstractPlugin;
use Zend\Session\Container;

class BackTo extends AbstractPlugin
{
    /**
     * @var string
     */
    protected $paramName = 'backto';

    /**
     * @var
     */
    protected $sessionContainer;

    /**
     * @param $name
     */
    public function setParamName($name)
    {
        $this->paramName = (string) $name;
    }

    /**
     * @param \Zend\Session\Container $container
     * @return BackTo
     */
    public function setSessionContainer(Container $container)
    {
        $this->sessionContainer = $container;
        return $this;
    }

    /**
     * @return mixed
     */
    public function getSessionContainer()
    {
        if (!$this->sessionContainer) {
            $this->sessionContainer = new Container('at_base');
        }

        return $this->sessionContainer;
    }

    /**
     * @param null $url
     */
    public function setBackUrl($url = null)
    {
        if ($url) {
            $url = (string) $url;
        } else {
            $url = $this->getController()->getRequest()->getRequestUri();
        }

        $session = $this->getSessionContainer();
        $session->{$this->paramName} = $url;
    }

    /**
     * @param bool $flush
     * @return string
     */
    public function getBackUrl($flush = true)
    {
        $backUrl = '/';

        $session = $this->getSessionContainer();
        if (isset($session->{$this->paramName})) {
            $backUrl = $session->{$this->paramName};
        }

        if ($flush) {
            $this->flush();
        }

        return $backUrl;
    }

    /**
     * @return BackTo
     */
    public function flush()
    {
        $session = $this->getSessionContainer();
        unset($session->{$this->paramName});
        return $this;
    }

    /**
     *
     */
    public function previous($message = null)
    {
        // Return if it is ajax request
        if ($this->getController()->getRequest()->isXmlHttpRequest()) {
            return;
        }

        if ($message) {
            $this->getController()->flashMessenger()->addMessage($message);

        }

        $this->getController()->redirect()->toUrl($this->getBackUrl());
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.
    }
}
    }
}

1			<?php
2
3			namespace AtBase\Mvc\Controller\Plugin;
4
5			use Zend\Mvc\Controller\Plugin\AbstractPlugin;
6			use Zend\Session\Container;
7
8			class BackTo extends AbstractPlugin
9			{
10			/**
11			* @var string
12			*/
13			protected $paramName = 'backto';
14
15			/**
16			* @var
17			*/
18			protected $sessionContainer;
19
20			/**
21			* @param $name
22			*/
23			public function setParamName($name)
24			{
25			$this->paramName = (string) $name;
26			}
27
28			/**
29			* @param \Zend\Session\Container $container
30			* @return BackTo
31			*/
32			public function setSessionContainer(Container $container)
33			{
34			$this->sessionContainer = $container;
35			return $this;
36			}
37
38			/**
39			* @return mixed
40			*/
41			public function getSessionContainer()
42			{
43			if (!$this->sessionContainer) {
44			$this->sessionContainer = new Container('at_base');
45			}
46
47			return $this->sessionContainer;
48			}
49
50			/**
51			* @param null $url
52			*/
53			public function setBackUrl($url = null)
54			{
55			if ($url) {
56			$url = (string) $url;
57			} else {
58			$url = $this->getController()->getRequest()->getRequestUri();
59			}
60
61			$session = $this->getSessionContainer();
62			$session->{$this->paramName} = $url;
63			}
64
65			/**
66			* @param bool $flush
67			* @return string
68			*/
69			public function getBackUrl($flush = true)
70			{
71			$backUrl = '/';
72
73			$session = $this->getSessionContainer();
74			if (isset($session->{$this->paramName})) {
75			$backUrl = $session->{$this->paramName};
76			}
77
78			if ($flush) {
79			$this->flush();
80			}
81
82			return $backUrl;
83			}
84
85			/**
86			* @return BackTo
87			*/
88			public function flush()
89			{
90			$session = $this->getSessionContainer();
91			unset($session->{$this->paramName});
92			return $this;
93			}
94
95			/**
96			*
97			*/
98			public function previous($message = null)
99			{
100			// Return if it is ajax request
101			if ($this->getController()->getRequest()->isXmlHttpRequest()) {
102			return;
103			}
104
105			if ($message) {
106			$this->getController()->flashMessenger()->addMessage($message);
			0 ignored issues – show Bug introduced 2016-06-30 10:58 UTC by Report Bug Copy Issue Report The method `flashMessenger()` does not seem to exist on `object<Zend\Stdlib\DispatchableInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
107			}
108
109			$this->getController()->redirect()->toUrl($this->getBackUrl());
			0 ignored issues – show Bug introduced 2016-06-30 10:58 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\DispatchableInterface` as the method `redirect()` does only exist in the following implementations of said interface: `Zend\Mvc\Controller\AbstractActionController`, `Zend\Mvc\Controller\AbstractController`, `Zend\Mvc\Controller\AbstractRestfulController`. 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...
110			}
111			}

atukai / AtBase

BackTo::setSessionContainer() A last analyzed 2016-06-30 10:58 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

BackTo::setSessionContainer() A
last analyzed 2016-06-30 10:58 UTC