StartSession::getSessionId() - Code Metrics - nixsolutions/ggf - Measure and Improve Code Quality continuously with Scrutinizer

StartSession::getSessionId() A
last analyzed 2017-03-03 15:36 UTC

↳ Parent: StartSession

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

namespace App\Http\Middleware;

use Illuminate\Contracts\Auth\Guard;
use Illuminate\Session\SessionManager;
use Illuminate\Http\Request;
use Closure;

/**
 * Class StartSession
 * @package App\Http\Middleware
 */
class StartSession extends \Illuminate\Session\Middleware\StartSession
{
    /**
     * @var Guard
     */
    protected $auth;

    /**
     * Create a new session middleware.
     * StartSession constructor.
     * @param SessionManager $manager
     * @param Guard $auth
     */
    public function __construct(SessionManager $manager, Guard $auth)
    {
        parent::__construct($manager);
        $this->manager = $manager;
        $this->auth = $auth;
    }

    /**
     * @inheritdoc
     */
    public function getSession(Request $request)
    {
        $session = $this->manager->driver();
        $session->setId($this->getSessionId($request, $session));


        return $session;
    }

    /**
     * @param Request $request
     * @return mixed
     */
    protected function getSessionId(Request $request)
    {
        return $this->auth->getSession($request);
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.
    }
}
    }

    /**
     * Handle an incoming request, but skip OPTIONS method
     *
     * @inheritdoc
     */
    public function handle($request, Closure $next)
    {
        if ($request->isMethod('options')) {
            return $next($request);
        }

        return parent::handle($request, $next);
    }
}


1			<?php
2
3			namespace App\Http\Middleware;
4
5			use Illuminate\Contracts\Auth\Guard;
6			use Illuminate\Session\SessionManager;
7			use Illuminate\Http\Request;
8			use Closure;
9
10			/**
11			* Class StartSession
12			* @package App\Http\Middleware
13			*/
14			class StartSession extends \Illuminate\Session\Middleware\StartSession
15			{
16			/**
17			* @var Guard
18			*/
19			protected $auth;
20
21			/**
22			* Create a new session middleware.
23			* StartSession constructor.
24			* @param SessionManager $manager
25			* @param Guard $auth
26			*/
27			public function __construct(SessionManager $manager, Guard $auth)
28			{
29			parent::__construct($manager);
30			$this->manager = $manager;
31			$this->auth = $auth;
32			}
33
34			/**
35			* @inheritdoc
36			*/
37			public function getSession(Request $request)
38			{
39			$session = $this->manager->driver();
40			$session->setId($this->getSessionId($request, $session));
			0 ignored issues – show Unused Code introduced 2016-12-02 12:04 UTC by Report Bug Copy Issue Report The call to `StartSession::getSessionId()` has too many arguments starting with `$session`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
41
42			return $session;
43			}
44
45			/**
46			* @param Request $request
47			* @return mixed
48			*/
49			protected function getSessionId(Request $request)
50			{
51			return $this->auth->getSession($request);
			0 ignored issues – show Bug introduced 2016-12-02 12:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Guard` as the method `getSession()` does only exist in the following implementations of said interface: `Illuminate\Auth\SessionGuard`. 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...
52			}
53
54			/**
55			* Handle an incoming request, but skip OPTIONS method
56			*
57			* @inheritdoc
58			*/
59			public function handle($request, Closure $next)
60			{
61			if ($request->isMethod('options')) {
62			return $next($request);
63			}
64
65			return parent::handle($request, $next);
66			}
67			}
68

nixsolutions / ggf

StartSession::getSessionId() A last analyzed 2017-03-03 15:36 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

StartSession::getSessionId() A
last analyzed 2017-03-03 15:36 UTC