ActiveRecord::isTransactional() - Code Metrics - Inspection of "Create `TransactionalTrait` (#320)" - yiisoft/active-record - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 537eca...d2535c )

by Sergei

created 2024-05-20 05:37 UTC

ActiveRecord::isTransactional() A

↳ Parent: ActiveRecord

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
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
ccs	2
cts	2
cp	1
cc	1
nc	1
nop	1
crap	1

<?php

declare(strict_types=1);

namespace Yiisoft\ActiveRecord;

use ArrayAccess;
use IteratorAggregate;
use Throwable;
use Yiisoft\ActiveRecord\Trait\ArrayableTrait;
use Yiisoft\ActiveRecord\Trait\ArrayAccessTrait;
use Yiisoft\ActiveRecord\Trait\ArrayIteratorTrait;
use Yiisoft\ActiveRecord\Trait\MagicPropertiesTrait;
use Yiisoft\ActiveRecord\Trait\MagicRelationsTrait;
use Yiisoft\ActiveRecord\Trait\TransactionalTrait;
use Yiisoft\Arrays\ArrayableInterface;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidArgumentException;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Schema\TableSchemaInterface;

use function array_diff;
use function array_keys;
use function array_map;
use function array_values;
use function in_array;
use function is_array;
use function is_string;
use function key;
use function preg_replace;

/**
 * ActiveRecord is the base class for classes representing relational data in terms of objects.
 *
 * Active Record implements the [Active Record design pattern](https://en.wikipedia.org/wiki/Active_record).
 *
 * The premise behind Active Record is that an individual {@see ActiveRecord} object is associated with a specific row
 * in a database table. The object's attributes are mapped to the columns of the corresponding table.
 *
 * Referencing an Active Record attribute is equivalent to accessing the corresponding table column for that record.
 *
 * As an example, say that the `Customer` ActiveRecord class is associated with the `customer` table.
 *
 * This would mean that the class's `name` attribute is automatically mapped to the `name` column in `customer` table.
 * Thanks to Active Record, assuming the variable `$customer` is an object of type `Customer`, to get the value of the
 * `name` column for the table row, you can use the expression `$customer->name`.
 *
 * In this example, Active Record is providing an object-oriented interface for accessing data stored in the database.
 * But Active Record provides much more functionality than this.
 *
 * To declare an ActiveRecord class you need to extend {@see ActiveRecord} and implement the `getTableName` method:
 *
 * ```php
 * <?php
 *
 * class Customer extends ActiveRecord
 * {
 *     public static function getTableName(): string
 *     {
 *         return 'customer';
 *     }
 * }
 * ```
 *
 * The `getTableName` method only has to return the name of the database table associated with the class.
 *
 * Class instances are obtained in one of two ways:
 *
 * Using the `new` operator to create a new, empty object.
 * Using a method to fetch an existing record (or records) from the database.
 *
 * Below is an example showing some typical usage of ActiveRecord:
 *
 * ```php
 * $user = new User($db);
 * $user->name = 'Qiang';
 * $user->save();  // a new row is inserted into user table
 *
 * // the following will retrieve the user 'CeBe' from the database
 * $userQuery = new ActiveQuery(User::class, $db);
 * $user = $userQuery->where(['name' => 'CeBe'])->one();
 *
 * // this will get related records from orders table when relation is defined
 * $orders = $user->orders;
 * ```
 *
 * For more details and usage information on ActiveRecord,
 * {@see the [guide article on ActiveRecord](guide:db-active-record)}
 *
 * @method ActiveQuery hasMany($class, array $link) {@see BaseActiveRecord::hasMany()} for more info.
 * @method ActiveQuery hasOne($class, array $link) {@see BaseActiveRecord::hasOne()} for more info.
 *
 * @template-implements ArrayAccess<string, mixed>
 * @template-implements IteratorAggregate<string, mixed>
 */
class ActiveRecord extends AbstractActiveRecord implements ArrayableInterface, ArrayAccess, IteratorAggregate, TransactionalInterface
{
    use ArrayableTrait;
    use ArrayAccessTrait;
    use ArrayIteratorTrait;
    use MagicPropertiesTrait;
    use MagicRelationsTrait;
    use TransactionalTrait;

    public function attributes(): array
    {
        return $this->getTableSchema()->getColumnNames();
    }

    public function filterCondition(array $condition, array $aliases = []): array
    {
        $result = [];

        $columnNames = $this->filterValidColumnNames($aliases);

        foreach ($condition as $key => $value) {
            if (is_string($key) && !in_array($this->db->getQuoter()->quoteSql($key), $columnNames, true)) {
                throw new InvalidArgumentException(
                    'Key "' . $key . '" is not a column name and can not be used as a filter'
                );
            }
            $result[$key] = is_array($value) ? array_values($value) : $value;
        }

        return $result;
    }

    public function filterValidAliases(ActiveQuery $query): array
    {
        $tables = $query->getTablesUsedInFrom();

        $aliases = array_diff(array_keys($tables), $tables);

        return array_map(static fn ($alias) => preg_replace('/{{([\w]+)}}/', '$1', $alias), array_values($aliases));
    }

    /**
     * Returns the schema information of the DB table associated with this AR class.
     *
     * @throws Exception
     * @throws InvalidConfigException If the table for the AR class does not exist.
     *
     * @return TableSchemaInterface The schema information of the DB table associated with this AR class.
     */
    public function getTableSchema(): TableSchemaInterface
    {
        $tableSchema = $this->db->getSchema()->getTableSchema($this->getTableName());

        if ($tableSchema === null) {
            throw new InvalidConfigException('The table does not exist: ' . $this->getTableName());
        }

        return $tableSchema;
    }

    /**
     * Loads default values from database table schema.
     *
     * You may call this method to load default values after creating a new instance:
     *
     * ```php
     * // class Customer extends ActiveRecord
     * $customer = new Customer($db);
     * $customer->loadDefaultValues();
     * ```
     *
     * @param bool $skipIfSet Whether existing value should be preserved. This will only set defaults for attributes
     * that are `null`.
     *
     * @throws Exception
     * @throws InvalidConfigException
     *
     * @return self The active record instance itself.
     */
    public function loadDefaultValues(bool $skipIfSet = true): self
    {
        foreach ($this->getTableSchema()->getColumns() as $column) {
            if ($column->getDefaultValue() !== null && (!$skipIfSet || $this->getAttribute($column->getName()) === null)) {
                $this->setAttribute($column->getName(), $column->getDefaultValue());
            }
        }

        return $this;
    }

    public function populateRecord(array|object $row): void
    {
        $columns = $this->getTableSchema()->getColumns();

        /** @psalm-var array[][] $row */
        foreach ($row as $name => $value) {
            if (isset($columns[$name])) {
                $row[$name] = $columns[$name]->phpTypecast($value);
            }
        }

        parent::populateRecord($row);
    }

    public function primaryKey(): array
    {
        return $this->getTableSchema()->getPrimaryKey();
    }

    /**
     * @throws Exception
     * @throws InvalidArgumentException
     * @throws InvalidConfigException
     * @throws Throwable
     */
    public function refresh(): bool
    {
        $query = $this->instantiateQuery(static::class);

        $tableName = key($query->getTablesUsedInFrom());
        $pk = [];

        /** disambiguate column names in case ActiveQuery adds a JOIN */
        foreach ($this->getPrimaryKey(true) as $key => $value) {
            $pk[$tableName . '.' . $key] = $value;
        }

        $query->where($pk);

        return $this->refreshInternal($query->onePopulate());
    }

    /**
     * Valid column names are table column names or column names prefixed with table name or table alias.
     *
     * @throws Exception
     * @throws InvalidConfigException
     */
    protected function filterValidColumnNames(array $aliases): array
    {
        $columnNames = [];
        $tableName = $this->getTableName();
        $quotedTableName = $this->db->getQuoter()->quoteTableName($tableName);

        foreach ($this->getTableSchema()->getColumnNames() as $columnName) {
            $columnNames[] = $columnName;
            $columnNames[] = $this->db->getQuoter()->quoteColumnName($columnName);
            $columnNames[] = "$tableName.$columnName";
            $columnNames[] = $this->db->getQuoter()->quoteSql("$quotedTableName.[[$columnName]]");

            foreach ($aliases as $tableAlias) {
                $columnNames[] = "$tableAlias.$columnName";
                $quotedTableAlias = $this->db->getQuoter()->quoteTableName($tableAlias);
                $columnNames[] = $this->db->getQuoter()->quoteSql("$quotedTableAlias.[[$columnName]]");
            }
        }

        return $columnNames;
    }

    /**
     * Inserts an ActiveRecord into DB without considering transaction.
     *
     * @param array|null $attributes List of attributes that need to be saved. Defaults to `null`, meaning all
     * attributes that are loaded from DB will be saved.
     *
     * @throws Exception
     * @throws InvalidArgumentException
     * @throws InvalidConfigException
     * @throws Throwable
     *
     * @return bool Whether the record is inserted successfully.
     */
    protected function insertInternal(array $attributes = null): bool
    {
        $values = $this->getDirtyAttributes($attributes);

        if (($primaryKeys = $this->db->createCommand()->insertWithReturningPks($this->getTableName(), $values)) === false) {
            return false;
        }

        foreach ($primaryKeys as $name => $value) {
            $id = $this->getTableSchema()->getColumn($name)?->phpTypecast($value);
            $this->setAttribute($name, $id);
            $values[$name] = $id;
        }

        $this->setOldAttributes($values);

        return true;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\ActiveRecord;
6
7		use ArrayAccess;
8		use IteratorAggregate;
9		use Throwable;
10		use Yiisoft\ActiveRecord\Trait\ArrayableTrait;
11		use Yiisoft\ActiveRecord\Trait\ArrayAccessTrait;
12		use Yiisoft\ActiveRecord\Trait\ArrayIteratorTrait;
13		use Yiisoft\ActiveRecord\Trait\MagicPropertiesTrait;
14		use Yiisoft\ActiveRecord\Trait\MagicRelationsTrait;
15		use Yiisoft\ActiveRecord\Trait\TransactionalTrait;
16		use Yiisoft\Arrays\ArrayableInterface;
17		use Yiisoft\Db\Exception\Exception;
18		use Yiisoft\Db\Exception\InvalidArgumentException;
19		use Yiisoft\Db\Exception\InvalidConfigException;
20		use Yiisoft\Db\Schema\TableSchemaInterface;
21
22		use function array_diff;
23		use function array_keys;
24		use function array_map;
25		use function array_values;
26		use function in_array;
27		use function is_array;
28		use function is_string;
29		use function key;
30		use function preg_replace;
31
32		/**
33		* ActiveRecord is the base class for classes representing relational data in terms of objects.
34		*
35		* Active Record implements the [Active Record design pattern](https://en.wikipedia.org/wiki/Active_record).
36		*
37		* The premise behind Active Record is that an individual {@see ActiveRecord} object is associated with a specific row
38		* in a database table. The object's attributes are mapped to the columns of the corresponding table.
39		*
40		* Referencing an Active Record attribute is equivalent to accessing the corresponding table column for that record.
41		*
42		* As an example, say that the `Customer` ActiveRecord class is associated with the `customer` table.
43		*
44		* This would mean that the class's `name` attribute is automatically mapped to the `name` column in `customer` table.
45		* Thanks to Active Record, assuming the variable `$customer` is an object of type `Customer`, to get the value of the
46		* `name` column for the table row, you can use the expression `$customer->name`.
47		*
48		* In this example, Active Record is providing an object-oriented interface for accessing data stored in the database.
49		* But Active Record provides much more functionality than this.
50		*
51		* To declare an ActiveRecord class you need to extend {@see ActiveRecord} and implement the `getTableName` method:
52		*
53		* ```php
54		* <?php
55		*
56		* class Customer extends ActiveRecord
57		* {
58		* public static function getTableName(): string
59		* {
60		* return 'customer';
61		* }
62		* }
63		* ```
64		*
65		* The `getTableName` method only has to return the name of the database table associated with the class.
66		*
67		* Class instances are obtained in one of two ways:
68		*
69		* Using the `new` operator to create a new, empty object.
70		* Using a method to fetch an existing record (or records) from the database.
71		*
72		* Below is an example showing some typical usage of ActiveRecord:
73		*
74		* ```php
75		* $user = new User($db);
76		* $user->name = 'Qiang';
77		* $user->save(); // a new row is inserted into user table
78		*
79		* // the following will retrieve the user 'CeBe' from the database
80		* $userQuery = new ActiveQuery(User::class, $db);
81		* $user = $userQuery->where(['name' => 'CeBe'])->one();
82		*
83		* // this will get related records from orders table when relation is defined
84		* $orders = $user->orders;
85		* ```
86		*
87		* For more details and usage information on ActiveRecord,
88		* {@see the [guide article on ActiveRecord](guide:db-active-record)}
89		*
90		* @method ActiveQuery hasMany($class, array $link) {@see BaseActiveRecord::hasMany()} for more info.
91		* @method ActiveQuery hasOne($class, array $link) {@see BaseActiveRecord::hasOne()} for more info.
92		*
93		* @template-implements ArrayAccess<string, mixed>
94		* @template-implements IteratorAggregate<string, mixed>
95		*/
96		class ActiveRecord extends AbstractActiveRecord implements ArrayableInterface, ArrayAccess, IteratorAggregate, TransactionalInterface
97		{
98		use ArrayableTrait;
99		use ArrayAccessTrait;
100		use ArrayIteratorTrait;
101		use MagicPropertiesTrait;
102		use MagicRelationsTrait;
103		use TransactionalTrait;
104
105		public function attributes(): array
106		{
107		return $this->getTableSchema()->getColumnNames();
108		}
109
110		public function filterCondition(array $condition, array $aliases = []): array
111		{
112		$result = [];
113
114		$columnNames = $this->filterValidColumnNames($aliases);
115
116		foreach ($condition as $key => $value) {
117		if (is_string($key) && !in_array($this->db->getQuoter()->quoteSql($key), $columnNames, true)) {
118		throw new InvalidArgumentException(
119		'Key "' . $key . '" is not a column name and can not be used as a filter'
120		);
121		}
122		$result[$key] = is_array($value) ? array_values($value) : $value;
123		}
124
125		return $result;
126		}
127
128		public function filterValidAliases(ActiveQuery $query): array
129		{
130		$tables = $query->getTablesUsedInFrom();
131
132		$aliases = array_diff(array_keys($tables), $tables);
133
134		return array_map(static fn ($alias) => preg_replace('/{{([\w]+)}}/', '$1', $alias), array_values($aliases));
135	5	}
136
137	5	/**
138	5	* Returns the schema information of the DB table associated with this AR class.
139	5	*
140		* @throws Exception
141		* @throws InvalidConfigException If the table for the AR class does not exist.
142		*
143	5	* @return TableSchemaInterface The schema information of the DB table associated with this AR class.
144		*/
145		public function getTableSchema(): TableSchemaInterface
146		{
147		$tableSchema = $this->db->getSchema()->getTableSchema($this->getTableName());
148
149		if ($tableSchema === null) {
150		throw new InvalidConfigException('The table does not exist: ' . $this->getTableName());
151		}
152
153		return $tableSchema;
154		}
155	132
156		/**
157	132	* Loads default values from database table schema.
158		*
159	132	* You may call this method to load default values after creating a new instance:
160		*
161	132	* ```php
162	20	* // class Customer extends ActiveRecord
163	132	* $customer = new Customer($db);
164		* $customer->loadDefaultValues();
165		* ```
166		*
167		* @param bool $skipIfSet Whether existing value should be preserved. This will only set defaults for attributes
168		* that are `null`.
169		*
170		* @throws Exception
171		* @throws InvalidConfigException
172		*
173		* @return self The active record instance itself.
174		*/
175		public function loadDefaultValues(bool $skipIfSet = true): self
176		{
177		foreach ($this->getTableSchema()->getColumns() as $column) {
178	108	if ($column->getDefaultValue() !== null && (!$skipIfSet \|\| $this->getAttribute($column->getName()) === null)) {
179		$this->setAttribute($column->getName(), $column->getDefaultValue());
180	108	}
181		}
182	108
183		return $this;
184	108	}
185	108
186	32	public function populateRecord(array\|object $row): void
187	32	{
188		$columns = $this->getTableSchema()->getColumns();
189
190	76	/** @psalm-var array[][] $row */
191		foreach ($row as $name => $value) {
192		if (isset($columns[$name])) {
193	76	$row[$name] = $columns[$name]->phpTypecast($value);
194		}
195		}
196
197		parent::populateRecord($row);
198		}
199
200		public function primaryKey(): array
201		{
202		return $this->getTableSchema()->getPrimaryKey();
203		}
204
205	108	/**
206		* @throws Exception
207	108	* @throws InvalidArgumentException
208	108	* @throws InvalidConfigException
209	108	* @throws Throwable
210		*/
211	108	public function refresh(): bool
212	108	{
213	108	$query = $this->instantiateQuery(static::class);
214	108
215	108	$tableName = key($query->getTablesUsedInFrom());
216		$pk = [];
217	108
218	8	/** disambiguate column names in case ActiveQuery adds a JOIN */
219	8	foreach ($this->getPrimaryKey(true) as $key => $value) {
220	8	$pk[$tableName . '.' . $key] = $value;
221		}
222
223		$query->where($pk);
224	108
225		return $this->refreshInternal($query->onePopulate());
226		}
227	28
228		/**
229	28	* Valid column names are table column names or column names prefixed with table name or table alias.
230		*
231	28	* @throws Exception
232	28	* @throws InvalidConfigException
233		*/
234		protected function filterValidColumnNames(array $aliases): array
235	28	{
236	28	$columnNames = [];
237		$tableName = $this->getTableName();
238		$quotedTableName = $this->db->getQuoter()->quoteTableName($tableName);
239	28
240		foreach ($this->getTableSchema()->getColumnNames() as $columnName) {
241		$columnNames[] = $columnName;
242	28	$columnNames[] = $this->db->getQuoter()->quoteColumnName($columnName);
243		$columnNames[] = "$tableName.$columnName";
244	28	$columnNames[] = $this->db->getQuoter()->quoteSql("$quotedTableName.[[$columnName]]");
245
246		foreach ($aliases as $tableAlias) {
247		$columnNames[] = "$tableAlias.$columnName";
248		$quotedTableAlias = $this->db->getQuoter()->quoteTableName($tableAlias);
249		$columnNames[] = $this->db->getQuoter()->quoteSql("$quotedTableAlias.[[$columnName]]");
250		}
251		}
252
253		return $columnNames;
254		}
255
256		/**
257		* Inserts an ActiveRecord into DB without considering transaction.
258		*
259		* @param array\|null $attributes List of attributes that need to be saved. Defaults to `null`, meaning all
260		* attributes that are loaded from DB will be saved.
261		*
262		* @throws Exception
263		* @throws InvalidArgumentException
264		* @throws InvalidConfigException
265		* @throws Throwable
266		*
267		* @return bool Whether the record is inserted successfully.
268		*/
269		protected function insertInternal(array $attributes = null): bool
270		{
271		$values = $this->getDirtyAttributes($attributes);
272
273		if (($primaryKeys = $this->db->createCommand()->insertWithReturningPks($this->getTableName(), $values)) === false) {
274		return false;
275		}
276
277		foreach ($primaryKeys as $name => $value) {
278		$id = $this->getTableSchema()->getColumn($name)?->phpTypecast($value);
279	46	$this->setAttribute($name, $id);
280		$values[$name] = $id;
281	46	}
282
283	46	$this->setOldAttributes($values);
284
285	46	return true;
286		}
287		}
288

yiisoft / active-record

Push — master ( 537eca...d2535c )

ActiveRecord::isTransactional() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like