OauthTokenGuard::__construct() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/metacl..." - metaclassing/PHP7-Laravel5-EnterpriseAuth - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1164b2...5d6ac0 )

by meta

created 2018-05-14 15:15 UTC

OauthTokenGuard::__construct() A

↳ Parent: OauthTokenGuard

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	2
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0

<?php

namespace Metaclassing\EnterpriseAuth\Middleware;

use Illuminate\Http\Request;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Contracts\Auth\Authenticatable;

class OauthTokenGuard implements Guard
{
    protected $request;
    protected $provider;
    protected $user;

    /**
     * Create a new authentication guard.
     *
     * @param  \Illuminate\Contracts\Auth\UserProvider  $provider
     * @param  \Illuminate\Http\Request  $request
     * @return void
     */
    public function __construct(UserProvider $provider, Request $request)
    {
        $this->request = $request;
        $this->provider = $provider;
        $this->user = null;

        // use the API auth controller helper functions to check the user creds
        $apiAuthController = new \Metaclassing\EnterpriseAuth\Controllers\ApiAuthController();
        $this->user = $apiAuthController->authenticateRequest($request);
    }

    /**
     * Determine if the current user is authenticated.
     *
     * @return bool
     */
    public function check()
    {
        return ! is_null($this->user());
    }

    /**
     * Determine if the current user is a guest.
     *
     * @return bool
     */
    public function guest()
    {
        return ! $this->check();
    }

    /**
     * Get the currently authenticated user.
     *
     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public function user()
    {
        if (! is_null($this->user)) {
            return $this->user;
        }
    }

    /**
     * Get the JSON params from the current request.
     *
     * @return string
     */
    /*
        public function getJsonParams()
        {
            $jsondata = $this->request->query('jsondata');

            return (!empty($jsondata) ? json_decode($jsondata, TRUE) : NULL);
        }
    /**/

    /**
     * Get the ID for the currently authenticated user.
     *
     * @return string|null
     */
    public function id()
    {
        if ($user = $this->user()) {

            return $this->user()->getAuthIdentifier();
        }
    }

    /**
     * Validate a user's credentials.
     *
     * @return bool
     */
    public function validate(array $credentials = [])
    {
        return is_null($this->user);
    }

    /**
     * Set the current user.
     *
     * @param  array $user User info
     */
    public function setUser(Authenticatable $user)
    {
        $this->user = $user;

        return $this;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1			<?php
2
3			namespace Metaclassing\EnterpriseAuth\Middleware;
4
5			use Illuminate\Http\Request;
6			use Illuminate\Contracts\Auth\Guard;
7			use Illuminate\Contracts\Auth\UserProvider;
8			use Illuminate\Contracts\Auth\Authenticatable;
9
10			class OauthTokenGuard implements Guard
11			{
12			protected $request;
13			protected $provider;
14			protected $user;
15
16			/**
17			* Create a new authentication guard.
18			*
19			* @param \Illuminate\Contracts\Auth\UserProvider $provider
20			* @param \Illuminate\Http\Request $request
21			* @return void
22			*/
23			public function __construct(UserProvider $provider, Request $request)
24			{
25			$this->request = $request;
26			$this->provider = $provider;
27			$this->user = null;
28
29			// use the API auth controller helper functions to check the user creds
30			$apiAuthController = new \Metaclassing\EnterpriseAuth\Controllers\ApiAuthController();
31			$this->user = $apiAuthController->authenticateRequest($request);
32			}
33
34			/**
35			* Determine if the current user is authenticated.
36			*
37			* @return bool
38			*/
39			public function check()
40			{
41			return ! is_null($this->user());
42			}
43
44			/**
45			* Determine if the current user is a guest.
46			*
47			* @return bool
48			*/
49			public function guest()
50			{
51			return ! $this->check();
52			}
53
54			/**
55			* Get the currently authenticated user.
56			*
57			* @return \Illuminate\Contracts\Auth\Authenticatable\|null
58			*/
59			public function user()
60			{
61			if (! is_null($this->user)) {
62			return $this->user;
63			}
64			}
65
66			/**
67			* Get the JSON params from the current request.
68			*
69			* @return string
70			*/
71			/*
72			public function getJsonParams()
73			{
74			$jsondata = $this->request->query('jsondata');
75
76			return (!empty($jsondata) ? json_decode($jsondata, TRUE) : NULL);
77			}
78			/**/
79
80			/**
81			* Get the ID for the currently authenticated user.
82			*
83			* @return string\|null
84			*/
85			public function id()
86			{
87			if ($user = $this->user()) {
			0 ignored issues – show Unused Code introduced 2018-05-02 03:49 UTC by Report Bug Copy Issue Report The assignment to `$user` is dead and can be removed. Loading history...
88			return $this->user()->getAuthIdentifier();
89			}
90			}
91
92			/**
93			* Validate a user's credentials.
94			*
95			* @return bool
96			*/
97			public function validate(array $credentials = [])
98			{
99			return is_null($this->user);
100			}
101
102			/**
103			* Set the current user.
104			*
105			* @param array $user User info
106			*/
107			public function setUser(Authenticatable $user)
108			{
109			$this->user = $user;
110
111			return $this;
			0 ignored issues – show Bug Best Practice introduced 2018-05-14 01:55 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `Metaclassing\EnterpriseA...dleware\OauthTokenGuard` which is incompatible with the return type mandated by `Illuminate\Contracts\Auth\Guard::setUser()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
112			}
113			}
114

metaclassing / PHP7-Laravel5-EnterpriseAuth

Push — master ( 1164b2...5d6ac0 )

OauthTokenGuard::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like