FunctionCall::build() - Code Metrics - Inspection of "Do not submit coverage from Travis to Scrutinizer" - phpmyadmin/sql-parser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 20e749...a87ad6 )

by Michal

created 2017-02-07 10:56 UTC

FunctionCall::build() A

↳ Parent: FunctionCall

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * Parses a function call.
 */

namespace PhpMyAdmin\SqlParser\Components;

use PhpMyAdmin\SqlParser\Component;
use PhpMyAdmin\SqlParser\Parser;
use PhpMyAdmin\SqlParser\Token;
use PhpMyAdmin\SqlParser\TokensList;

/**
 * Parses a function call.
 *
 * @category   Keywords
 *
 * @license    https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
 */
class FunctionCall extends Component
{
    /**
     * The name of this function.
     *
     * @var string
     */
    public $name;

    /**
     * The list of parameters.
     *
     * @var ArrayObj
     */
    public $parameters;

    /**
     * Constructor.
     *
     * @param string         $name       the name of the function to be called

     * @param array|ArrayObj $parameters the parameters of this function

     */
    public function __construct($name = null, $parameters = null)
    {
        $this->name = $name;
        if (is_array($parameters)) {
            $this->parameters = new ArrayObj($parameters);
        } elseif ($parameters instanceof ArrayObj) {
            $this->parameters = $parameters;
        }
    }

    /**
     * @param Parser     $parser  the parser that serves as context
     * @param TokensList $list    the list of tokens that are being parsed
     * @param array      $options parameters for parsing
     *
     * @return FunctionCall
     */
    public static function parse(Parser $parser, TokensList $list, array $options = array())
    {
        $ret = new self();

        /**
         * The state of the parser.
         *
         * Below are the states of the parser.
         *
         *      0 ----------------------[ name ]-----------------------> 1
         *
         *      1 --------------------[ parameters ]-------------------> (END)
         *
         * @var int
         */
        $state = 0;

        for (; $list->idx < $list->count; ++$list->idx) {
            /**
             * Token parsed at this moment.
             *
             * @var Token
             */
            $token = $list->tokens[$list->idx];

            // End of statement.
            if ($token->type === Token::TYPE_DELIMITER) {
                break;
            }

            // Skipping whitespaces and comments.
            if (($token->type === Token::TYPE_WHITESPACE) || ($token->type === Token::TYPE_COMMENT)) {
                continue;
            }

            if ($state === 0) {
                $ret->name = $token->value;
                $state = 1;
            } elseif ($state === 1) {
                if (($token->type === Token::TYPE_OPERATOR) && ($token->value === '(')) {
                    $ret->parameters = ArrayObj::parse($parser, $list);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
                }
                break;
            }
        }

        return $ret;
    }

    /**
     * @param FunctionCall $component the component to be built
     * @param array        $options   parameters for building
     *
     * @return string
     */
    public static function build($component, array $options = array())
    {
        return $component->name . $component->parameters;
    }
}


1		<?php
2
3		/**
4		* Parses a function call.
5		*/
6
7		namespace PhpMyAdmin\SqlParser\Components;
8
9		use PhpMyAdmin\SqlParser\Component;
10		use PhpMyAdmin\SqlParser\Parser;
11		use PhpMyAdmin\SqlParser\Token;
12		use PhpMyAdmin\SqlParser\TokensList;
13
14		/**
15		* Parses a function call.
16		*
17		* @category Keywords
18		*
19		* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
20		*/
21		class FunctionCall extends Component
22		{
23		/**
24		* The name of this function.
25		*
26		* @var string
27		*/
28		public $name;
29
30		/**
31		* The list of parameters.
32		*
33		* @var ArrayObj
34		*/
35		public $parameters;
36
37		/**
38		* Constructor.
39		*
40		* @param string $name the name of the function to be called
		0 ignored issues – show Documentation introduced 2016-02-12 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$name` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
41		* @param array\|ArrayObj $parameters the parameters of this function
		0 ignored issues – show Documentation introduced 2016-02-12 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$parameters` not be `array\|ArrayObj\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
42		*/
43	7	public function __construct($name = null, $parameters = null)
44		{
45	7	$this->name = $name;
46	7	if (is_array($parameters)) {
47	1	$this->parameters = new ArrayObj($parameters);
48		} elseif ($parameters instanceof ArrayObj) {
49	1	$this->parameters = $parameters;
50		}
51	7	}
52
53		/**
54		* @param Parser $parser the parser that serves as context
55		* @param TokensList $list the list of tokens that are being parsed
56		* @param array $options parameters for parsing
57		*
58		* @return FunctionCall
59		*/
60	5	public static function parse(Parser $parser, TokensList $list, array $options = array())
61		{
62	5	$ret = new self();
63
64		/**
65		* The state of the parser.
66		*
67		* Below are the states of the parser.
68		*
69		* 0 ----------------------[ name ]-----------------------> 1
70		*
71		* 1 --------------------[ parameters ]-------------------> (END)
72		*
73		* @var int
74		*/
75	5	$state = 0;
76
77	5	for (; $list->idx < $list->count; ++$list->idx) {
78		/**
79		* Token parsed at this moment.
80		*
81		* @var Token
82		*/
83	5	$token = $list->tokens[$list->idx];
84
85		// End of statement.
86	5	if ($token->type === Token::TYPE_DELIMITER) {
87	1	break;
88		}
89
90		// Skipping whitespaces and comments.
91	5	if (($token->type === Token::TYPE_WHITESPACE) \|\| ($token->type === Token::TYPE_COMMENT)) {
92	5	continue;
93		}
94
95	5	if ($state === 0) {
96	5	$ret->name = $token->value;
97	5	$state = 1;
98	4	} elseif ($state === 1) {
99	4	if (($token->type === Token::TYPE_OPERATOR) && ($token->value === '(')) {
100	4	$ret->parameters = ArrayObj::parse($parser, $list);
		0 ignored issues – show Documentation Bug introduced 2017-01-23 12:14 UTC by Report Bug Copy Issue Report It seems like `\PhpMyAdmin\SqlParser\Co...::parse($parser, $list)` can also be of type `array`. However, the property `$parameters` is declared as type `object<PhpMyAdmin\SqlParser\Components\ArrayObj>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
101		}
102	4	break;
103		}
104		}
105
106	5	return $ret;
107		}
108
109		/**
110		* @param FunctionCall $component the component to be built
111		* @param array $options parameters for building
112		*
113		* @return string
114		*/
115	2	public static function build($component, array $options = array())
116		{
117	2	return $component->name . $component->parameters;
118		}
119		}
120

phpmyadmin / sql-parser

Push — master ( 20e749...a87ad6 )

FunctionCall::build() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like