CompositeExpression::getType() - Code Metrics - Inspection of "Support Composite types" - yiisoft/db-pgsql - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#303)

unknown

created 2023-07-26 06:23 UTC

CompositeExpression::getType() A

↳ Parent: CompositeExpression

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	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
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 ArrayAccess;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\Schema\ColumnSchemaInterface;

use function count;

/**
 * Represents a composite SQL expression.
 *
 * For example:
 *
 * ```php
 * new CompositeExpression(['price' => 10, 'currency_code' => 'USD']);
 * ```
 *
 * Will be encoded to `ROW(10, USD)`
 *
 * @template-implements ArrayAccess<string, mixed>
 * @template-implements IteratorAggregate<string>
 */
class CompositeExpression implements ExpressionInterface, ArrayAccess, Countable, IteratorAggregate
{
    /**
     * @param ColumnSchemaInterface[]|null $columns
     * @psalm-param array<string, ColumnSchemaInterface>|null $columns
     */
    public function __construct(
        private mixed $value = [],
        private string|null $type = null,
        private array|null $columns = null,
    ) {
    }

    /**
     * The composite type name.
     *
     * Defaults to `null` which means the type isn't explicitly specified.
     *
     * Note that in the case where a type isn't specified explicitly and DBMS can't guess it from the context, SQL error
     * will be raised.
     */
    public function getType(): string|null
    {
        return $this->type;
    }

    /**
     * @return ColumnSchemaInterface[]|null
     */
    public function getColumns(): array|null
    {
        return $this->columns;
    }

    /**
     * The composite type's content. It can be represented as an associative array of the composite type's column names
     * and values.
     */
    public function getValue(): mixed
    {
        return $this->value;
    }

    /**
     * Sort values according to `$columns` order and fill skipped items with default values
     */
    public function getNormalizedValue(): mixed
    {
        if ($this->columns === null || !is_array($this->value) || !is_string(array_key_first($this->value))) {
            return $this->value;
        }

        $value = [];

        foreach ($this->columns as $name => $column) {
            if (array_key_exists($name, $this->value)) {
                /** @psalm-suppress MixedAssignment */
                $value[$name] = $this->value[$name];
            } else {
                /** @psalm-suppress MixedAssignment */
                $value[$name] = $column->getDefaultValue();
            }
        }

        return $value;
    }

    /**
     * Whether an offset exists.
     *
     * @link https://php.net/manual/en/arrayaccess.offsetexists.php
     *
     * @param int|string $offset An offset to check for.
     *
     * @throws InvalidConfigException If value is not an array.
     * @return bool Its `true` on success or `false` on failure.
     */
    public function offsetExists(mixed $offset): bool
    {
        $this->value = $this->validateValue($this->value);
        return array_key_exists($offset, $this->value);
    }

    /**
     * Offset to retrieve.
     *
     * @link https://php.net/manual/en/arrayaccess.offsetget.php
     *
     * @param int|string $offset The offset to retrieve.
     *
     * @throws InvalidConfigException If value is not an array.
     * @return mixed Can return all value types.
     */
    public function offsetGet(mixed $offset): mixed
    {
        $this->value = $this->validateValue($this->value);
        return $this->value[$offset];
    }

    /**
     * Offset to set.
     *
     * @link https://php.net/manual/en/arrayaccess.offsetset.php
     *
     * @param int|string $offset The offset to assign the value to.
     * @param mixed $value The value to set.
     *
     * @throws InvalidConfigException If content value is not an array.
     */
    public function offsetSet(mixed $offset, mixed $value): void
    {
        $this->value = $this->validateValue($this->value);
        $this->value[$offset] = $value;
    }

    /**
     * Offset to unset.
     *
     * @param int|string $offset The offset to unset.
     *
     * @throws InvalidConfigException If value is not an array.
     *
     * @link https://php.net/manual/en/arrayaccess.offsetunset.php
     */
    public function offsetUnset(mixed $offset): void
    {
        $this->value = $this->validateValue($this->value);
        unset($this->value[$offset]);
    }

    /**
     * Count elements of the composite type's content.
     *
     * @link https://php.net/manual/en/countable.count.php
     *
     * @return int The custom count as an integer.
     */
    public function count(): int
    {
        return count((array) $this->value);
    }

    /**
     * Retrieve an external iterator.
     *
     * @link https://php.net/manual/en/iteratoraggregate.getiterator.php
     *
     * @throws InvalidConfigException If value is not an array.
     *
     * @return ArrayIterator An instance of an object implementing `Iterator` or `Traversable`.
     */
    public function getIterator(): ArrayIterator
    {
        $this->value = $this->validateValue($this->value);
        return new ArrayIterator($this->value);
    }

    /**
     * Validates the value of the composite expression is an array.
     *
     * @throws InvalidConfigException If value is not an array.
     */
    private function validateValue(mixed $value): array
    {
        if (!is_array($value)) {
            throw new InvalidConfigException('The CompositeExpression value must be an array.');
        }

        return $value;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Db\Pgsql;
6
7		use ArrayAccess;
8		use ArrayIterator;
9		use Countable;
10		use IteratorAggregate;
11		use Yiisoft\Db\Exception\InvalidConfigException;
12		use Yiisoft\Db\Expression\ExpressionInterface;
13		use Yiisoft\Db\Schema\ColumnSchemaInterface;
14
15		use function count;
16
17		/**
18		* Represents a composite SQL expression.
19		*
20		* For example:
21		*
22		* ```php
23		* new CompositeExpression(['price' => 10, 'currency_code' => 'USD']);
24		* ```
25		*
26		* Will be encoded to `ROW(10, USD)`
27		*
28		* @template-implements ArrayAccess<string, mixed>
29		* @template-implements IteratorAggregate<string>
30		*/
31		class CompositeExpression implements ExpressionInterface, ArrayAccess, Countable, IteratorAggregate
32		{
33		/**
34		* @param ColumnSchemaInterface[]\|null $columns
35		* @psalm-param array<string, ColumnSchemaInterface>\|null $columns
36		*/
37	1	public function __construct(
38		private mixed $value = [],
39		private string\|null $type = null,
40		private array\|null $columns = null,
41		) {
42	1	}
43
44		/**
45		* The composite type name.
46		*
47		* Defaults to `null` which means the type isn't explicitly specified.
48		*
49		* Note that in the case where a type isn't specified explicitly and DBMS can't guess it from the context, SQL error
50		* will be raised.
51		*/
52	1	public function getType(): string\|null
53		{
54	1	return $this->type;
55		}
56
57		/**
58		* @return ColumnSchemaInterface[]\|null
59		*/
60	1	public function getColumns(): array\|null
61		{
62	1	return $this->columns;
63		}
64
65		/**
66		* The composite type's content. It can be represented as an associative array of the composite type's column names
67		* and values.
68		*/
69	1	public function getValue(): mixed
70		{
71	1	return $this->value;
72		}
73
74		/**
75		* Sort values according to `$columns` order and fill skipped items with default values
76		*/
77	1	public function getNormalizedValue(): mixed
78		{
79	1	if ($this->columns === null \|\| !is_array($this->value) \|\| !is_string(array_key_first($this->value))) {
80		return $this->value;
81		}
82
83	1	$value = [];
84
85	1	foreach ($this->columns as $name => $column) {
86	1	if (array_key_exists($name, $this->value)) {
87		/** @psalm-suppress MixedAssignment */
88	1	$value[$name] = $this->value[$name];
89		} else {
90		/** @psalm-suppress MixedAssignment */
91		$value[$name] = $column->getDefaultValue();
92		}
93		}
94
95	1	return $value;
96		}
97
98		/**
99		* Whether an offset exists.
100		*
101		* @link https://php.net/manual/en/arrayaccess.offsetexists.php
102		*
103		* @param int\|string $offset An offset to check for.
104		*
105		* @throws InvalidConfigException If value is not an array.
106		* @return bool Its `true` on success or `false` on failure.
107		*/
108		public function offsetExists(mixed $offset): bool
109		{
110		$this->value = $this->validateValue($this->value);
111		return array_key_exists($offset, $this->value);
112		}
113
114		/**
115		* Offset to retrieve.
116		*
117		* @link https://php.net/manual/en/arrayaccess.offsetget.php
118		*
119		* @param int\|string $offset The offset to retrieve.
120		*
121		* @throws InvalidConfigException If value is not an array.
122		* @return mixed Can return all value types.
123		*/
124		public function offsetGet(mixed $offset): mixed
125		{
126		$this->value = $this->validateValue($this->value);
127		return $this->value[$offset];
128		}
129
130		/**
131		* Offset to set.
132		*
133		* @link https://php.net/manual/en/arrayaccess.offsetset.php
134		*
135		* @param int\|string $offset The offset to assign the value to.
136		* @param mixed $value The value to set.
137		*
138		* @throws InvalidConfigException If content value is not an array.
139		*/
140		public function offsetSet(mixed $offset, mixed $value): void
141		{
142		$this->value = $this->validateValue($this->value);
143		$this->value[$offset] = $value;
144		}
145
146		/**
147		* Offset to unset.
148		*
149		* @param int\|string $offset The offset to unset.
150		*
151		* @throws InvalidConfigException If value is not an array.
152		*
153		* @link https://php.net/manual/en/arrayaccess.offsetunset.php
154		*/
155		public function offsetUnset(mixed $offset): void
156		{
157		$this->value = $this->validateValue($this->value);
158		unset($this->value[$offset]);
159		}
160
161		/**
162		* Count elements of the composite type's content.
163		*
164		* @link https://php.net/manual/en/countable.count.php
165		*
166		* @return int The custom count as an integer.
167		*/
168		public function count(): int
169		{
170		return count((array) $this->value);
171		}
172
173		/**
174		* Retrieve an external iterator.
175		*
176		* @link https://php.net/manual/en/iteratoraggregate.getiterator.php
177		*
178		* @throws InvalidConfigException If value is not an array.
179		*
180		* @return ArrayIterator An instance of an object implementing `Iterator` or `Traversable`.
181		*/
182		public function getIterator(): ArrayIterator
183		{
184		$this->value = $this->validateValue($this->value);
185		return new ArrayIterator($this->value);
186		}
187
188		/**
189		* Validates the value of the composite expression is an array.
190		*
191		* @throws InvalidConfigException If value is not an array.
192		*/
193		private function validateValue(mixed $value): array
194		{
195		if (!is_array($value)) {
196		throw new InvalidConfigException('The CompositeExpression value must be an array.');
197		}
198
199		return $value;
200		}
201		}
202

yiisoft / db-pgsql

Pull Request — master (#303)

CompositeExpression::getType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like