ColumnSchema::getColumns() - 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

ColumnSchema::getColumns() A

↳ Parent: ColumnSchema

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Pgsql;

use JsonException;
use PDO;
use Yiisoft\Db\Command\Param;
use Yiisoft\Db\Expression\ArrayExpression;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\Expression\JsonExpression;
use Yiisoft\Db\Schema\AbstractColumnSchema;
use Yiisoft\Db\Schema\ColumnSchemaInterface;
use Yiisoft\Db\Schema\SchemaInterface;

use function array_walk_recursive;
use function bindec;
use function decbin;
use function is_array;
use function is_int;
use function is_string;
use function json_decode;
use function str_pad;

/**
 * Represents the metadata of a column in a database table for PostgreSQL Server.
 *
 * It provides information about the column's name, type, size, precision, and other details.
 *
 * It's used to store and retrieve metadata about a column in a database table and is typically used in conjunction with
 * the {@see TableSchema}, which represents the metadata of a database table as a whole.
 *
 * The following code shows how to use:
 *
 * ```php
 * use Yiisoft\Db\Pgsql\ColumnSchema;
 *
 * $column = new ColumnSchema();
 * $column->name('id');
 * $column->allowNull(false);
 * $column->dbType('integer');
 * $column->phpType('integer');
 * $column->type('integer');
 * $column->defaultValue(0);
 * $column->autoIncrement(true);
 * $column->primaryKey(true);
 * ```
 */
final class ColumnSchema extends AbstractColumnSchema
{
    /**
     * @var int The dimension of array. Defaults to 0, means this column isn't an array.
     */
    private int $dimension = 0;

    /**
     * @var string|null Name of an associated sequence if column is auto incremental.
     */
    private string|null $sequenceName = null;

    /**
     * @var ColumnSchemaInterface[] Columns metadata of the structured type.
     * @psalm-var array<string, ColumnSchemaInterface>
     */
    private array $columns = [];

    /**
     * Converts the input value according to {@see type} and {@see dbType} for use in a db query.
     *
     * If the value is null or an {@see Expression}, it won't be converted.
     *
     * @param mixed $value input value
     *
     * @return mixed Converted value.
     */
    public function dbTypecast(mixed $value): mixed
    {
        if ($this->dimension > 0) {
            if ($value === null || $value instanceof ExpressionInterface) {
                return $value;
            }

            if ($this->getType() === Schema::TYPE_STRUCTURED) {
filter:
    dependency_paths: ["lib/*"]
                $value = $this->dbTypecastArray($value, $this->dimension);
            }

            return new ArrayExpression($value, $this->getDbType(), $this->dimension);
        }

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

    /**
     * Recursively converts array values for use in a db query.
     *
     * @param mixed $value The array or iterable object.
     * @param int $dimension The array dimension. Should be more than 0.
     *
     * @return array|null Converted values.
     */
    private function dbTypecastArray(mixed $value, int $dimension): array|null
    {
        if ($value === null) {
            return null;
        }

        if (!is_iterable($value)) {
            return [];
        }

        $items = [];

        if ($dimension > 1) {
            foreach ($value as $val) {
                $items[] = $this->dbTypecastArray($val, $dimension - 1);
            }
        } else {
            foreach ($value as $val) {
                $items[] = $this->dbTypecastValue($val);
            }
        }

        return $items;
    }

    /**
     * Converts the input value for use in a db query.
     */
    private function dbTypecastValue(mixed $value): mixed
    {
        if ($value === null || $value instanceof ExpressionInterface) {
            return $value;
        }

        return match ($this->getType()) {
            SchemaInterface::TYPE_JSON => new JsonExpression($value, $this->getDbType()),

            SchemaInterface::TYPE_BINARY => is_string($value)
                ? new Param($value, PDO::PARAM_LOB) // explicitly setup PDO param type for binary column
                : $this->typecast($value),

            Schema::TYPE_BIT => is_int($value)
                ? str_pad(decbin($value), (int) $this->getSize(), '0', STR_PAD_LEFT)
                : (string) $value,

            Schema::TYPE_STRUCTURED => new StructuredExpression($value, $this->getDbType(), $this->columns),

            default => $this->typecast($value),
        };
    }

    /**
     * Converts the input value according to {@see phpType} after retrieval from the database.
     *
     * If the value is null or an {@see Expression}, it won't be converted.
     *
     * @param mixed $value The input value
     *
     * @throws JsonException
     *
     * @return mixed The converted value
     */
    public function phpTypecast(mixed $value): mixed
    {
        if ($this->dimension > 0) {
            if (is_string($value)) {
                $value = (new ArrayParser())->parse($value);
            }

            if (!is_array($value)) {
                return null;
            }

            array_walk_recursive($value, function (mixed &$val) {
                $val = $this->phpTypecastValue($val);
            });

            return $value;
        }

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

    /**
     * Casts $value after retrieving from the DBMS to PHP representation.
     *
     * @throws JsonException
     */
    private function phpTypecastValue(mixed $value): mixed
    {
        if ($value === null) {
            return null;
        }

        return match ($this->getType()) {
            Schema::TYPE_BIT => is_string($value) ? bindec($value) : $value,

            SchemaInterface::TYPE_BOOLEAN => $value && $value !== 'f',

            SchemaInterface::TYPE_JSON
                => json_decode((string) $value, true, 512, JSON_THROW_ON_ERROR),

            Schema::TYPE_STRUCTURED => $this->phpTypecastStructured($value),

            default => parent::phpTypecast($value),
        };
    }

    /**
     * Converts the input value according to the structured type after retrieval from the database.
     */
    private function phpTypecastStructured(mixed $value): array|null
    {
        if (is_string($value)) {
            $value = (new StructuredParser())->parse($value);
        }

        if (!is_iterable($value)) {
            return null;
        }

        $fields = [];
        $columnNames = array_keys($this->columns);

        /** @psalm-var int|string $columnName */
        foreach ($value as $columnName => $item) {
            $columnName = $columnNames[$columnName] ?? $columnName;

            if (isset($this->columns[$columnName])) {
                $item = $this->columns[$columnName]->phpTypecast($item);
            }

            $fields[$columnName] = $item;
        }

        return $fields;
    }

    /**
     * @return int Get the dimension of the array.
     *
     * Defaults to 0, means this column isn't an array.
     */
    public function getDimension(): int
    {
        return $this->dimension;
    }

    /**
     * @return string|null name of an associated sequence if column is auto incremental.
     */
    public function getSequenceName(): string|null
    {
        return $this->sequenceName;
    }

    /**
     * Set dimension of an array.
     *
     * Defaults to 0, means this column isn't an array.
     */
    public function dimension(int $dimension): void
    {
        $this->dimension = $dimension;
    }

    /**
     * Set the name of an associated sequence if a column is auto incremental.
     */
    public function sequenceName(string|null $sequenceName): void
    {
        $this->sequenceName = $sequenceName;
    }

    /**
     * Set columns of the structured type.
     *
     * @param ColumnSchemaInterface[] $columns The metadata of the structured type columns.
     * @psalm-param array<string, ColumnSchemaInterface> $columns
     */
    public function columns(array $columns): void
    {
        $this->columns = $columns;
    }

    /**
     * Get the metadata of the structured type columns.
     *
     * @return ColumnSchemaInterface[]
     */
    public function getColumns(): array
    {
        return $this->columns;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Db\Pgsql;
6
7		use JsonException;
8		use PDO;
9		use Yiisoft\Db\Command\Param;
10		use Yiisoft\Db\Expression\ArrayExpression;
11		use Yiisoft\Db\Expression\ExpressionInterface;
12		use Yiisoft\Db\Expression\JsonExpression;
13		use Yiisoft\Db\Schema\AbstractColumnSchema;
14		use Yiisoft\Db\Schema\ColumnSchemaInterface;
15		use Yiisoft\Db\Schema\SchemaInterface;
16
17		use function array_walk_recursive;
18		use function bindec;
19		use function decbin;
20		use function is_array;
21		use function is_int;
22		use function is_string;
23		use function json_decode;
24		use function str_pad;
25
26		/**
27		* Represents the metadata of a column in a database table for PostgreSQL Server.
28		*
29		* It provides information about the column's name, type, size, precision, and other details.
30		*
31		* It's used to store and retrieve metadata about a column in a database table and is typically used in conjunction with
32		* the {@see TableSchema}, which represents the metadata of a database table as a whole.
33		*
34		* The following code shows how to use:
35		*
36		* ```php
37		* use Yiisoft\Db\Pgsql\ColumnSchema;
38		*
39		* $column = new ColumnSchema();
40		* $column->name('id');
41		* $column->allowNull(false);
42		* $column->dbType('integer');
43		* $column->phpType('integer');
44		* $column->type('integer');
45		* $column->defaultValue(0);
46		* $column->autoIncrement(true);
47		* $column->primaryKey(true);
48		* ```
49		*/
50		final class ColumnSchema extends AbstractColumnSchema
51		{
52		/**
53		* @var int The dimension of array. Defaults to 0, means this column isn't an array.
54		*/
55		private int $dimension = 0;
56
57		/**
58		* @var string\|null Name of an associated sequence if column is auto incremental.
59		*/
60		private string\|null $sequenceName = null;
61
62		/**
63		* @var ColumnSchemaInterface[] Columns metadata of the structured type.
64		* @psalm-var array<string, ColumnSchemaInterface>
65		*/
66		private array $columns = [];
67
68		/**
69		* Converts the input value according to {@see type} and {@see dbType} for use in a db query.
70		*
71		* If the value is null or an {@see Expression}, it won't be converted.
72		*
73		* @param mixed $value input value
74		*
75		* @return mixed Converted value.
76		*/
77	104	public function dbTypecast(mixed $value): mixed
78		{
79	104	if ($this->dimension > 0) {
80	4	if ($value === null \|\| $value instanceof ExpressionInterface) {
81	2	return $value;
82		}
83
84	3	if ($this->getType() === Schema::TYPE_STRUCTURED) {
		0 ignored issues – show Bug introduced 2024-02-08 04:41 UTC by Report Bug Copy Issue Report The type `Yiisoft\Db\Pgsql\Schema` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
85	1	$value = $this->dbTypecastArray($value, $this->dimension);
86		}
87
88	3	return new ArrayExpression($value, $this->getDbType(), $this->dimension);
89		}
90
91	103	return $this->dbTypecastValue($value);
92		}
93
94		/**
95		* Recursively converts array values for use in a db query.
96		*
97		* @param mixed $value The array or iterable object.
98		* @param int $dimension The array dimension. Should be more than 0.
99		*
100		* @return array\|null Converted values.
101		*/
102	1	private function dbTypecastArray(mixed $value, int $dimension): array\|null
103		{
104	1	if ($value === null) {
105	1	return null;
106		}
107
108	1	if (!is_iterable($value)) {
109	1	return [];
110		}
111
112	1	$items = [];
113
114	1	if ($dimension > 1) {
115	1	foreach ($value as $val) {
116	1	$items[] = $this->dbTypecastArray($val, $dimension - 1);
117		}
118		} else {
119	1	foreach ($value as $val) {
120	1	$items[] = $this->dbTypecastValue($val);
121		}
122		}
123
124	1	return $items;
125		}
126
127		/**
128		* Converts the input value for use in a db query.
129		*/
130	103	private function dbTypecastValue(mixed $value): mixed
131		{
132	103	if ($value === null \|\| $value instanceof ExpressionInterface) {
133	38	return $value;
134		}
135
136	95	return match ($this->getType()) {
137	95	SchemaInterface::TYPE_JSON => new JsonExpression($value, $this->getDbType()),
138
139	95	SchemaInterface::TYPE_BINARY => is_string($value)
140	3	? new Param($value, PDO::PARAM_LOB) // explicitly setup PDO param type for binary column
141	3	: $this->typecast($value),
142
143	95	Schema::TYPE_BIT => is_int($value)
144	1	? str_pad(decbin($value), (int) $this->getSize(), '0', STR_PAD_LEFT)
145	2	: (string) $value,
146
147	95	Schema::TYPE_STRUCTURED => new StructuredExpression($value, $this->getDbType(), $this->columns),
148
149	95	default => $this->typecast($value),
150	95	};
151		}
152
153		/**
154		* Converts the input value according to {@see phpType} after retrieval from the database.
155		*
156		* If the value is null or an {@see Expression}, it won't be converted.
157		*
158		* @param mixed $value The input value
159		*
160		* @throws JsonException
161		*
162		* @return mixed The converted value
163		*/
164	101	public function phpTypecast(mixed $value): mixed
165		{
166	101	if ($this->dimension > 0) {
167	12	if (is_string($value)) {
168	12	$value = (new ArrayParser())->parse($value);
169		}
170
171	12	if (!is_array($value)) {
172	1	return null;
173		}
174
175	12	array_walk_recursive($value, function (mixed &$val) {
176	12	$val = $this->phpTypecastValue($val);
177	12	});
178
179	12	return $value;
180		}
181
182	95	return $this->phpTypecastValue($value);
183		}
184
185		/**
186		* Casts $value after retrieving from the DBMS to PHP representation.
187		*
188		* @throws JsonException
189		*/
190	101	private function phpTypecastValue(mixed $value): mixed
191		{
192	101	if ($value === null) {
193	11	return null;
194		}
195
196	101	return match ($this->getType()) {
197	101	Schema::TYPE_BIT => is_string($value) ? bindec($value) : $value,
198
199	101	SchemaInterface::TYPE_BOOLEAN => $value && $value !== 'f',
200
201	101	SchemaInterface::TYPE_JSON
202	101	=> json_decode((string) $value, true, 512, JSON_THROW_ON_ERROR),
203
204	101	Schema::TYPE_STRUCTURED => $this->phpTypecastStructured($value),
205
206	101	default => parent::phpTypecast($value),
207	101	};
208		}
209
210		/**
211		* Converts the input value according to the structured type after retrieval from the database.
212		*/
213	5	private function phpTypecastStructured(mixed $value): array\|null
214		{
215	5	if (is_string($value)) {
216	5	$value = (new StructuredParser())->parse($value);
217		}
218
219	5	if (!is_iterable($value)) {
220	1	return null;
221		}
222
223	5	$fields = [];
224	5	$columnNames = array_keys($this->columns);
225
226		/** @psalm-var int\|string $columnName */
227	5	foreach ($value as $columnName => $item) {
228	5	$columnName = $columnNames[$columnName] ?? $columnName;
229
230	5	if (isset($this->columns[$columnName])) {
231	5	$item = $this->columns[$columnName]->phpTypecast($item);
232		}
233
234	5	$fields[$columnName] = $item;
235		}
236
237	5	return $fields;
238		}
239
240		/**
241		* @return int Get the dimension of the array.
242		*
243		* Defaults to 0, means this column isn't an array.
244		*/
245	6	public function getDimension(): int
246		{
247	6	return $this->dimension;
248		}
249
250		/**
251		* @return string\|null name of an associated sequence if column is auto incremental.
252		*/
253	102	public function getSequenceName(): string\|null
254		{
255	102	return $this->sequenceName;
256		}
257
258		/**
259		* Set dimension of an array.
260		*
261		* Defaults to 0, means this column isn't an array.
262		*/
263	167	public function dimension(int $dimension): void
264		{
265	167	$this->dimension = $dimension;
266		}
267
268		/**
269		* Set the name of an associated sequence if a column is auto incremental.
270		*/
271	82	public function sequenceName(string\|null $sequenceName): void
272		{
273	82	$this->sequenceName = $sequenceName;
274		}
275
276		/**
277		* Set columns of the structured type.
278		*
279		* @param ColumnSchemaInterface[] $columns The metadata of the structured type columns.
280		* @psalm-param array<string, ColumnSchemaInterface> $columns
281		*/
282	5	public function columns(array $columns): void
283		{
284	5	$this->columns = $columns;
285		}
286
287		/**
288		* Get the metadata of the structured type columns.
289		*
290		* @return ColumnSchemaInterface[]
291		*/
292	5	public function getColumns(): array
293		{
294	5	return $this->columns;
295		}
296		}
297

yiisoft / db-pgsql

Pull Request — master (#338)

ColumnSchema::getColumns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like