StructuredParser::parseUnquotedString() - Code Metrics - Inspection of "Rename composite type to structured type" - yiisoft/db-pgsql - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#338)

by Sergei

created 2024-02-08 06:36 UTC

StructuredParser::parseUnquotedString() A

↳ Parent: StructuredParser

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Pgsql;

use function in_array;

/**
 * Structured type representation to PHP array parser for PostgreSQL Server.
 */
final class StructuredParser
{
    /**
     * Converts structured (composite) type value from PostgreSQL to PHP array
     *
     * @param string $value String to convert.
     */
    public function parse(string $value): array|null
    {
        if ($value[0] !== '(') {
            return null;
        }

        return $this->parseComposite($value);
    }

    /**
     * Parses PostgreSQL composite type value encoded in string.
     *
     * @param string $value String to parse.
     */
    private function parseComposite(string $value): array
    {
        for ($result = [], $i = 1;; ++$i) {
            $result[] = match ($value[$i]) {
                ',', ')' => null,
                '"' => $this->parseQuotedString($value, $i),
                default => $this->parseUnquotedString($value, $i),
            };

            if ($value[$i] === ')') {
                return $result;
            }
        }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    /**
     * Parses quoted string.
     */
    private function parseQuotedString(string $value, int &$i): string
    {
        for ($result = '', ++$i;; ++$i) {
            if ($value[$i] === '\\') {
                ++$i;
            } elseif ($value[$i] === '"') {
                ++$i;
                return $result;
            }

            $result .= $value[$i];
        }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    /**
     * Parses unquoted string.
     */
    private function parseUnquotedString(string $value, int &$i): string
    {
        for ($result = '';; ++$i) {
            if (in_array($value[$i], [',', ')'], true)) {
                return $result;
            }

            $result .= $value[$i];
        }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Db\Pgsql;
6
7		use function in_array;
8
9		/**
10		* Structured type representation to PHP array parser for PostgreSQL Server.
11		*/
12		final class StructuredParser
13		{
14		/**
15		* Converts structured (composite) type value from PostgreSQL to PHP array
16		*
17		* @param string $value String to convert.
18		*/
19	6	public function parse(string $value): array\|null
20		{
21	6	if ($value[0] !== '(') {
22	1	return null;
23		}
24
25	6	return $this->parseComposite($value);
26		}
27
28		/**
29		* Parses PostgreSQL composite type value encoded in string.
30		*
31		* @param string $value String to parse.
32		*/
33	6	private function parseComposite(string $value): array
34		{
35	6	for ($result = [], $i = 1;; ++$i) {
36	6	$result[] = match ($value[$i]) {
37	6	',', ')' => null,
38	6	'"' => $this->parseQuotedString($value, $i),
39	6	default => $this->parseUnquotedString($value, $i),
40	6	};
41
42	6	if ($value[$i] === ')') {
43	6	return $result;
44		}
45		}
		0 ignored issues – show Bug Best Practice introduced 2023-07-26 06:10 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `array`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
46		}
47
48		/**
49		* Parses quoted string.
50		*/
51	6	private function parseQuotedString(string $value, int &$i): string
52		{
53	6	for ($result = '', ++$i;; ++$i) {
54	6	if ($value[$i] === '\\') {
55	1	++$i;
56	6	} elseif ($value[$i] === '"') {
57	6	++$i;
58	6	return $result;
59		}
60
61	6	$result .= $value[$i];
62		}
		0 ignored issues – show Bug Best Practice introduced 2023-07-26 06:10 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `string`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
63		}
64
65		/**
66		* Parses unquoted string.
67		*/
68	6	private function parseUnquotedString(string $value, int &$i): string
69		{
70	6	for ($result = '';; ++$i) {
71	6	if (in_array($value[$i], [',', ')'], true)) {
72	6	return $result;
73		}
74
75	6	$result .= $value[$i];
76		}
		0 ignored issues – show Bug Best Practice introduced 2023-07-26 06:10 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `string`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
77		}
78		}
79

yiisoft / db-pgsql

Pull Request — master (#338)

StructuredParser::parseUnquotedString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like