ApiTokenAuth::setPassword() - Code Metrics - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

ApiTokenAuth::setPassword() A
last analyzed 2017-12-27 06:16 UTC

↳ Parent: ApiTokenAuth

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Auth;

use Jitamin\Foundation\Base;
use Jitamin\Foundation\Security\PasswordAuthenticationProviderInterface;
use Jitamin\Model\UserModel;
use Jitamin\Services\Identity\DatabaseUserProvider;

/**
 * API Token Authentication Provider.
 */
class ApiTokenAuth extends Base implements PasswordAuthenticationProviderInterface
{
    /**
     * User properties.
     *
     * @var array
     */
    protected $userInfo = [];

    /**
     * Username.
     *
     * @var string
     */
    protected $username = '';

    /**
     * Password.
     *
     * @var string
     */
    protected $password = '';

    /**
     * Get authentication provider name.
     *
     * @return string
     */
    public function getName()
    {
        return 'API Access Token';
    }

    /**
     * Authenticate the user.
     *
     * @return bool
     */
    public function authenticate()
    {
        if (!isset($this->sessionStorage->scope) || $this->sessionStorage->scope !== 'API') {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->logger->debug(__METHOD__.': Authentication provider skipped because invalid scope');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

            return false;
        }

        $user = $this->db
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->table(UserModel::TABLE)
            ->columns('id', 'password')
            ->eq('username', $this->username)
            ->eq('api_token', $this->password)
            ->notNull('api_token')
            ->eq('is_active', 1)
            ->findOne();

        if (!empty($user)) {
            $this->userInfo = $user;

            return true;
        }

        return false;
    }

    /**
     * Get user object.
     *
     * @return Jitamin\Services\Identity\DatabaseUserProvider
     */
    public function getUser()
    {
        if (empty($this->userInfo)) {
            return;
        }

        return new DatabaseUserProvider($this->userInfo);
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());
}
    }

    /**
     * Set username.
     *
     * @param string $username
     */
    public function setUsername($username)
    {
        $this->username = $username;
    }

    /**
     * Set password.
     *
     * @param string $password
     */
    public function setPassword($password)
    {
        $this->password = $password;
    }
}


1			<?php
2
3			/*
4			* This file is part of Jitamin.
5			*
6			* Copyright (C) Jitamin Team
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Jitamin\Auth;
13
14			use Jitamin\Foundation\Base;
15			use Jitamin\Foundation\Security\PasswordAuthenticationProviderInterface;
16			use Jitamin\Model\UserModel;
17			use Jitamin\Services\Identity\DatabaseUserProvider;
18
19			/**
20			* API Token Authentication Provider.
21			*/
22			class ApiTokenAuth extends Base implements PasswordAuthenticationProviderInterface
23			{
24			/**
25			* User properties.
26			*
27			* @var array
28			*/
29			protected $userInfo = [];
30
31			/**
32			* Username.
33			*
34			* @var string
35			*/
36			protected $username = '';
37
38			/**
39			* Password.
40			*
41			* @var string
42			*/
43			protected $password = '';
44
45			/**
46			* Get authentication provider name.
47			*
48			* @return string
49			*/
50			public function getName()
51			{
52			return 'API Access Token';
53			}
54
55			/**
56			* Authenticate the user.
57			*
58			* @return bool
59			*/
60			public function authenticate()
61			{
62			if (!isset($this->sessionStorage->scope) \|\| $this->sessionStorage->scope !== 'API') {
			0 ignored issues – show Documentation introduced 2016-12-25 13:54 UTC by Report Bug Copy Issue Report The property `sessionStorage` does not exist on `object<Jitamin\Auth\ApiTokenAuth>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
63			$this->logger->debug(__METHOD__.': Authentication provider skipped because invalid scope');
			0 ignored issues – show Documentation introduced 2016-12-25 13:54 UTC by Report Bug Copy Issue Report The property `logger` does not exist on `object<Jitamin\Auth\ApiTokenAuth>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
64
65			return false;
66			}
67
68			$user = $this->db
			0 ignored issues – show Documentation introduced 2016-12-25 13:54 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Auth\ApiTokenAuth>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
69			->table(UserModel::TABLE)
70			->columns('id', 'password')
71			->eq('username', $this->username)
72			->eq('api_token', $this->password)
73			->notNull('api_token')
74			->eq('is_active', 1)
75			->findOne();
76
77			if (!empty($user)) {
78			$this->userInfo = $user;
79
80			return true;
81			}
82
83			return false;
84			}
85
86			/**
87			* Get user object.
88			*
89			* @return Jitamin\Services\Identity\DatabaseUserProvider
90			*/
91			public function getUser()
92			{
93			if (empty($this->userInfo)) {
94			return;
95			}
96
97			return new DatabaseUserProvider($this->userInfo);
			0 ignored issues – show Bug Best Practice introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The return type of `return new \Jitamin\Serv...vider($this->userInfo);` (`Jitamin\Services\Identity\DatabaseUserProvider`) is incompatible with the return type declared by the interface `Jitamin\Foundation\Secur...viderInterface::getUser` of type `Jitamin\Foundation\User\UserProviderInterface`. 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...
98			}
99
100			/**
101			* Set username.
102			*
103			* @param string $username
104			*/
105			public function setUsername($username)
106			{
107			$this->username = $username;
108			}
109
110			/**
111			* Set password.
112			*
113			* @param string $password
114			*/
115			public function setPassword($password)
116			{
117			$this->password = $password;
118			}
119			}
120

Jitamin / jitamin

ApiTokenAuth::setPassword() A last analyzed 2017-12-27 06:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ApiTokenAuth::setPassword() A
last analyzed 2017-12-27 06:16 UTC