ActiveQuery::createQueryHelper() - Code Metrics - Inspection of "Work with QueryHelper" - yiisoft/active-record - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#228)

by Def
created 2023-02-12 19:44 UTC
ActiveQuery::createQueryHelper() A

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	7
ccs	0
cts	0
cp	0
crap	6
rs	10
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace Yiisoft\ActiveRecord;

use ReflectionException;
use Throwable;
use Yiisoft\Db\Command\CommandInterface;
use Yiisoft\Db\Connection\ConnectionInterface;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidArgumentException;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Exception\NotSupportedException;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\Helper\ArrayHelper;
use Yiisoft\Db\Query\Query;
use Yiisoft\Db\Query\QueryInterface;
use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
use Yiisoft\Definitions\Exception\CircularReferenceException;
use Yiisoft\Definitions\Exception\NotInstantiableException;

use function array_merge;
use function array_values;
use function count;
use function implode;
use function in_array;
use function is_array;
use function is_int;
use function is_string;
use function preg_match;
use function reset;
use function serialize;
use function strpos;
use function substr;

/**
 * ActiveQuery represents a DB query associated with an Active Record class.
 *
 * An ActiveQuery can be a normal query or be used in a relational context.
 *
 * ActiveQuery instances are usually created by {@see ActiveQuery::findOne()}, {@see ActiveQuery::findBySql()},
 * {@see ActiveQuery::findAll()}
 *
 * Relational queries are created by {@see ActiveRecord::hasOne()} and {@see ActiveRecord::hasMany()}.
 *
 * Normal Query
 * ------------
 *
 * ActiveQuery mainly provides the following methods to retrieve the query results:
 *
 * - {@see one()}: returns a single record populated with the first row of data.
 * - {@see all()}: returns all records based on the query results.
 * - {@see count()}: returns the number of records.
 * - {@see sum()}: returns the sum over the specified column.
 * - {@see average()}: returns the average over the specified column.
 * - {@see min()}: returns the min over the specified column.
 * - {@see max()}: returns the max over the specified column.
 * - {@see scalar()}: returns the value of the first column in the first row of the query result.
 * - {@see column()}: returns the value of the first column in the query result.
 * - {@see exists()}: returns a value indicating whether the query result has data or not.
 *
 * Because ActiveQuery extends from {@see Query}, one can use query methods, such as {@see where()}, {@see orderBy()} to
 * customize the query options.
 *
 * ActiveQuery also provides the following additional query options:
 *
 * - {@see with()}: list of relations that this query should be performed with.
 * - {@see joinWith()}: reuse a relation query definition to add a join to a query.
 * - {@see indexBy()}: the name of the column by which the query result should be indexed.
 * - {@see asArray()}: whether to return each record as an array.
 *
 * These options can be configured using methods of the same name. For example:
 *
 * ```php
 * $customerQuery = new ActiveQuery(Customer::class, $db);
 * $query = $customerQuery->with('orders')->asArray()->all();
 * ```
 *
 * Relational query
 * ----------------
 *
 * In relational context ActiveQuery represents a relation between two Active Record classes.
 *
 * Relational ActiveQuery instances are usually created by calling {@see ActiveRecord::hasOne()} and
 * {@see ActiveRecord::hasMany()}. An Active Record class declares a relation by defining a getter method which calls
 * one of the above methods and returns the created ActiveQuery object.
 *
 * A relation is specified by {@see link} which represents the association between columns of different tables; and the
 * multiplicity of the relation is indicated by {@see multiple}.
 *
 * If a relation involves a junction table, it may be specified by {@see via()} or {@see viaTable()} method.
 *
 * These methods may only be called in a relational context. Same is true for {@see inverseOf()}, which marks a relation
 * as inverse of another relation and {@see onCondition()} which adds a condition that is to be added to relational
 * query join condition.
 */
class ActiveQuery extends Query implements ActiveQueryInterface
{
    use ActiveQueryTrait;
    use ActiveRelationTrait;

    private string|null $sql = null;
    private array|string|null $on = null;
    private array $joinWith = [];
    private ActiveRecordInterface|null $arInstance = null;

    public function __construct(
        protected string $arClass,
        protected ConnectionInterface $db,
        private ActiveRecordFactory|null $arFactory = null,
        private string $tableName = ''
    ) {
        parent::__construct($db);
    }

    /**
     * Executes query and returns all results as an array.
     *
     * If null, the DB connection returned by {@see arClass} will be used.
     *
     * @throws Exception
     * @throws InvalidConfigException
     * @throws Throwable
     *
     * @return array the query results. If the query results in nothing, an empty array will be returned.
     *
     * @psalm-return ActiveRecord[]|array
     */
    public function all(): array
    {
        return parent::all();
    }

    public function prepare(QueryBuilderInterface $builder): QueryInterface
    {
        /**
         * NOTE: because the same ActiveQuery may be used to build different SQL statements, one for count query, the
         * other for row data query, it is important to make sure the same ActiveQuery can be used to build SQL
         * statements multiple times.
         */
        if (!empty($this->joinWith)) {
            $this->buildJoinWith();
            /** clean it up to avoid issue {@see https://github.com/yiisoft/yii2/issues/2687} */
            $this->joinWith = [];
        }

        if (empty($this->getFrom())) {
            $this->from = [$this->getPrimaryTableName()];
        }

        if (empty($this->getSelect()) && !empty($this->getJoin())) {
            [, $alias] = $this->getTableNameAndAlias();

            $this->select(["$alias.*"]);
        }

        if ($this->primaryModel === null) {
            /** eager loading */
            $query = (new Query($this->db))
                ->where($this->getWhere())
                ->limit($this->getLimit())
                ->offset($this->getOffset())
                ->orderBy($this->getOrderBy())
                ->indexBy($this->getIndexBy())
                ->select($this->select)
                ->selectOption($this->selectOption)
                ->distinct($this->distinct)
                ->from($this->from)
                ->groupBy($this->groupBy)
                ->setJoin($this->join)
                ->having($this->having)
                ->setUnion($this->union)
                ->params($this->params)
                ->withQueries($this->withQueries);
        } else {
            /** lazy loading of a relation */
            $where = $this->getWhere();

            if ($this->via instanceof self) {
                /** via junction table */
                $viaModels = $this->via->findJunctionRows([$this->primaryModel]);

                $this->filterByModels($viaModels);
            } elseif (is_array($this->via)) {
                [$viaName, $viaQuery, $viaCallableUsed] = $this->via;

                if ($viaQuery->getMultiple()) {
                    if ($viaCallableUsed) {
                        $viaModels = $viaQuery->all();
                    } elseif ($this->primaryModel->isRelationPopulated($viaName)) {
                        $viaModels = $this->primaryModel->$viaName;
                    } else {
                        $viaModels = $viaQuery->all();
                        $this->primaryModel->populateRelation($viaName, $viaModels);
                    }
                } else {
                    if ($viaCallableUsed) {
                        $model = $viaQuery->one();
                    } elseif ($this->primaryModel->isRelationPopulated($viaName)) {
                        $model = $this->primaryModel->$viaName;
                    } else {
                        $model = $viaQuery->one();
                        $this->primaryModel->populateRelation($viaName, $model);
                    }
                    $viaModels = $model === null ? [] : [$model];
                }
                $this->filterByModels($viaModels);
            } else {
                $this->filterByModels([$this->primaryModel]);
            }

            $query = (new Query($this->db))
                ->where($this->getWhere())
                ->limit($this->getLimit())
                ->offset($this->getOffset())
                ->orderBy($this->getOrderBy())
                ->indexBy($this->getIndexBy())
                ->select($this->select)
                ->selectOption($this->selectOption)
                ->distinct($this->distinct)
                ->from($this->from)
                ->groupBy($this->groupBy)
                ->setJoin($this->join)
                ->having($this->having)
                ->setUnion($this->union)
                ->params($this->params)
                ->withQueries($this->withQueries);
            $this->where($where);
        }

        if (!empty($this->on)) {
            $query->andWhere($this->on);
        }

        return $query;
    }

    /**
     * Converts the raw query results into the format as specified by this query.
     *
     * This method is internally used to convert the data fetched from database into the format as required by this
     * query.
     *
     * @param array $rows the raw query result from database.
     *
     * @throws Exception
     * @throws InvalidArgumentException
     * @throws InvalidConfigException
     * @throws NotSupportedException
     * @throws ReflectionException
     * @throws Throwable
     *
     * @return array the converted query result.
     */
    public function populate(array $rows): array
    {
        if (empty($rows)) {
            return [];
        }

        $models = $this->createModels($rows);

        if (!empty($this->join) && $this->getIndexBy() === null) {
            $models = $this->removeDuplicatedModels($models);
        }

        if (!empty($this->with)) {
            $this->findWith($this->with, $models);
        }

        if ($this->inverseOf !== null) {
            $this->addInverseRelations($models);
        }

        return parent::populate($models);
    }

    /**
     * Removes duplicated models by checking their primary key values.
     *
     * This method is mainly called when a join query is performed, which may cause duplicated rows being returned.
     *
     * @param array $models the models to be checked.
     *
     * @throws CircularReferenceException
     * @throws Exception
     * @throws InvalidConfigException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     *
     * @return array the distinctive models.
     */
    private function removeDuplicatedModels(array $models): array
    {
        $hash = [];

        $pks = $this->getARInstance()->primaryKey();

        if (count($pks) > 1) {
            /** composite primary key */
            foreach ($models as $i => $model) {
                $key = [];
                foreach ($pks as $pk) {
                    if (!isset($model[$pk])) {
                        /** do not continue if the primary key is not part of the result set */
                        break 2;
                    }
                    $key[] = $model[$pk];
                }

                $key = serialize($key);

                if (isset($hash[$key])) {
                    unset($models[$i]);
                } else {
                    $hash[$key] = true;
                }
            }
        } elseif (empty($pks)) {
            throw new InvalidConfigException("Primary key of '$this->arClass' can not be empty.");
        } else {
            /** single column primary key */
            $pk = reset($pks);

            foreach ($models as $i => $model) {
                if (!isset($model[$pk])) {
                    /** do not continue if the primary key is not part of the result set */
                    break;
                }

                $key = $model[$pk];

                if (isset($hash[$key])) {
                    unset($models[$i]);
                } else {
                    $hash[$key] = true;
                }
            }
        }

        return array_values($models);
    }

    /**
     * @psalm-suppress NullableReturnStatement
     */
    public function one(): array|null|object
    {
        $row = parent::one();

        if ($row !== null) {
            $activeRecord = $this->populate([$row]);
            $row = reset($activeRecord) ?: null;
        }

        return $row;
    }

    /**
     * Creates a DB command that can be used to execute this query.
     *
     * @throws Exception
     *
     * @return CommandInterface the created DB command instance.
     */
    public function createCommand(): CommandInterface
    {
        if ($this->sql === null) {
            [$sql, $params] = $this->db->getQueryBuilder()->build($this);
        } else {
            $sql = $this->sql;
            $params = $this->params;
        }

        return $this->db->createCommand($sql, $params);
    }

    /**
     * Queries a scalar value by setting {@see select} first.
     *
     * Restores the value of select to make this query reusable.
     *
     * @param ExpressionInterface|string $selectExpression
     *
     * @throws Exception
     * @throws InvalidConfigException
     * @throws Throwable
     */
    protected function queryScalar(string|ExpressionInterface $selectExpression): bool|string|null|int|float
    {
        if ($this->sql === null) {
            return parent::queryScalar($selectExpression);
        }

        $command = (new Query($this->db))->select([$selectExpression])
            ->from(['c' => "($this->sql)"])
            ->params($this->params)
            ->createCommand();

        return $command->queryScalar();
    }

    /**
     * Joins with the specified relations.
     *
     * This method allows you to reuse existing relation definitions to perform JOIN queries. Based on the definition of
     * the specified relation(s), the method will append one or multiple JOIN statements to the current query.
     *
     * If the `$eagerLoading` parameter is true, the method will also perform eager loading for the specified relations,
     * which is equivalent to calling {@see with()} using the specified relations.
     *
     * Note that because a JOIN query will be performed, you are responsible to disambiguate column names.
     *
     * This method differs from {@see with()} in that it will build up and execute a JOIN SQL statement  for the primary
     * table. And when `$eagerLoading` is true, it will call {@see with()} in addition with the specified relations.
     *
     * @param array|string $with the relations to be joined. This can either be a string, representing a relation name
     * or an array with the following semantics:
     *
     * - Each array element represents a single relation.
     * - You may specify the relation name as the array key and provide an anonymous functions that can be used to
     *   modify the relation queries on-the-fly as the array value.
     * - If a relation query does not need modification, you may use the relation name as the array value.
     *
     * The relation name may optionally contain an alias for the relation table (e.g. `books b`).
     *
     * Sub-relations can also be specified, see {@see with()} for the syntax.
     *
     * In the following you find some examples:
     *
     * ```php
     * // find all orders that contain books, and eager loading "books".
     * $orderQuery = new ActiveQuery(Order::class, $db);
     * $orderQuery->joinWith('books', true, 'INNER JOIN')->all();
     *
     * // find all orders, eager loading "books", and sort the orders and books by the book names.
     * $orderQuery = new ActiveQuery(Order::class, $db);
     * $orderQuery->joinWith([
     *     'books' => function (ActiveQuery $query) {
     *         $query->orderBy('item.name');
     *     }
     * ])->all();
     *
     * // find all orders that contain books of the category 'Science fiction', using the alias "b" for the books table.
     * $order = new ActiveQuery(Order::class, $db);
     * $orderQuery->joinWith(['books b'], true, 'INNER JOIN')->where(['b.category' => 'Science fiction'])->all();
     * ```
     * @param array|bool $eagerLoading whether to eager load the relations specified in `$with`. When this is a boolean,
     * it applies to all relations specified in `$with`. Use an array to explicitly list which relations in `$with` need
     * to be eagerly loaded.  Note, that this does not mean, that the relations are populated from the query result. An
     * extra query will still be performed to bring in the related data. Defaults to `true`.
     * @param array|string $joinType the join type of the relations specified in `$with`.  When this is a string, it
     * applies to all relations specified in `$with`. Use an array in the format of `relationName => joinType` to
     * specify different join types for different relations.
     *
     * @return $this the query object itself.
     */
    public function joinWith(
        array|string $with,
        array|bool $eagerLoading = true,
        array|string $joinType = 'LEFT JOIN'
    ): self {
        $relations = [];

        foreach ((array) $with as $name => $callback) {
            if (is_int($name)) {
                $name = $callback;
                $callback = null;
            }

            if (preg_match('/^(.*?)(?:\s+AS\s+|\s+)(\w+)$/i', $name, $matches)) {
                /** relation is defined with an alias, adjust callback to apply alias */
                [, $relation, $alias] = $matches;

                $name = $relation;

                $callback = static function (self $query) use ($callback, $alias) {
                    $query->alias($alias);

                    if ($callback !== null) {
                        $callback($query);
                    }
                };
            }

            if ($callback === null) {
                $relations[] = $name;
            } else {
                $relations[$name] = $callback;
            }
        }

        $this->joinWith[] = [$relations, $eagerLoading, $joinType];

        return $this;
    }

    /**
     * @throws CircularReferenceException
     * @throws InvalidConfigException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    public function buildJoinWith(): void
    {
        $join = $this->join;

        $this->join = [];

        $arClass = $this->getARInstance();

        foreach ($this->joinWith as [$with, $eagerLoading, $joinType]) {
            $this->joinWithRelations($arClass, $with, $joinType);

            if (is_array($eagerLoading)) {
                foreach ($with as $name => $callback) {
                    if (is_int($name)) {
                        if (!in_array($callback, $eagerLoading, true)) {
                            unset($with[$name]);
                        }
                    } elseif (!in_array($name, $eagerLoading, true)) {
                        unset($with[$name]);
                    }
                }
            } elseif (!$eagerLoading) {
                $with = [];
            }

            $this->with($with);
        }

        /**
         * Remove duplicated joins added by joinWithRelations that may be added e.g. when joining a relation and a via
         * relation at the same time.
         */
        $uniqueJoins = [];

        foreach ($this->join as $j) {
            $uniqueJoins[serialize($j)] = $j;
        }
        $this->join = array_values($uniqueJoins);

        /** {@see https://github.com/yiisoft/yii2/issues/16092 } */
        $uniqueJoinsByTableName = [];

        foreach ($this->join as $config) {
            $tableName = serialize($config[1]);
            if (!array_key_exists($tableName, $uniqueJoinsByTableName)) {
                $uniqueJoinsByTableName[$tableName] = $config;
            }
        }

        $this->join = array_values($uniqueJoinsByTableName);

        if (!empty($join)) {
            /** Append explicit join to joinWith() {@see https://github.com/yiisoft/yii2/issues/2880} */
            $this->join = empty($this->join) ? $join : array_merge($this->join, $join);
        }
    }

    /**
     * Inner joins with the specified relations.
     *
     * This is a shortcut method to {@see joinWith()} with the join type set as "INNER JOIN". Please refer to
     * {@see joinWith()} for detailed usage of this method.
     *
     * @param array|string $with the relations to be joined with.
     * @param array|bool $eagerLoading whether to eager load the relations. Note, that this does not mean, that the
     * relations are populated from the query result. An extra query will still be performed to bring in the related
     * data.
     *
     * @return $this the query object itself.
     *
     * {@see joinWith()}
     */
    public function innerJoinWith(array|string $with, array|bool $eagerLoading = true): self
    {
        return $this->joinWith($with, $eagerLoading, 'INNER JOIN');
    }

    /**
     * Modifies the current query by adding join fragments based on the given relations.
     *
     * @param ActiveRecordInterface $arClass the primary model.
     * @param array $with the relations to be joined.
     * @param array|string $joinType the join type.
     *
     * @throws CircularReferenceException
     * @throws InvalidConfigException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    private function joinWithRelations(ActiveRecordInterface $arClass, array $with, array|string $joinType): void
    {
        $relations = [];

        foreach ($with as $name => $callback) {
            if (is_int($name)) {
                $name = $callback;
                $callback = null;
            }

            $primaryModel = $arClass;
            $parent = $this;
            $prefix = '';

            while (($pos = strpos($name, '.')) !== false) {
                $childName = substr($name, $pos + 1);
                $name = substr($name, 0, $pos);
                $fullName = $prefix === '' ? $name : "$prefix.$name";

                if (!isset($relations[$fullName])) {
                    $relations[$fullName] = $relation = $primaryModel->getRelation($name);
                    $this->joinWithRelation($parent, $relation, $this->getJoinType($joinType, $fullName));
                    $this->joinWithRelation($parent, /** @scrutinizer ignore-type */ $relation, $this->getJoinType($joinType, $fullName));
                } else {
                    $relation = $relations[$fullName];
                }

                $primaryModel = $relation->getARInstance();
                $primaryModel = $relation->getARInstance();

                $parent = $relation;
                $prefix = $fullName;
                $name = $childName;
            }

            $fullName = $prefix === '' ? $name : "$prefix.$name";

            if (!isset($relations[$fullName])) {
                $relations[$fullName] = $relation = $primaryModel->getRelation($name);

                if ($callback !== null) {
                    $callback($relation);
                }

                if (!empty($relation->getJoinWith())) {
                    $relation->buildJoinWith();
                }

                $this->joinWithRelation($parent, $relation, $this->getJoinType($joinType, $fullName));
                $this->joinWithRelation(/** @scrutinizer ignore-type */ $parent, $relation, $this->getJoinType($joinType, $fullName));
            }
        }
    }

    /**
     * Returns the join type based on the given join type parameter and the relation name.
     *
     * @param array|string $joinType the given join type(s).
     * @param string $name relation name.
     *
     * @return string the real join type.
     */
    private function getJoinType(array|string $joinType, string $name): string
    {
        if (is_array($joinType) && isset($joinType[$name])) {
            return $joinType[$name];
        }

        return is_string($joinType) ? $joinType : 'INNER JOIN';
    }

    /**
     * Returns the table name and the table alias for {@see arClass}.
     *
     * @throws CircularReferenceException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    private function getTableNameAndAlias(): array
    {
        if (empty($this->from)) {
            $tableName = $this->getPrimaryTableName();
        } else {
            $tableName = '';

            foreach ($this->from as $alias => $tableName) {
                if (is_string($alias)) {
                    return [$tableName, $alias];
                }
                break;
            }
        }

        if (preg_match('/^(.*?)\s+({{\w+}}|\w+)$/', $tableName, $matches)) {
            $alias = $matches[2];
        } else {
            $alias = $tableName;
        }

        return [$tableName, $alias];
    }

    /**
     * Joins a parent query with a child query.
     *
     * The current query object will be modified accordingly.
     *
     * @param ActiveQuery $parent
     * @param ActiveQuery $child
     * @param string $joinType
     *
     * @throws CircularReferenceException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    private function joinWithRelation(ActiveQueryInterface $parent, ActiveQueryInterface $child, string $joinType): void
    {
        $via = $child->via;

        $child->via = null;

        if ($via instanceof self) {
            /** via table */
            $this->joinWithRelation($parent, $via, $joinType);
            $this->joinWithRelation($via, $child, $joinType);

            return;
        }

        if (is_array($via)) {
            /** via relation */
            $this->joinWithRelation($parent, $via[1], $joinType);
            $this->joinWithRelation($via[1], $child, $joinType);

            return;
        }

        [$parentTable, $parentAlias] = $parent->getTableNameAndAlias();
        [$parentTable, $parentAlias] = $parent->getTableNameAndAlias();
        [$childTable, $childAlias] = $child->getTableNameAndAlias();

        if (!empty($child->link)) {

            if (!str_contains($parentAlias, '{{')) {
                $parentAlias = '{{' . $parentAlias . '}}';
            }

            if (!str_contains($childAlias, '{{')) {
                $childAlias = '{{' . $childAlias . '}}';
            }

            $on = [];

            foreach ($child->link as $childColumn => $parentColumn) {
                $on[] = "$parentAlias.[[$parentColumn]] = $childAlias.[[$childColumn]]";
            }

            $on = implode(' AND ', $on);

            if (!empty($child->on)) {

                $on = ['and', $on, $child->on];
            }
        } else {
            $on = $child->on;
        }

        $this->join($joinType, empty($child->getFrom()) ? $childTable : $child->getFrom(), $on);

        if (!empty($child->getWhere())) {
            $this->andWhere($child->getWhere());
        }

        if (!empty($child->getHaving())) {
            $this->andHaving($child->getHaving());
        }

        if (!empty($child->getOrderBy())) {
            $this->addOrderBy($child->getOrderBy());
        }

        if (!empty($child->getGroupBy())) {
            $this->addGroupBy($child->getGroupBy());
        }

        if (!empty($child->getParams())) {
            $this->addParams($child->getParams());
        }

        if (!empty($child->getJoin())) {
            foreach ($child->getJoin() as $join) {
                $this->join[] = $join;
            }
        }

        if (!empty($child->getUnion())) {
            foreach ($child->getUnion() as $union) {
                $this->union[] = $union;
            }
        }
    }

    /**
     * Sets the ON condition for a relational query.
     *
     * The condition will be used in the ON part when {@see ActiveQuery::joinWith()} is called.
     *
     * Otherwise, the condition will be used in the WHERE part of a query.
     *
     * Use this method to specify additional conditions when declaring a relation in the {@see ActiveRecord} class:
     *
     * ```php
     * public function getActiveUsers(): ActiveQuery
     * {
     *     return $this->hasMany(User::class, ['id' => 'user_id'])->onCondition(['active' => true]);
     * }
     * ```
     *
     * Note that this condition is applied in case of a join as well as when fetching the related records. This only
     * fields of the related table can be used in the condition. Trying to access fields of the primary record will
     * cause an error in a non-join-query.
     *
     * @param array|string $condition the ON condition. Please refer to {@see Query::where()} on how to specify this
     * parameter.
     * @param array $params the parameters (name => value) to be bound to the query.
     *
     * @return $this the query object itself
     */
    public function onCondition(array|string $condition, array $params = []): self
    {
        $this->on = $condition;

        $this->addParams($params);

        return $this;
    }

    /**
     * Adds ON condition to the existing one.
     *
     * The new condition and the existing one will be joined using the 'AND' operator.
     *
     * @param array|string $condition the new ON condition. Please refer to {@see where()} on how to specify this
     * parameter.
     * @param array $params the parameters (name => value) to be bound to the query.
     *
     * @return $this the query object itself.
     *
     * {@see onCondition()}
     * {@see orOnCondition()}
     */
    public function andOnCondition(array|string $condition, array $params = []): self
    {
        if ($this->on === null) {
            $this->on = $condition;
        } else {
            $this->on = ['and', $this->on, $condition];
        }

        $this->addParams($params);

        return $this;
    }

    /**
     * Adds ON condition to the existing one.
     *
     * The new condition and the existing one will be joined using the 'OR' operator.
     *
     * @param array|string $condition the new ON condition. Please refer to {@see where()} on how to specify this
     * parameter.
     * @param array $params the parameters (name => value) to be bound to the query.
     *
     * @return $this the query object itself.
     *
     * {@see onCondition()}
     * {@see andOnCondition()}
     */
    public function orOnCondition(array|string $condition, array $params = []): self
    {
        if ($this->on === null) {
            $this->on = $condition;
        } else {
            $this->on = ['or', $this->on, $condition];
        }

        $this->addParams($params);

        return $this;
    }

    /**
     * Specifies the junction table for a relational query.
     *
     * Use this method to specify a junction table when declaring a relation in the {@see ActiveRecord} class:
     *
     * ```php
     * public function getItems()
     * {
     *     return $this->hasMany(Item::class, ['id' => 'item_id'])->viaTable('order_item', ['order_id' => 'id']);
     * }
     * ```
     *
     * @param string $tableName the name of the junction table.
     * @param array $link the link between the junction table and the table associated with {@see primaryModel}.
     * The keys of the array represent the columns in the junction table, and the values represent the columns in the
     * {@see primaryModel} table.
     * @param callable|null $callable a PHP callback for customizing the relation associated with the junction table.
     * Its signature should be `function($query)`, where `$query` is the query to be customized.
     *
     * @return $this the query object itself.
     *
     * {@see via()}
     */
    public function viaTable(string $tableName, array $link, callable $callable = null): self
    {
        $arClass = $this->primaryModel ? $this->primaryModel::class : $this->arClass;

        $arClassInstance = new self($arClass, $this->db);

        $relation = $arClassInstance->from([$tableName])->link($link)->multiple(true)->asArray(true);

        $this->via = $relation;

        if ($callable !== null) {
            $callable($relation);
        }

        return $this;
    }

    /**
     * Define an alias for the table defined in {@see arClass}.
     *
     * This method will adjust {@see from} so that an already defined alias will be overwritten. If none was defined,
     * {@see from} will be populated with the given alias.
     *
     * @param string $alias the table alias.
     *
     * @throws CircularReferenceException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    public function alias(string $alias): self
    {
        if (empty($this->from) || count($this->from) < 2) {
            [$tableName] = $this->getTableNameAndAlias();
            $this->from = [$alias => $tableName];
        } else {
            $tableName = $this->getPrimaryTableName();

            foreach ($this->from as $key => $table) {
                if ($table === $tableName) {
                    unset($this->from[$key]);
                    $this->from[$alias] = $tableName;
                }
            }
        }

        return $this;
    }

    /**
     * Returns table names used in {@see from} indexed by aliases.
     *
     * Both aliases and names are enclosed into {{ and }}.
     *
     * @throws CircularReferenceException
     * @throws InvalidArgumentException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    public function getTablesUsedInFrom(): array
    {
        if (empty($this->from)) {
            return $this->db->getQuoter()->cleanUpTableNames([$this->getPrimaryTableName()]);
        }

        return parent::getTablesUsedInFrom();
    }

    /**
     * @throws CircularReferenceException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    protected function getPrimaryTableName(): string
    {
        return $this->getARInstance()->getTableName();
    }

    /**
     * @return array|string|null the join condition to be used when this query is used in a relational context.
     *
     * The condition will be used in the ON part when {@see ActiveQuery::joinWith()} is called. Otherwise, the condition
     * will be used in the WHERE part of a query.
     *
     * Please refer to {@see Query::where()} on how to specify this parameter.
     *
     * {@see onCondition()}
     */
    public function getOn(): array|string|null
    {
        return $this->on;
    }

    /**
     * @return array $value a list of relations that this query should be joined with.
     */
    public function getJoinWith(): array
    {
        return $this->joinWith;
    }

    /**
     * @return string|null the SQL statement to be executed for retrieving AR records.
     *
     * This is set by {@see ActiveRecord::findBySql()}.
     */
    public function getSql(): string|null
    {
        return $this->sql;
    }

    public function getARClass(): string|null
    {
        return $this->arClass;
    }

    /**
     * @throws Exception
     * @throws InvalidArgumentException
     * @throws InvalidConfigException
     * @throws Throwable
     */
    public function findOne(mixed $condition): array|ActiveRecordInterface|null
    {
        return $this->findByCondition($condition)->one();
    }

    /**
     * @param mixed $condition primary key value or a set of column values.
     *
     * @throws Exception
     * @throws InvalidArgumentException
     * @throws InvalidConfigException
     * @throws Throwable
     *
     * @return array of ActiveRecord instance, or an empty array if nothing matches.
     */
    public function findAll(mixed $condition): array
    {
        return $this->findByCondition($condition)->all();
    }

    /**
     * Finds ActiveRecord instance(s) by the given condition.
     *
     * This method is internally called by {@see findOne()} and {@see findAll()}.
     *
     * @param mixed $condition please refer to {@see findOne()} for the explanation of this parameter.
     *
     * @throws CircularReferenceException
     * @throws Exception
     * @throws InvalidArgumentException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException if there is no primary key defined.
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    protected function findByCondition(mixed $condition): QueryInterface
    {
        $arInstance = $this->getARInstance();

        if (!is_array($condition)) {
            $condition = [$condition];
        }

        if (!ArrayHelper::isAssociative($condition) && !$condition instanceof ExpressionInterface) {
            /** query by primary key */
            $primaryKey = $arInstance->primaryKey();

            if (isset($primaryKey[0])) {
                $pk = $primaryKey[0];

                if (!empty($this->getJoin()) || !empty($this->getJoinWith())) {
                    $pk = $arInstance->getTableName() . '.' . $pk;
                }

                /**
                 * if condition is scalar, search for a single primary key, if it is array, search for multiple primary
                 * key values
                 */
                $condition = [$pk => array_values($condition)];
            } else {
                throw new InvalidConfigException('"' . $arInstance::class . '" must have a primary key.');
            }
        } else {
            $aliases = $arInstance->filterValidAliases($this);
            $condition = $arInstance->filterCondition($condition, $aliases);
        }

        return $this->where($condition);
    }

    /**
     * Creates an {@see ActiveQuery} instance with a given SQL statement.
     *
     * Note that because the SQL statement is already specified, calling additional query modification methods (such as
     * `where()`, `order()`) on the created {@see ActiveQuery} instance will have no effect. However, calling `with()`,
     * `asArray()` or `indexBy()` is still fine.
     *
     * Below is an example:
     *
     * ```php
     * $customerQuery = new ActiveQuery(Customer::class, $db);
     * $customers = $customerQuery->findBySql('SELECT * FROM customer')->all();
     * ```
     *
     * @param string $sql the SQL statement to be executed.
     * @param array $params parameters to be bound to the SQL statement during execution.
     *
     * @return QueryInterface the newly created {@see ActiveQuery} instance
     */
    public function findBySql(string $sql, array $params = []): QueryInterface
    {
        return $this->sql($sql)->params($params);
    }

    public function on(array|string|null $value): self
    {
        $this->on = $value;
        return $this;
    }

    public function sql(string|null $value): self
    {
        $this->sql = $value;
        return $this;
    }

    /**
     * @throws CircularReferenceException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     */
    public function getARInstance(): ActiveRecordInterface
    {
        if ($this->arFactory !== null) {
            return $this->getARInstanceFactory();
        }

        $class = $this->arClass;

        return new $class($this->db, null, $this->tableName);
    }

    /**
     * @throws CircularReferenceException
     * @throws \Yiisoft\Definitions\Exception\InvalidConfigException
     * @throws NotInstantiableException
     * @throws NotFoundException
     */
    public function getARInstanceFactory(): ActiveRecordInterface
    {
        return $this->arFactory->createAR($this->arClass, $this->tableName, $this->db);
        return $this->arFactory->/** @scrutinizer ignore-call */ createAR($this->arClass, $this->tableName, $this->db);
    }
}

yiisoft / active-record

Pull Request — master (#228)

ActiveQuery::createQueryHelper() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
