QueryBuilder::buildMethod() - Code Metrics - Inspection of "added auth headers NOT TESTED" - hiqdev/yii2-hiart - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 938ad9...a54f1f )

by Andrii

created 2017-01-25 16:22 UTC

QueryBuilder::buildMethod() A

↳ Parent: QueryBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
ccs	3
cts	3
cp	1
rs	9.4285
cc	2
eloc	11
nc	2
nop	1
crap	2

<?php
/**
 * Tools to use API as ActiveRecord for Yii2
 *
 * @link      https://github.com/hiqdev/yii2-hiart
 * @package   yii2-hiart
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\hiart\rest;

use hiqdev\hiart\Query;

class QueryBuilder extends \hiqdev\hiart\AbstractQueryBuilder
{
    protected $authHeaders = [];

    /**
     * This function is for you to provide your authentication.
     * @param Query $query
     */
    public function buildAuth(Query $query)
    {
        $auth = $this->db->getAuth();
        if (isset($auth['headerToken'])) {
            $authHeaders['Authorization'] = 'token ' . $auth['headerToken'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }
        if (isset($auth['headerBearer'])) {
            $authHeaders['Authorization'] = 'Bearer ' . $auth['headerBearer'];
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }
    }

    public function buildMethod(Query $query)
    {
        static $defaultMethods = [
            'get'       => 'GET',
            'put'       => 'PUT',
            'head'      => 'HEAD',
            'post'      => 'GET',
            'search'    => 'GET',
            'insert'    => 'POST',
            'update'    => 'PUT',
            'delete'    => 'DELETE',
        ];

        return isset($defaultMethods[$query->action]) ? $defaultMethods[$query->action] : 'POST';
    }

    public function buildUri(Query $query)
    {
        return $query->from;
    }

    public function buildHeaders(Query $query)
    {
        return $this->authHeaders;
    }

    public function buildProtocolVersion(Query $query)
    {
        return null;
    }

    public function buildQueryParams(Query $query)
    {
        return [];
    }

    public function buildFormParams(Query $query)
    {
        return [];
    }

    public function buildBody(Query $query)
    {
        return null;
    }
}


1		<?php
2		/**
3		* Tools to use API as ActiveRecord for Yii2
4		*
5		* @link https://github.com/hiqdev/yii2-hiart
6		* @package yii2-hiart
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\hiart\rest;
12
13		use hiqdev\hiart\Query;
14
15		class QueryBuilder extends \hiqdev\hiart\AbstractQueryBuilder
16		{
17		protected $authHeaders = [];
18
19		/**
20		* This function is for you to provide your authentication.
21		* @param Query $query
22		*/
23	2	public function buildAuth(Query $query)
24		{
25	2	$auth = $this->db->getAuth();
26	2	if (isset($auth['headerToken'])) {
27		$authHeaders['Authorization'] = 'token ' . $auth['headerToken'];
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-01-25 16:26 UTC by Report Bug Copy Issue Report `$authHeaders` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$authHeaders = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
28		}
29	2	if (isset($auth['headerBearer'])) {
30		$authHeaders['Authorization'] = 'Bearer ' . $auth['headerBearer'];
		0 ignored issues – show Bug introduced 2017-01-25 16:26 UTC by Report Bug Copy Issue Report The variable `$authHeaders` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
31		}
32	2	}
33
34	2	public function buildMethod(Query $query)
35		{
36		static $defaultMethods = [
37		'get' => 'GET',
38		'put' => 'PUT',
39		'head' => 'HEAD',
40		'post' => 'GET',
41		'search' => 'GET',
42		'insert' => 'POST',
43		'update' => 'PUT',
44		'delete' => 'DELETE',
45	2	];
46
47	2	return isset($defaultMethods[$query->action]) ? $defaultMethods[$query->action] : 'POST';
48		}
49
50	2	public function buildUri(Query $query)
51		{
52	2	return $query->from;
53		}
54
55	2	public function buildHeaders(Query $query)
56		{
57	2	return $this->authHeaders;
58		}
59
60	2	public function buildProtocolVersion(Query $query)
61		{
62	2	return null;
63		}
64
65	2	public function buildQueryParams(Query $query)
66		{
67	2	return [];
68		}
69
70	2	public function buildFormParams(Query $query)
71		{
72	2	return [];
73		}
74
75	2	public function buildBody(Query $query)
76		{
77	2	return null;
78		}
79		}
80

hiqdev / yii2-hiart

Push — master ( 938ad9...a54f1f )

QueryBuilder::buildMethod() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like