Proxy::getRequestMode() - Code Metrics - Cellcote/laravel-proxify - Measure and Improve Code Quality continuously with Scrutinizer

Proxy::getRequestMode() B
last analyzed 2016-05-24 09:25 UTC

↳ Parent: Proxy

Complexity

Conditions	5
Paths	4

Size

Total Lines	15
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

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

<?php

/**
 * @package   cellcote/laravel-proxify
 * @author    Michele Andreoli <michi.andreoli[at]gmail.com>
 * @copyright Copyright (c) Michele Andreoli
 * @author    Rik Schreurs <rik.schreurs[at]mail.com>
 * @copyright Copyright (c) Rik Schreurs
 * @license   http://mit-license.org/
 * @link      https://github.com/cellcote/laravel-proxify
 */

namespace Cellcote\LaravelProxify;

use Cellcote\LaravelProxify\Exceptions\CookieExpiredException;
use Cellcote\LaravelProxify\Exceptions\ProxyMissingParamException;
use Cellcote\LaravelProxify\Managers\CookieManager;
use Cellcote\LaravelProxify\Managers\RequestManager;
use Illuminate\Http\Response;

class Proxy {
    
    private $callMode = null;
    private $uriParam = null;
    private $skipParam = null;
    private $redirectUri = null;
    private $clientSecrets = null;
    private $cookieManager = null;
    private $useHeader = false;

    /**
     * @param $params
     */
    public function __construct($params) {
        $this->skipParam = $params['skip_param'];
        $this->redirectUri = $params['redirect_login'];
        $this->clientSecrets = $params['client_secrets'];
        $this->useHeader = $params['use_header'];
        $this->cookieManager = new CookieManager($params['cookie_info']);
    }

    /**
     * @param $method
     * @param array $inputs
     * @return Response
     * @throws CookieExpiredException
     * @throws ProxyMissingParamException
     * @throws \Exception
     */
    public function makeRequest($method, Array $inputs, $url) {
        $this->uri = $url;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        //Retrieve the call mode from input parameters
        $this->callMode = $this->getRequestMode($inputs);

        //Remove parameters from inputs
        $inputs = ProxyAux::removeQueryValue($inputs, $this->uriParam);
        $inputs = ProxyAux::removeQueryValue($inputs, $this->skipParam);

        //Read the cookie if exists
        $parsedCookie = null;
        if ($this->callMode !== ProxyAux::MODE_SKIP) {
            try {
                $parsedCookie = $this->cookieManager->tryParseCookie($this->callMode);
            } catch (CookieExpiredException $ex) {
                if (isset($this->redirectUri) && !empty($this->redirectUri)) {
                    return \Redirect::to($this->redirectUri);
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());
}
                }
                throw $ex;
            }
        }

        //Create the new request
        $requestManager = new RequestManager($this->uri, $method, $this->clientSecrets, $this->callMode, $this->cookieManager);
        if ($this->useHeader) {
            $requestManager->enableHeader();
        }
        $proxyResponse = $requestManager->executeRequest($inputs, $parsedCookie);

        return $this->setApiResponse($proxyResponse['response'], $proxyResponse['cookie']);
    }

    /**
     * @param $inputs
     * @return string
     */
    private function getRequestMode($inputs) {
        $grantType = ProxyAux::getQueryValue($inputs, ProxyAux::GRANT_TYPE);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $skip = ProxyAux::getQueryValue($inputs, $this->skipParam);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $mode = ProxyAux::MODE_TOKEN;

        if (isset($grantType)) {
            if ($grantType === ProxyAux::PASSWORD_GRANT) {
                $mode = ProxyAux::MODE_LOGIN;
            }
        } else if (isset($skip) && strtolower($skip) === 'true') {
            $mode = ProxyAux::MODE_SKIP;
        }

        return $mode;
    }

    /**
     * @param $proxyResponse
     * @param $cookie
     * @return Response
     */
    private function setApiResponse($proxyResponse, $cookie) {
        $response = new Response($proxyResponse->getContent(), $proxyResponse->getStatusCode());

        if ($this->callMode === ProxyAux::MODE_LOGIN) {
            $response->setContent(json_encode($this->successAccessToken()));
        }
        if (isset($cookie)) {
            $response->withCookie($cookie);
        }

        return $response;
    }

    /**
     * @return array
     */
    private function successAccessToken() {
        return array(
            'success_code' => 'access_token_ok',
            'success_message' => \Lang::get('api-proxy-laravel::messages.access_token_ok')
        );
    }

}

1			<?php
2
3			/**
4			* @package cellcote/laravel-proxify
5			* @author Michele Andreoli <michi.andreoli[at]gmail.com>
6			* @copyright Copyright (c) Michele Andreoli
7			* @author Rik Schreurs <rik.schreurs[at]mail.com>
8			* @copyright Copyright (c) Rik Schreurs
9			* @license http://mit-license.org/
10			* @link https://github.com/cellcote/laravel-proxify
11			*/
12
13			namespace Cellcote\LaravelProxify;
14
15			use Cellcote\LaravelProxify\Exceptions\CookieExpiredException;
16			use Cellcote\LaravelProxify\Exceptions\ProxyMissingParamException;
17			use Cellcote\LaravelProxify\Managers\CookieManager;
18			use Cellcote\LaravelProxify\Managers\RequestManager;
19			use Illuminate\Http\Response;
20
21			class Proxy {
22
23			private $callMode = null;
24			private $uriParam = null;
25			private $skipParam = null;
26			private $redirectUri = null;
27			private $clientSecrets = null;
28			private $cookieManager = null;
29			private $useHeader = false;
30
31			/**
32			* @param $params
33			*/
34			public function __construct($params) {
35			$this->skipParam = $params['skip_param'];
36			$this->redirectUri = $params['redirect_login'];
37			$this->clientSecrets = $params['client_secrets'];
38			$this->useHeader = $params['use_header'];
39			$this->cookieManager = new CookieManager($params['cookie_info']);
40			}
41
42			/**
43			* @param $method
44			* @param array $inputs
45			* @return Response
46			* @throws CookieExpiredException
47			* @throws ProxyMissingParamException
48			* @throws \Exception
49			*/
50			public function makeRequest($method, Array $inputs, $url) {
51			$this->uri = $url;
			0 ignored issues – show Bug introduced 2015-12-14 21:23 UTC by Report Bug Copy Issue Report The property `uri` 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...
52
53			//Retrieve the call mode from input parameters
54			$this->callMode = $this->getRequestMode($inputs);
55
56			//Remove parameters from inputs
57			$inputs = ProxyAux::removeQueryValue($inputs, $this->uriParam);
58			$inputs = ProxyAux::removeQueryValue($inputs, $this->skipParam);
59
60			//Read the cookie if exists
61			$parsedCookie = null;
62			if ($this->callMode !== ProxyAux::MODE_SKIP) {
63			try {
64			$parsedCookie = $this->cookieManager->tryParseCookie($this->callMode);
65			} catch (CookieExpiredException $ex) {
66			if (isset($this->redirectUri) && !empty($this->redirectUri)) {
67			return \Redirect::to($this->redirectUri);
			0 ignored issues – show Bug Best Practice introduced 2015-12-14 19:52 UTC by Report Bug Copy Issue Report The return type of `return \Redirect::to($this->redirectUri);` (`Illuminate\Http\RedirectResponse`) is incompatible with the return type documented by `Cellcote\LaravelProxify\Proxy::makeRequest` of type `Illuminate\Http\Response`. 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...
68			}
69			throw $ex;
70			}
71			}
72
73			//Create the new request
74			$requestManager = new RequestManager($this->uri, $method, $this->clientSecrets, $this->callMode, $this->cookieManager);
75			if ($this->useHeader) {
76			$requestManager->enableHeader();
77			}
78			$proxyResponse = $requestManager->executeRequest($inputs, $parsedCookie);
79
80			return $this->setApiResponse($proxyResponse['response'], $proxyResponse['cookie']);
81			}
82
83			/**
84			* @param $inputs
85			* @return string
86			*/
87			private function getRequestMode($inputs) {
88			$grantType = ProxyAux::getQueryValue($inputs, ProxyAux::GRANT_TYPE);
			0 ignored issues – show Bug introduced 2015-12-14 19:52 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$grantType` is correct as `\Cellcote\LaravelProxify...y\ProxyAux::GRANT_TYPE)` (which targets `Cellcote\LaravelProxify\ProxyAux::getQueryValue()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
89			$skip = ProxyAux::getQueryValue($inputs, $this->skipParam);
			0 ignored issues – show Bug introduced 2015-12-14 19:52 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$skip` is correct as `\Cellcote\LaravelProxify...puts, $this->skipParam)` (which targets `Cellcote\LaravelProxify\ProxyAux::getQueryValue()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
90			$mode = ProxyAux::MODE_TOKEN;
91
92			if (isset($grantType)) {
93			if ($grantType === ProxyAux::PASSWORD_GRANT) {
94			$mode = ProxyAux::MODE_LOGIN;
95			}
96			} else if (isset($skip) && strtolower($skip) === 'true') {
97			$mode = ProxyAux::MODE_SKIP;
98			}
99
100			return $mode;
101			}
102
103			/**
104			* @param $proxyResponse
105			* @param $cookie
106			* @return Response
107			*/
108			private function setApiResponse($proxyResponse, $cookie) {
109			$response = new Response($proxyResponse->getContent(), $proxyResponse->getStatusCode());
110
111			if ($this->callMode === ProxyAux::MODE_LOGIN) {
112			$response->setContent(json_encode($this->successAccessToken()));
113			}
114			if (isset($cookie)) {
115			$response->withCookie($cookie);
116			}
117
118			return $response;
119			}
120
121			/**
122			* @return array
123			*/
124			private function successAccessToken() {
125			return array(
126			'success_code' => 'access_token_ok',
127			'success_message' => \Lang::get('api-proxy-laravel::messages.access_token_ok')
128			);
129			}
130
131			}

Cellcote / laravel-proxify

Proxy::getRequestMode() B last analyzed 2016-05-24 09:25 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Proxy::getRequestMode() B
last analyzed 2016-05-24 09:25 UTC