Parser::parseArray() - Code Metrics - Inspection of "Remove accidentally-committed comment" - ptlis/php-serialized-data-editor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5875b6...d65a71 )

by brian

created 2019-02-10 15:45 UTC

Parser::parseArray() B

↳ Parent: Parser

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	40
ccs	20
cts	20
cp	1
rs	8.6577
c	0
b	0
f	0
cc	6
nc	6
nop	2
crap	6

<?php declare(strict_types=1);

/**
 * @copyright   (c) 2019-present brian ridley
 * @author      brian ridley <[email protected]>
 * @license     http://opensource.org/licenses/MIT MIT
 */

namespace ptlis\SerializedDataEditor\Parser;

use ptlis\SerializedDataEditor\Type\ArrayType;
use ptlis\SerializedDataEditor\Type\BoolType;
use ptlis\SerializedDataEditor\Type\FloatType;
use ptlis\SerializedDataEditor\Type\IntegerType;
use ptlis\SerializedDataEditor\Type\NullType;
use ptlis\SerializedDataEditor\Type\ObjectCustomSerializedType;
use ptlis\SerializedDataEditor\Type\ObjectDefaultSerializedType;
use ptlis\SerializedDataEditor\Type\ReferenceType;
use ptlis\SerializedDataEditor\Type\StringType;
use ptlis\SerializedDataEditor\Type\Type;
use ptlis\SerializedDataEditor\TypeFragment\ArrayElementIntegerIndex;
use ptlis\SerializedDataEditor\TypeFragment\ArrayElementStringIndex;
use ptlis\SerializedDataEditor\TypeFragment\ObjectProperty;

final class Parser
{
    /**
     * @param Token[] $tokenList
     * @return Type
     */
    public function parse(array $tokenList): Type
    {
        return $this->internalParse($tokenList);
    }

    /**
     * @param Token[] $tokenList
     * @param int $tokenOffset Tracks offset when iterating through token list.
     * @return Type
     */
    private function internalParse(array $tokenList, int &$tokenOffset = 0): Type
    {
        // Handle simple types
        if ($this->isSimpleType($tokenList[$tokenOffset])) {
            $type = $this->parseSimple($tokenList[$tokenOffset], $tokenOffset);

        // Handle complex types (arrays, objects)
        } else {
            $type = $this->parseComplex($tokenList, $tokenOffset);
        }

        return $type;
    }

    private function isSimpleType(Token $token): bool
    {
        return in_array(
            $token->getType(),
            [
                Token::NULL,
                Token::BOOL,
                Token::INTEGER,
                Token::FLOAT,
                Token::STRING,
                Token::REFERENCE
            ]
        );
    }

    /**
     * Parse a simple (single token) type.
     *
     * @param Token $tokenList
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param int $tokenOffset Tracks offset when iterating through token list.
     * @return Type
     */
    public function parseSimple(Token $token, int &$tokenOffset): Type
    {
        switch ($token->getType()) {
            case Token::NULL:
                $type = new NullType();
                break;

            case Token::BOOL:
                $type = new BoolType('1' === $token->getValue() ? true : false);
                break;

            case Token::INTEGER:
                $type = new IntegerType(intval($token->getValue()));
                break;

            case Token::FLOAT:
                $type = new FloatType(floatval($token->getValue()));
                break;

            case Token::STRING:
                $type = new StringType($token->getValue());
                break;

            case Token::REFERENCE:
                $type = new ReferenceType(intval($token->getValue()));
                break;

            default:
                throw new \RuntimeException('Could not parse simple type "' . $token->getType() . '"');
        }

        $tokenOffset++;

        return $type;
    }

    /**
     * Parse a complex (multi token) type.
     *
     * @param Token[] $tokenList
     * @param int $tokenOffset Tracks offset when iterating through token list.
     * @return Type
     */
    private function parseComplex(array $tokenList, int &$tokenOffset): Type
    {
        switch ($tokenList[$tokenOffset]->getType()) {
            case Token::ARRAY_START:
                $type = $this->parseArray($tokenList, $tokenOffset);
                break;

            case Token::OBJECT_DEFAULT_NAME:
                $type = $this->parseObjectDefaultSerialization($tokenList, $tokenOffset);
                break;

            case Token::OBJECT_CUSTOM_NAME:
                $type = $this->parseObjectCustomSerialization($tokenList, $tokenOffset);
                break;

            default:
                throw new \RuntimeException('Could not parse complex type "' . $tokenList[$tokenOffset]->getType() . '"');
        }

        return $type;
    }

    /**
     * Parse an array type.
     *
     * @param Token[] $tokenList
     * @param int $tokenOffset Tracks offset when iterating through token list.
     * @return Type
     */
    private function parseArray(array $tokenList, int &$tokenOffset): Type
    {
        // Skip array open
        $tokenOffset++;

        /** @var Token $indexToken */
        $indexToken = null;

        // Iterate through tokens array elements
        $arrayElementList = [];
        while ($tokenOffset < count($tokenList)) {
            switch (true) {
                // Do nothing, we're done here
                case Token::COMPOUND_END === $tokenList[$tokenOffset]->getType():
                    $tokenOffset++;
                    break;

                // Array index
                case is_null($indexToken):
                    $indexToken = $tokenList[$tokenOffset];
                    $tokenOffset++;
                    break;

                // Element value
                case !is_null($indexToken):
                    $type = $this->internalParse($tokenList, $tokenOffset);

                    if (Token::INTEGER === $indexToken->getType()) {
                        $arrayElementList[] = new ArrayElementIntegerIndex(intval($indexToken->getValue()), $type);
                    } else {
                        $arrayElementList[] = new ArrayElementStringIndex($indexToken->getValue(), $type);
                    }

                    $indexToken = null;
                    break;
            }
        }

        return new ArrayType($arrayElementList);
    }

    /**
     * Parse a PHP-serialized object.
     *
     * @param Token[] $tokenList
     * @param int $tokenOffset Tracks offset when iterating through token list.
     * @return Type
     */
    public function parseObjectDefaultSerialization(array $tokenList, int &$tokenOffset): Type
    {
        $className = $tokenList[$tokenOffset]->getValue();

        // Skip object open and property count
        $tokenOffset += 2;

        /** @var Token $propertyNameToken */
        $propertyNameToken = null;

        // Iterate through tokens building object properties
        $propertyList = [];
        while ($tokenOffset < count($tokenList)) {
            switch (true) {
                // Do nothing, we're done here
                case Token::COMPOUND_END === $tokenList[$tokenOffset]->getType():
                    $tokenOffset++;
                    break;

                // Property name
                case is_null($propertyNameToken):
                    $propertyNameToken = $tokenList[$tokenOffset];
                    $tokenOffset++;
                    break;

                // Property Value
                case !is_null($propertyNameToken):
                    $propertyList[] = $this->parseProperty(
                        $className,
                        $propertyNameToken,
                        $this->internalParse($tokenList, $tokenOffset)
                    );

                    $propertyNameToken = null;
                    break;
            }
        }

        return new ObjectDefaultSerializedType(
            $className,
            $propertyList
        );
    }

    /**
     * Parse a property of a PHP-serialized object.
     *
     * @param Token[] $tokenList
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param int $tokenOffset Tracks offset when iterating through token list.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return Type

     */
    private function parseProperty(
        string $className,
        Token $propertyNameToken,
        Type $type
    ): ObjectProperty {

        // Default to public property
        $visibility = ObjectProperty::PUBLIC;
        $propertyName = $propertyNameToken->getValue();

        // Split property name on NUL character
        $parts = array_values(array_filter(explode("\0", $propertyNameToken->getValue())));

        // Protected or private property
        if (count($parts) > 1) {
            $propertyName = $parts[1];
            $visibility = ObjectProperty::PROTECTED;

            // Private property
            if ($className === $parts[0]) {
                $visibility = ObjectProperty::PRIVATE;
            }
        }

        return new ObjectProperty(
            $visibility,
            $className,
            $propertyName,
            $type
        );
    }

    /**
     * Parse a custom serialized object.
     *
     * @param Token[] $tokenList
     * @param int $tokenOffset Tracks offset when iterating through token list.
     * @return Type
     */
    public function parseObjectCustomSerialization(array $tokenList, int &$tokenOffset): Type
    {
        $className = $tokenList[$tokenOffset]->getValue();
        $tokenOffset++;

        $customSerializedData = $tokenList[$tokenOffset]->getValue();
        $tokenOffset++;

        // Skip end
        $tokenOffset++;

        return new ObjectCustomSerializedType($className, $customSerializedData);
    }
}

1		<?php declare(strict_types=1);
2
3		/**
4		* @copyright (c) 2019-present brian ridley
5		* @author brian ridley <[email protected]>
6		* @license http://opensource.org/licenses/MIT MIT
7		*/
8
9		namespace ptlis\SerializedDataEditor\Parser;
10
11		use ptlis\SerializedDataEditor\Type\ArrayType;
12		use ptlis\SerializedDataEditor\Type\BoolType;
13		use ptlis\SerializedDataEditor\Type\FloatType;
14		use ptlis\SerializedDataEditor\Type\IntegerType;
15		use ptlis\SerializedDataEditor\Type\NullType;
16		use ptlis\SerializedDataEditor\Type\ObjectCustomSerializedType;
17		use ptlis\SerializedDataEditor\Type\ObjectDefaultSerializedType;
18		use ptlis\SerializedDataEditor\Type\ReferenceType;
19		use ptlis\SerializedDataEditor\Type\StringType;
20		use ptlis\SerializedDataEditor\Type\Type;
21		use ptlis\SerializedDataEditor\TypeFragment\ArrayElementIntegerIndex;
22		use ptlis\SerializedDataEditor\TypeFragment\ArrayElementStringIndex;
23		use ptlis\SerializedDataEditor\TypeFragment\ObjectProperty;
24
25		final class Parser
26		{
27		/**
28		* @param Token[] $tokenList
29		* @return Type
30		*/
31	15	public function parse(array $tokenList): Type
32		{
33	15	return $this->internalParse($tokenList);
34		}
35
36		/**
37		* @param Token[] $tokenList
38		* @param int $tokenOffset Tracks offset when iterating through token list.
39		* @return Type
40		*/
41	15	private function internalParse(array $tokenList, int &$tokenOffset = 0): Type
42		{
43		// Handle simple types
44	15	if ($this->isSimpleType($tokenList[$tokenOffset])) {
45	14	$type = $this->parseSimple($tokenList[$tokenOffset], $tokenOffset);
46
47		// Handle complex types (arrays, objects)
48		} else {
49	9	$type = $this->parseComplex($tokenList, $tokenOffset);
50		}
51
52	15	return $type;
53		}
54
55	15	private function isSimpleType(Token $token): bool
56		{
57	15	return in_array(
58	15	$token->getType(),
59		[
60	15	Token::NULL,
61		Token::BOOL,
62		Token::INTEGER,
63		Token::FLOAT,
64		Token::STRING,
65		Token::REFERENCE
66		]
67		);
68		}
69
70		/**
71		* Parse a simple (single token) type.
72		*
73		* @param Token $tokenList
		0 ignored issues – show Bug introduced 2019-02-10 15:46 UTC by Report Bug Copy Issue Report There is no parameter named `$tokenList`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
74		* @param int $tokenOffset Tracks offset when iterating through token list.
75		* @return Type
76		*/
77	14	public function parseSimple(Token $token, int &$tokenOffset): Type
78		{
79	14	switch ($token->getType()) {
80	14	case Token::NULL:
81	1	$type = new NullType();
82	1	break;
83
84	13	case Token::BOOL:
85	1	$type = new BoolType('1' === $token->getValue() ? true : false);
86	1	break;
87
88	12	case Token::INTEGER:
89	1	$type = new IntegerType(intval($token->getValue()));
90	1	break;
91
92	11	case Token::FLOAT:
93	1	$type = new FloatType(floatval($token->getValue()));
94	1	break;
95
96	10	case Token::STRING:
97	9	$type = new StringType($token->getValue());
98	9	break;
99
100	1	case Token::REFERENCE:
101	1	$type = new ReferenceType(intval($token->getValue()));
102	1	break;
103
104		default:
105		throw new \RuntimeException('Could not parse simple type "' . $token->getType() . '"');
106		}
107
108	14	$tokenOffset++;
109
110	14	return $type;
111		}
112
113		/**
114		* Parse a complex (multi token) type.
115		*
116		* @param Token[] $tokenList
117		* @param int $tokenOffset Tracks offset when iterating through token list.
118		* @return Type
119		*/
120	9	private function parseComplex(array $tokenList, int &$tokenOffset): Type
121		{
122	9	switch ($tokenList[$tokenOffset]->getType()) {
123	9	case Token::ARRAY_START:
124	6	$type = $this->parseArray($tokenList, $tokenOffset);
125	6	break;
126
127	6	case Token::OBJECT_DEFAULT_NAME:
128	4	$type = $this->parseObjectDefaultSerialization($tokenList, $tokenOffset);
129	4	break;
130
131	2	case Token::OBJECT_CUSTOM_NAME:
132	2	$type = $this->parseObjectCustomSerialization($tokenList, $tokenOffset);
133	2	break;
134
135		default:
136		throw new \RuntimeException('Could not parse complex type "' . $tokenList[$tokenOffset]->getType() . '"');
137		}
138
139	9	return $type;
140		}
141
142		/**
143		* Parse an array type.
144		*
145		* @param Token[] $tokenList
146		* @param int $tokenOffset Tracks offset when iterating through token list.
147		* @return Type
148		*/
149	6	private function parseArray(array $tokenList, int &$tokenOffset): Type
150		{
151		// Skip array open
152	6	$tokenOffset++;
153
154		/** @var Token $indexToken */
155	6	$indexToken = null;
156
157		// Iterate through tokens array elements
158	6	$arrayElementList = [];
159	6	while ($tokenOffset < count($tokenList)) {
160		switch (true) {
161		// Do nothing, we're done here
162	6	case Token::COMPOUND_END === $tokenList[$tokenOffset]->getType():
163	5	$tokenOffset++;
164	5	break;
165
166		// Array index
167	6	case is_null($indexToken):
168	6	$indexToken = $tokenList[$tokenOffset];
169	6	$tokenOffset++;
170	6	break;
171
172		// Element value
173	6	case !is_null($indexToken):
174	6	$type = $this->internalParse($tokenList, $tokenOffset);
175
176	6	if (Token::INTEGER === $indexToken->getType()) {
177	5	$arrayElementList[] = new ArrayElementIntegerIndex(intval($indexToken->getValue()), $type);
178		} else {
179	2	$arrayElementList[] = new ArrayElementStringIndex($indexToken->getValue(), $type);
180		}
181
182	6	$indexToken = null;
183	6	break;
184		}
185		}
186
187	6	return new ArrayType($arrayElementList);
188		}
189
190		/**
191		* Parse a PHP-serialized object.
192		*
193		* @param Token[] $tokenList
194		* @param int $tokenOffset Tracks offset when iterating through token list.
195		* @return Type
196		*/
197	4	public function parseObjectDefaultSerialization(array $tokenList, int &$tokenOffset): Type
198		{
199	4	$className = $tokenList[$tokenOffset]->getValue();
200
201		// Skip object open and property count
202	4	$tokenOffset += 2;
203
204		/** @var Token $propertyNameToken */
205	4	$propertyNameToken = null;
206
207		// Iterate through tokens building object properties
208	4	$propertyList = [];
209	4	while ($tokenOffset < count($tokenList)) {
210		switch (true) {
211		// Do nothing, we're done here
212	4	case Token::COMPOUND_END === $tokenList[$tokenOffset]->getType():
213	3	$tokenOffset++;
214	3	break;
215
216		// Property name
217	4	case is_null($propertyNameToken):
218	4	$propertyNameToken = $tokenList[$tokenOffset];
219	4	$tokenOffset++;
220	4	break;
221
222		// Property Value
223	4	case !is_null($propertyNameToken):
224	4	$propertyList[] = $this->parseProperty(
225	4	$className,
226	4	$propertyNameToken,
227	4	$this->internalParse($tokenList, $tokenOffset)
228		);
229
230	4	$propertyNameToken = null;
231	4	break;
232		}
233		}
234
235	4	return new ObjectDefaultSerializedType(
236	4	$className,
237	4	$propertyList
238		);
239		}
240
241		/**
242		* Parse a property of a PHP-serialized object.
243		*
244		* @param Token[] $tokenList
		0 ignored issues – show Bug introduced 2019-02-10 15:46 UTC by Report Bug Copy Issue Report There is no parameter named `$tokenList`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
245		* @param int $tokenOffset Tracks offset when iterating through token list.
		0 ignored issues – show Bug introduced 2019-02-10 15:46 UTC by Report Bug Copy Issue Report There is no parameter named `$tokenOffset`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
246		* @return Type
		0 ignored issues – show Documentation introduced 2019-02-10 15:46 UTC by Report Bug Copy Issue Report Should the return type not be `ObjectProperty`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
247		*/
248	4	private function parseProperty(
249		string $className,
250		Token $propertyNameToken,
251		Type $type
252		): ObjectProperty {
253
254		// Default to public property
255	4	$visibility = ObjectProperty::PUBLIC;
256	4	$propertyName = $propertyNameToken->getValue();
257
258		// Split property name on NUL character
259	4	$parts = array_values(array_filter(explode("\0", $propertyNameToken->getValue())));
260
261		// Protected or private property
262	4	if (count($parts) > 1) {
263	2	$propertyName = $parts[1];
264	2	$visibility = ObjectProperty::PROTECTED;
265
266		// Private property
267	2	if ($className === $parts[0]) {
268	2	$visibility = ObjectProperty::PRIVATE;
269		}
270		}
271
272	4	return new ObjectProperty(
273	4	$visibility,
274	4	$className,
275	4	$propertyName,
276	4	$type
277		);
278		}
279
280		/**
281		* Parse a custom serialized object.
282		*
283		* @param Token[] $tokenList
284		* @param int $tokenOffset Tracks offset when iterating through token list.
285		* @return Type
286		*/
287	2	public function parseObjectCustomSerialization(array $tokenList, int &$tokenOffset): Type
288		{
289	2	$className = $tokenList[$tokenOffset]->getValue();
290	2	$tokenOffset++;
291
292	2	$customSerializedData = $tokenList[$tokenOffset]->getValue();
293	2	$tokenOffset++;
294
295		// Skip end
296	2	$tokenOffset++;
297
298	2	return new ObjectCustomSerializedType($className, $customSerializedData);
299		}
300		}

ptlis / php-serialized-data-editor

Push — master ( 5875b6...d65a71 )

Parser::parseArray() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like