FlipsideAuthenticator::getUserFromToken() - Code Metrics - Inspection of "Feature/static urls" - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#92)

by Patrick

created 2018-10-03 15:11 UTC

FlipsideAuthenticator::getUserFromToken() A

↳ Parent: FlipsideAuthenticator

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0

<?php
namespace Auth\OAuth2;

class FlipsideAuthenticator extends OAuth2Authenticator
{
    private $apiUrl;
    private $oauthUrl;

    public function __construct($params)
    {
        $this->settings = \Settings::getInstance();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->profilesUrl = $this->settings->getGlobalSetting('profiles_url', 'https://profiles.burningflipside.com/');
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->apiUrl = $this->profilesUrl.'api/v1';
        $this->oauthUrl = $this->profilesUrl.'OAUTH2';
    
        parent::__construct($params);
        if(isset($params['api_url']))
        {
            $this->apiUrl = $params['api_url'];
        }
        if(isset($params['oauth_url']))
        {
            $this->oauthUrl = $params['oauth_url'];
        }
    }

    public function getHostName()
    {
        return 'burningflipside.com';
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());
}
    }

    public function getAuthorizationUrl()
    {
        return $this->oauthUrl.'/authorize.php?client_id=test&redirect_uri='.urlencode($this->redirect_uri).'&scope=user';
    }

    public function getAccessTokenUrl()
    {
        return $this->oauthUrl.'/token.php?client_id=test&redirect_uri='.urlencode($this->redirect_uri);
    }

    public function getUserFromToken($token)
    {
        if($token === false)
        {
            $token = \FlipSession::getVar('OAuthToken');
        }
        $resp = \Httpful\Request::get($this->apiUrl.'/users/me')->addHeader('Authorization', 'token '.$token['access_token'])->send();
        $data = array('extended'=>$resp->body);
        $user = new \Auth\FlipsideAPIUser($data);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $user->addLoginProvider($this->getHostName());
        return $user;
    }

    public function login($username, $password)
    {
        $resp = \Httpful\Request::post($this->apiUrl.'/login?username='.urlencode($username).'&password='.urlencode($password))->send();
        if($resp->hasErrors())
        {
            return false;
        }
        $this->user = $resp->body->extended;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->user->userPassword = $password;
        return array('res'=>true, 'extended'=>$this->user);
    }

    public function isLoggedIn($data)
    {
        if(isset($this->user))
        {
            return true;
        }
        if(isset($data['res']))
        {
            return $data['res'];
        }
        return false;
    }

    public function getUser($data)
    {
        return new \Auth\FlipsideAPIUser($data, $this->apiUrl);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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


1			<?php
2			namespace Auth\OAuth2;
3
4			class FlipsideAuthenticator extends OAuth2Authenticator
5			{
6			private $apiUrl;
7			private $oauthUrl;
8
9			public function __construct($params)
10			{
11			$this->settings = \Settings::getInstance();
			0 ignored issues – show Bug introduced 2018-10-03 02:08 UTC by Report Bug Copy Issue Report The property `settings` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
12			$this->profilesUrl = $this->settings->getGlobalSetting('profiles_url', 'https://profiles.burningflipside.com/');
			0 ignored issues – show Bug introduced 2017-02-19 02:15 UTC by Report Bug Copy Issue Report The property `profilesUrl` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
13			$this->apiUrl = $this->profilesUrl.'api/v1';
14			$this->oauthUrl = $this->profilesUrl.'OAUTH2';
15
16			parent::__construct($params);
17			if(isset($params['api_url']))
18			{
19			$this->apiUrl = $params['api_url'];
20			}
21			if(isset($params['oauth_url']))
22			{
23			$this->oauthUrl = $params['oauth_url'];
24			}
25			}
26
27			public function getHostName()
28			{
29			return 'burningflipside.com';
			0 ignored issues – show Bug Best Practice introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report The return type of `return 'burningflipside.com';` (`string`) is incompatible with the return type of the parent method `Auth\Authenticator::getHostName` of type `boolean`. 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...
30			}
31
32			public function getAuthorizationUrl()
33			{
34			return $this->oauthUrl.'/authorize.php?client_id=test&redirect_uri='.urlencode($this->redirect_uri).'&scope=user';
35			}
36
37			public function getAccessTokenUrl()
38			{
39			return $this->oauthUrl.'/token.php?client_id=test&redirect_uri='.urlencode($this->redirect_uri);
40			}
41
42			public function getUserFromToken($token)
43			{
44			if($token === false)
45			{
46			$token = \FlipSession::getVar('OAuthToken');
47			}
48			$resp = \Httpful\Request::get($this->apiUrl.'/users/me')->addHeader('Authorization', 'token '.$token['access_token'])->send();
49			$data = array('extended'=>$resp->body);
50			$user = new \Auth\FlipsideAPIUser($data);
			0 ignored issues – show Documentation introduced 2017-02-10 00:28 UTC by Report Bug Copy Issue Report `$data` is of type `array<string,array\|strin..."array\|string\|object"}>`, but the function expects a `boolean`. 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...
51			$user->addLoginProvider($this->getHostName());
52			return $user;
53			}
54
55			public function login($username, $password)
56			{
57			$resp = \Httpful\Request::post($this->apiUrl.'/login?username='.urlencode($username).'&password='.urlencode($password))->send();
58			if($resp->hasErrors())
59			{
60			return false;
61			}
62			$this->user = $resp->body->extended;
			0 ignored issues – show Bug introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report The property `user` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
63			$this->user->userPassword = $password;
64			return array('res'=>true, 'extended'=>$this->user);
65			}
66
67			public function isLoggedIn($data)
68			{
69			if(isset($this->user))
70			{
71			return true;
72			}
73			if(isset($data['res']))
74			{
75			return $data['res'];
76			}
77			return false;
78			}
79
80			public function getUser($data)
81			{
82			return new \Auth\FlipsideAPIUser($data, $this->apiUrl);
			0 ignored issues – show Documentation introduced 2017-03-01 21:38 UTC by Report Bug Copy Issue Report `$this->apiUrl` is of type `string`, but the function expects a `boolean`. 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...
83			}
84			}
85

BurningFlipside / CommonCode

Pull Request — develop (#92)

FlipsideAuthenticator::getUserFromToken() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like