FlipsideAuthenticator::login() - Code Metrics - Inspection of "Make PSR-4 compliant" - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( ed6c74...ceecfe )

by Patrick

created 2020-06-15 01:11 UTC

FlipsideAuthenticator::login() 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	2
dl	0
loc	11
rs	9.9
c	0
b	0
f	0

<?php
namespace Flipside\Auth\OAuth2;

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

    public function __construct($params)
    {
        parent::__construct($params);
        if(isset($params['api_url']))
        {
            $this->apiUrl = $params['api_url'];
        }
        else
        {
            throw new \Exception('Incorrectly configured! Missing api_url parameter.');
        }
        if(isset($params['oauth_url']))
        {
            $this->oauthUrl = $params['oauth_url'];
        }
        else
        {
            throw new \Exception('Incorrectly configured! Missing oauth_url parameter.');
        }
    }

    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);
        $user->addLoginProvider($this->getHostName());
        return $user;
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 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);
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());
}
    }
}


1			<?php
2			namespace Flipside\Auth\OAuth2;
3
4			class FlipsideAuthenticator extends OAuth2Authenticator
5			{
6			private $apiUrl;
7			private $oauthUrl;
8
9			public function __construct($params)
10			{
11			parent::__construct($params);
12			if(isset($params['api_url']))
13			{
14			$this->apiUrl = $params['api_url'];
15			}
16			else
17			{
18			throw new \Exception('Incorrectly configured! Missing api_url parameter.');
19			}
20			if(isset($params['oauth_url']))
21			{
22			$this->oauthUrl = $params['oauth_url'];
23			}
24			else
25			{
26			throw new \Exception('Incorrectly configured! Missing oauth_url parameter.');
27			}
28			}
29
30			public function getHostName()
31			{
32			return 'burningflipside.com';
			0 ignored issues – show Bug Best Practice introduced 2020-06-15 01:15 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 `Flipside\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...
33			}
34
35			public function getAuthorizationUrl()
36			{
37			return $this->oauthUrl.'/authorize.php?client_id=test&redirect_uri='.urlencode($this->redirect_uri).'&scope=user';
38			}
39
40			public function getAccessTokenUrl()
41			{
42			return $this->oauthUrl.'/token.php?client_id=test&redirect_uri='.urlencode($this->redirect_uri);
43			}
44
45			public function getUserFromToken($token)
46			{
47			if($token === false)
48			{
49			$token = \FlipSession::getVar('OAuthToken');
50			}
51			$resp = \Httpful\Request::get($this->apiUrl.'/users/me')->addHeader('Authorization', 'token '.$token['access_token'])->send();
52			$data = array('extended'=>$resp->body);
53			$user = new \Auth\FlipsideAPIUser($data);
54			$user->addLoginProvider($this->getHostName());
55			return $user;
			0 ignored issues – show Bug Best Practice introduced 2020-06-15 01:15 UTC by Report Bug Copy Issue Report The return type of `return $user;` (`Auth\FlipsideAPIUser`) is incompatible with the return type declared by the abstract method `Flipside\Auth\OAuth2\OAu...cator::getUserFromToken` of type `Auth\User`. 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...
56			}
57
58			public function login($username, $password)
59			{
60			$resp = \Httpful\Request::post($this->apiUrl.'/login?username='.urlencode($username).'&password='.urlencode($password))->send();
61			if($resp->hasErrors())
62			{
63			return false;
64			}
65			$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...
66			$this->user->userPassword = $password;
67			return array('res'=>true, 'extended'=>$this->user);
68			}
69
70			public function isLoggedIn($data)
71			{
72			if(isset($this->user))
73			{
74			return true;
75			}
76			if(isset($data['res']))
77			{
78			return $data['res'];
79			}
80			return false;
81			}
82
83			public function getUser($data)
84			{
85			return new \Auth\FlipsideAPIUser($data, $this->apiUrl);
			0 ignored issues – show Bug Best Practice introduced 2020-06-15 01:15 UTC by Report Bug Copy Issue Report The return type of `return new \Auth\Flipsid...($data, $this->apiUrl);` (`Auth\FlipsideAPIUser`) is incompatible with the return type of the parent method `Flipside\Auth\Authenticator::getUser` of type `null\|Auth\User`. 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...
86			}
87			}
88

BurningFlipside / CommonCode

Push — develop ( ed6c74...ceecfe )

FlipsideAuthenticator::login() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like