Psr7Authenticate::getUser() - Code Metrics - CakeDC/cakephp-api - Measure and Improve Code Quality continuously with Scrutinizer

Psr7Authenticate::getUser() A
last analyzed 2021-05-07 09:37 UTC

↳ Parent: Psr7Authenticate

Complexity

Conditions	4
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
nc	5
nop	1
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0
ccs	0
cts	11
cp	0
crap	20

<?php
/**
 * Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
 */

/**
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @since         0.10.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */

namespace CakeDC\Api\Service\Auth\Authenticate;

use Authentication\IdentityInterface;
use Cake\Datasource\EntityInterface;
use Cake\Http\Response;
use Cake\Http\ServerRequest;

/**
 * Class FormAuthenticate.
 */
class Psr7Authenticate extends BaseAuthenticate
{

    /**
     * Authenticates the identity contained in a request. Will use the `config.userModel`, and `config.fields`
     * to find POST data that is used to find a matching record in the `config.userModel`. Will return false if
     * there is no post data, either username or password is missing, or if the scope conditions have not been met.
     *
     * @param \Cake\Http\ServerRequest $request The request that contains login information.
     * @param \Cake\Http\Response $response Unused response object.
     * @return mixed False on login failure.  An array of User data on success.
     */
    public function authenticate(ServerRequest $request, Response $response)
    {
        return $this->getUser($request);
    }

    /**
     * Get a user based on information in the request. Primarily used by stateless authentication
     * systems like basic and digest auth.
     *
     * @param \Cake\Http\ServerRequest $request Request object.
     * @return mixed Either false or an array of user information
     */
    public function getUser(ServerRequest $request)
    {
        $authResult = $request->getAttribute('authentication')->getResult();
        if (!$authResult->isValid()) {
            return false;
        }

        $result = $request->getAttribute('identity');

        if ($result instanceof IdentityInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $result = $result->getOriginalData();
        }
        if ($result instanceof EntityInterface) {
            return $result->toArray();
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());
}
        }

        return $result;
    }
}


1			<?php
2			/**
3			* Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
4			*
5			* Licensed under The MIT License
6			* Redistributions of files must retain the above copyright notice.
7			*
8			* @copyright Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
9			* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
10			*/
11
12			/**
13			* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
14			* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
15			*
16			* Licensed under The MIT License
17			* For full copyright and license information, please see the LICENSE.txt
18			* Redistributions of files must retain the above copyright notice.
19			*
20			* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
21			* @link http://cakephp.org CakePHP(tm) Project
22			* @since 0.10.0
23			* @license http://www.opensource.org/licenses/mit-license.php MIT License
24			*/
25
26			namespace CakeDC\Api\Service\Auth\Authenticate;
27
28			use Authentication\IdentityInterface;
29			use Cake\Datasource\EntityInterface;
30			use Cake\Http\Response;
31			use Cake\Http\ServerRequest;
32
33			/**
34			* Class FormAuthenticate.
35			*/
36			class Psr7Authenticate extends BaseAuthenticate
37			{
38
39			/**
40			* Authenticates the identity contained in a request. Will use the `config.userModel`, and `config.fields`
41			* to find POST data that is used to find a matching record in the `config.userModel`. Will return false if
42			* there is no post data, either username or password is missing, or if the scope conditions have not been met.
43			*
44			* @param \Cake\Http\ServerRequest $request The request that contains login information.
45			* @param \Cake\Http\Response $response Unused response object.
46			* @return mixed False on login failure. An array of User data on success.
47			*/
48			public function authenticate(ServerRequest $request, Response $response)
49			{
50			return $this->getUser($request);
51			}
52
53			/**
54			* Get a user based on information in the request. Primarily used by stateless authentication
55			* systems like basic and digest auth.
56			*
57			* @param \Cake\Http\ServerRequest $request Request object.
58			* @return mixed Either false or an array of user information
59			*/
60			public function getUser(ServerRequest $request)
61			{
62			$authResult = $request->getAttribute('authentication')->getResult();
63			if (!$authResult->isValid()) {
64			return false;
65			}
66
67			$result = $request->getAttribute('identity');
68
69			if ($result instanceof IdentityInterface) {
			0 ignored issues – show Bug introduced 2018-04-06 23:53 UTC by Report Bug Copy Issue Report The class `Authentication\IdentityInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
70			$result = $result->getOriginalData();
71			}
72			if ($result instanceof EntityInterface) {
73			return $result->toArray();
			0 ignored issues – show Bug Best Practice introduced 2018-02-26 16:21 UTC by Report Bug Copy Issue Report The return type of `return $result->toArray();` (`array`) is incompatible with the return type of the parent method `CakeDC\Api\Service\Auth\...seAuthenticate::getUser` 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...
74			}
75
76			return $result;
77			}
78			}
79

CakeDC / cakephp-api

Psr7Authenticate::getUser() A last analyzed 2021-05-07 09:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

Psr7Authenticate::getUser() A
last analyzed 2021-05-07 09:37 UTC