Issues in ActiveRelationTrait.php - Fixed Issues - Inspection of "Fixes #15482: AR::find()->with() missing data when..." - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 63faf5...4333b9 )

by Alexander

created 2019-01-14 23:51 UTC

framework/db/ActiveRelationTrait.php (1 issue)

Labels

Bug 1

Severity

Minor 1

SonicGD 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\db;

use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;

/**
 * ActiveRelationTrait implements the common methods and properties for active record relational queries.
 *
 * @author Qiang Xue <[email protected]>
 * @author Carsten Brandt <[email protected]>
 * @since 2.0
 *
 * @method ActiveRecordInterface one()
 * @method ActiveRecordInterface[] all()
 * @property ActiveRecord $modelClass
 */
trait ActiveRelationTrait
{
    /**
     * @var bool whether this query represents a relation to more than one record.
     * This property is only used in relational context. If true, this relation will
     * populate all query results into AR instances using [[Query::all()|all()]].
     * If false, only the first row of the results will be retrieved using [[Query::one()|one()]].
     */
    public $multiple;
    /**
     * @var ActiveRecord the primary model of a relational query.
     * This is used only in lazy loading with dynamic query options.
     */
    public $primaryModel;
    /**
     * @var array the columns of the primary and foreign tables that establish a relation.
     * The array keys must be columns of the table for this relation, and the array values
     * must be the corresponding columns from the primary table.
     * Do not prefix or quote the column names as this will be done automatically by Yii.
     * This property is only used in relational context.
     */
    public $link;
    /**
     * @var array|object the query associated with the junction table. Please call [[via()]]
     * to set this property instead of directly setting it.
     * This property is only used in relational context.
     * @see via()
     */
    public $via;
    /**
     * @var string the name of the relation that is the inverse of this relation.
     * For example, an order has a customer, which means the inverse of the "customer" relation
     * is the "orders", and the inverse of the "orders" relation is the "customer".
     * If this property is set, the primary record(s) will be referenced through the specified relation.
     * For example, `$customer->orders[0]->customer` and `$customer` will be the same object,
     * and accessing the customer of an order will not trigger new DB query.
     * This property is only used in relational context.
     * @see inverseOf()
     */
    public $inverseOf;

    private $viaMap;

    /**
     * Clones internal objects.
     */
    public function __clone()
    {
        parent::__clone();
        // make a clone of "via" object so that the same query object can be reused multiple times
        if (is_object($this->via)) {
            $this->via = clone $this->via;
        } elseif (is_array($this->via)) {
            $this->via = [$this->via[0], clone $this->via[1]];
        }
    }

    /**
     * Specifies the relation associated with the junction table.
     *
     * Use this method to specify a pivot record/table when declaring a relation in the [[ActiveRecord]] class:
     *
     * ```php
     * class Order extends ActiveRecord
     * {
     *    public function getOrderItems() {
     *        return $this->hasMany(OrderItem::className(), ['order_id' => 'id']);
     *    }
     *
     *    public function getItems() {
     *        return $this->hasMany(Item::className(), ['id' => 'item_id'])
     *                    ->via('orderItems');
     *    }
     * }
     * ```
     *
     * @param string $relationName the relation name. This refers to a relation declared in [[primaryModel]].
     * @param callable $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 relation object itself.
     */
    public function via($relationName, callable $callable = null)
    {
        $relation = $this->primaryModel->getRelation($relationName);
        $this->via = [$relationName, $relation];
        if ($callable !== null) {
            call_user_func($callable, $relation);
        }

        return $this;
    }

    /**
     * Sets the name of the relation that is the inverse of this relation.
     * For example, a customer has orders, which means the inverse of the "orders" relation is the "customer".
     * If this property is set, the primary record(s) will be referenced through the specified relation.
     * For example, `$customer->orders[0]->customer` and `$customer` will be the same object,
     * and accessing the customer of an order will not trigger a new DB query.
     *
     * Use this method when declaring a relation in the [[ActiveRecord]] class, e.g. in Customer model:
     *
     * ```php
     * public function getOrders()
     * {
     *     return $this->hasMany(Order::className(), ['customer_id' => 'id'])->inverseOf('customer');
     * }
     * ```
     *
     * This also may be used for Order model, but with caution:
     *
     * ```php
     * public function getCustomer()
     * {
     *     return $this->hasOne(Customer::className(), ['id' => 'customer_id'])->inverseOf('orders');
     * }
     * ```
     *
     * in this case result will depend on how order(s) was loaded.
     * Let's suppose customer has several orders. If only one order was loaded:
     *
     * ```php
     * $orders = Order::find()->where(['id' => 1])->all();
     * $customerOrders = $orders[0]->customer->orders;
     * ```
     *
     * variable `$customerOrders` will contain only one order. If orders was loaded like this:
     *
     * ```php
     * $orders = Order::find()->with('customer')->where(['customer_id' => 1])->all();
     * $customerOrders = $orders[0]->customer->orders;
     * ```
     *
     * variable `$customerOrders` will contain all orders of the customer.
     *
     * @param string $relationName the name of the relation that is the inverse of this relation.
     * @return $this the relation object itself.
     */
    public function inverseOf($relationName)
    {
        $this->inverseOf = $relationName;
        return $this;
    }

    /**
     * Finds the related records for the specified primary record.
     * This method is invoked when a relation of an ActiveRecord is being accessed in a lazy fashion.
     * @param string $name the relation name
     * @param ActiveRecordInterface|BaseActiveRecord $model the primary model
     * @return mixed the related record(s)
     * @throws InvalidArgumentException if the relation is invalid
     */
    public function findFor($name, $model)
    {
        if (method_exists($model, 'get' . $name)) {
            $method = new \ReflectionMethod($model, 'get' . $name);
            $realName = lcfirst(substr($method->getName(), 3));
            if ($realName !== $name) {
                throw new InvalidArgumentException('Relation names are case sensitive. ' . get_class($model) . " has a relation named \"$realName\" instead of \"$name\".");
            }
        }

        return $this->multiple ? $this->all() : $this->one();
    }

    /**
     * If applicable, populate the query's primary model into the related records' inverse relationship.
     * @param array $result the array of related records as generated by [[populate()]]
     * @since 2.0.9
     */
    private function addInverseRelations(&$result)
    {
        if ($this->inverseOf === null) {
            return;
        }

        foreach ($result as $i => $relatedModel) {
            if ($relatedModel instanceof ActiveRecordInterface) {
                if (!isset($inverseRelation)) {
                    $inverseRelation = $relatedModel->getRelation($this->inverseOf);
                }
                $relatedModel->populateRelation($this->inverseOf, $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel);
            } else {
                if (!isset($inverseRelation)) {
                    /* @var $modelClass ActiveRecordInterface */
                    $modelClass = $this->modelClass;
                    $inverseRelation = $modelClass::instance()->getRelation($this->inverseOf);
                }
                $result[$i][$this->inverseOf] = $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel;
            }
        }
    }

    /**
     * Finds the related records and populates them into the primary models.
     * @param string $name the relation name
     * @param array $primaryModels primary models
     * @return array the related models
     * @throws InvalidConfigException if [[link]] is invalid
     */
    public function populateRelation($name, &$primaryModels)
    {
        if (!is_array($this->link)) {
            throw new InvalidConfigException('Invalid link: it must be an array of key-value pairs.');
        }

        if ($this->via instanceof self) {
            // via junction table
            /* @var $viaQuery ActiveRelationTrait */
            $viaQuery = $this->via;
            $viaModels = $viaQuery->findJunctionRows($primaryModels);
            $this->filterByModels($viaModels);
        } elseif (is_array($this->via)) {
            // via relation
            /* @var $viaQuery ActiveRelationTrait|ActiveQueryTrait */
            list($viaName, $viaQuery) = $this->via;
            if ($viaQuery->asArray === null) {
                // inherit asArray from primary query
                $viaQuery->asArray($this->asArray);
            }
            $viaQuery->primaryModel = null;
            $viaModels = $viaQuery->populateRelation($viaName, $primaryModels);
            $this->filterByModels($viaModels);
        } else {
            $this->filterByModels($primaryModels);
        }

        if (!$this->multiple && count($primaryModels) === 1) {
            $model = $this->one();
            $primaryModel = reset($primaryModels);
            if ($primaryModel instanceof ActiveRecordInterface) {
                $primaryModel->populateRelation($name, $model);
            } else {
                $primaryModels[key($primaryModels)][$name] = $model;
            }
            if ($this->inverseOf !== null) {
                $this->populateInverseRelation($primaryModels, [$model], $name, $this->inverseOf);
            }

            return [$model];
        }

        // https://github.com/yiisoft/yii2/issues/3197
        // delay indexing related models after buckets are built
        $indexBy = $this->indexBy;
        $this->indexBy = null;
        $models = $this->all();

        if (isset($viaModels, $viaQuery)) {
            $buckets = $this->buildBuckets($models, $this->link, $viaModels, $viaQuery);
        } else {
            $buckets = $this->buildBuckets($models, $this->link);
        }

        $this->indexBy = $indexBy;
        if ($this->indexBy !== null && $this->multiple) {
            $buckets = $this->indexBuckets($buckets, $this->indexBy);
        }

        $link = array_values($this->link);
        if (isset($viaQuery)) {
            $deepViaQuery = $viaQuery;
            while ($deepViaQuery->via) {
                $deepViaQuery = is_array($deepViaQuery->via) ? $deepViaQuery->via[1] : $deepViaQuery->via;
            };
            $link = array_values($deepViaQuery->link);
        }
        foreach ($primaryModels as $i => $primaryModel) {
            if ($this->multiple && count($link) === 1 && is_array($keys = $primaryModel[reset($link)])) {
                $value = [];
                foreach ($keys as $key) {
                    $key = $this->normalizeModelKey($key);
                    if (isset($buckets[$key])) {
                        if ($this->indexBy !== null) {
                            // if indexBy is set, array_merge will cause renumbering of numeric array
                            foreach ($buckets[$key] as $bucketKey => $bucketValue) {
                                $value[$bucketKey] = $bucketValue;
                            }
                        } else {
                            $value = array_merge($value, $buckets[$key]);
                        }
                    }
                }
            } else {
                $key = $this->getModelKey($primaryModel, $link);
                $value = isset($buckets[$key]) ? $buckets[$key] : ($this->multiple ? [] : null);
            }
            if ($primaryModel instanceof ActiveRecordInterface) {
                $primaryModel->populateRelation($name, $value);
            } else {
                $primaryModels[$i][$name] = $value;
            }
        }
        if ($this->inverseOf !== null) {
            $this->populateInverseRelation($primaryModels, $models, $name, $this->inverseOf);
        }

        return $models;
    }

    /**
     * @param ActiveRecordInterface[] $primaryModels primary models
     * @param ActiveRecordInterface[] $models models
     * @param string $primaryName the primary relation name
     * @param string $name the relation name
     */
    private function populateInverseRelation(&$primaryModels, $models, $primaryName, $name)
    {
        if (empty($models) || empty($primaryModels)) {
            return;
        }
        $model = reset($models);
        /* @var $relation ActiveQueryInterface|ActiveQuery */
        if ($model instanceof ActiveRecordInterface) {
            $relation = $model->getRelation($name);
        } else {
            /* @var $modelClass ActiveRecordInterface */
            $modelClass = $this->modelClass;
            $relation = $modelClass::instance()->getRelation($name);
        }

        if ($relation->multiple) {
            $buckets = $this->buildBuckets($primaryModels, $relation->link, null, null, false);
            if ($model instanceof ActiveRecordInterface) {
                foreach ($models as $model) {
                    $key = $this->getModelKey($model, $relation->link);
                    $model->populateRelation($name, isset($buckets[$key]) ? $buckets[$key] : []);
                }
            } else {
                foreach ($primaryModels as $i => $primaryModel) {
                    if ($this->multiple) {
                        foreach ($primaryModel as $j => $m) {
                            $key = $this->getModelKey($m, $relation->link);
                            $primaryModels[$i][$j][$name] = isset($buckets[$key]) ? $buckets[$key] : [];
                        }
                    } elseif (!empty($primaryModel[$primaryName])) {
                        $key = $this->getModelKey($primaryModel[$primaryName], $relation->link);
                        $primaryModels[$i][$primaryName][$name] = isset($buckets[$key]) ? $buckets[$key] : [];
                    }
                }
            }
        } elseif ($this->multiple) {
            foreach ($primaryModels as $i => $primaryModel) {
                foreach ($primaryModel[$primaryName] as $j => $m) {
                    if ($m instanceof ActiveRecordInterface) {
                        $m->populateRelation($name, $primaryModel);
                    } else {
                        $primaryModels[$i][$primaryName][$j][$name] = $primaryModel;
                    }
                }
            }
        } else {
            foreach ($primaryModels as $i => $primaryModel) {
                if ($primaryModels[$i][$primaryName] instanceof ActiveRecordInterface) {
                    $primaryModels[$i][$primaryName]->populateRelation($name, $primaryModel);
                } elseif (!empty($primaryModels[$i][$primaryName])) {
                    $primaryModels[$i][$primaryName][$name] = $primaryModel;
                }
            }
        }
    }

    /**
     * @param array $models
     * @param array $link
     * @param array $viaModels
     * @param null|self $viaQuery
     * @param bool $checkMultiple
     * @return array
     */
    private function buildBuckets($models, $link, $viaModels = null, $viaQuery = null, $checkMultiple = true)
    {
        if ($viaModels !== null) {
            $map = [];
            $viaLink = $viaQuery->link;
            $viaLinkKeys = array_keys($viaLink);
            $linkValues = array_values($link);
            foreach ($viaModels as $viaModel) {
                $key1 = $this->getModelKey($viaModel, $viaLinkKeys);
                $key2 = $this->getModelKey($viaModel, $linkValues);
                $map[$key2][$key1] = true;
            }

            $viaQuery->viaMap = $map;

            $viaVia = $viaQuery->via;
            while ($viaVia) {
                $viaViaQuery = is_array($viaVia) ? $viaVia[1] : $viaVia;
                $map = $this->mapVia($map, $viaViaQuery->viaMap);

                $viaVia = $viaViaQuery->via;
            };
        }

        $buckets = [];
        $linkKeys = array_keys($link);

        if (isset($map)) {
            foreach ($models as $model) {
                $key = $this->getModelKey($model, $linkKeys);
                if (isset($map[$key])) {
                    foreach (array_keys($map[$key]) as $key2) {
                        $buckets[$key2][] = $model;
                    }
                }
            }
        } else {
            foreach ($models as $model) {
                $key = $this->getModelKey($model, $linkKeys);
                $buckets[$key][] = $model;
            }
        }

        if ($checkMultiple && !$this->multiple) {
            foreach ($buckets as $i => $bucket) {
                $buckets[$i] = reset($bucket);
            }
        }

        return $buckets;
    }

    /**
     * @param array $map
     * @param array $viaMap
     * @return array
     */
    private function mapVia($map, $viaMap) {
        $resultMap = [];
        foreach ($map as $key => $linkKeys) {
            foreach (array_keys($linkKeys) as $linkKey) {
                $resultMap[$key] = $viaMap[$linkKey];
            }
        }
        return $resultMap;
    }

    /**
     * Indexes buckets by column name.
     *
     * @param array $buckets
     * @param string|callable $indexBy the name of the column by which the query results should be indexed by.
     * This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data.
     * @return array
     */
    private function indexBuckets($buckets, $indexBy)
    {
        $result = [];
        foreach ($buckets as $key => $models) {
            $result[$key] = [];
            foreach ($models as $model) {
                $index = is_string($indexBy) ? $model[$indexBy] : call_user_func($indexBy, $model);
                $result[$key][$index] = $model;
            }
        }

        return $result;
    }

    /**
     * @param array $attributes the attributes to prefix
     * @return array
     */
    private function prefixKeyColumns($attributes)
    {
        if ($this instanceof ActiveQuery && (!empty($this->join) || !empty($this->joinWith))) {
            if (empty($this->from)) {
                /* @var $modelClass ActiveRecord */
                $modelClass = $this->modelClass;
                $alias = $modelClass::tableName();
            } else {
                foreach ($this->from as $alias => $table) {
                    if (!is_string($alias)) {
                        $alias = $table;
                    }
                    break;
                }
            }
            if (isset($alias)) {
                foreach ($attributes as $i => $attribute) {
                    $attributes[$i] = "$alias.$attribute";
                }
            }
        }

        return $attributes;
    }

    /**
     * @param array $models
     */
    private function filterByModels($models)
    {
        $attributes = array_keys($this->link);

        $attributes = $this->prefixKeyColumns($attributes);

        $values = [];
        if (count($attributes) === 1) {
            // single key
            $attribute = reset($this->link);
            foreach ($models as $model) {
                if (($value = $model[$attribute]) !== null) {
                    if (is_array($value)) {
                        $values = array_merge($values, $value);
                    } elseif ($value instanceof ArrayExpression && $value->getDimension() === 1) {
                        $values = array_merge($values, $value->getValue());
                    } else {
                        $values[] = $value;
                    }
                }
            }
            if (empty($values)) {
                $this->emulateExecution();
            }
        } else {
            // composite keys

            // ensure keys of $this->link are prefixed the same way as $attributes
            $prefixedLink = array_combine($attributes, $this->link);
            foreach ($models as $model) {
                $v = [];
                foreach ($prefixedLink as $attribute => $link) {
                    $v[$attribute] = $model[$link];
                }
                $values[] = $v;
                if (empty($v)) {
                    $this->emulateExecution();
                }
            }
        }
        $this->andWhere(['in', $attributes, array_unique($values, SORT_REGULAR)]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @param ActiveRecordInterface|array $model
     * @param array $attributes
     * @return string
     */
    private function getModelKey($model, $attributes)
    {
        $key = [];
        foreach ($attributes as $attribute) {
            $key[] = $this->normalizeModelKey($model[$attribute]);
        }
        if (count($key) > 1) {
            return serialize($key);
        }
        $key = reset($key);
        return is_scalar($key) ? $key : serialize($key);
    }

    /**
     * @param mixed $value raw key value.
     * @return string normalized key value.
     */
    private function normalizeModelKey($value)
    {
        if (is_object($value) && method_exists($value, '__toString')) {
            // ensure matching to special objects, which are convertable to string, for cross-DBMS relations, for example: `|MongoId`
            $value = $value->__toString();
        }

        return $value;
    }

    /**
     * @param array $primaryModels either array of AR instances or arrays
     * @return array
     */
    private function findJunctionRows($primaryModels)
    {
        if (empty($primaryModels)) {
            return [];
        }
        $this->filterByModels($primaryModels);
        /* @var $primaryModel ActiveRecord */
        $primaryModel = reset($primaryModels);
        if (!$primaryModel instanceof ActiveRecordInterface) {
            // when primaryModels are array of arrays (asArray case)
            $primaryModel = $this->modelClass;
        }

        return $this->asArray()->all($primaryModel::getDb());
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\db;
9
10		use yii\base\InvalidArgumentException;
11		use yii\base\InvalidConfigException;
12
13		/**
14		* ActiveRelationTrait implements the common methods and properties for active record relational queries.
15		*
16		* @author Qiang Xue <[email protected]>
17		* @author Carsten Brandt <[email protected]>
18		* @since 2.0
19		*
20		* @method ActiveRecordInterface one()
21		* @method ActiveRecordInterface[] all()
22		* @property ActiveRecord $modelClass
23		*/
24		trait ActiveRelationTrait
25		{
26		/**
27		* @var bool whether this query represents a relation to more than one record.
28		* This property is only used in relational context. If true, this relation will
29		* populate all query results into AR instances using [[Query::all()\|all()]].
30		* If false, only the first row of the results will be retrieved using [[Query::one()\|one()]].
31		*/
32		public $multiple;
33		/**
34		* @var ActiveRecord the primary model of a relational query.
35		* This is used only in lazy loading with dynamic query options.
36		*/
37		public $primaryModel;
38		/**
39		* @var array the columns of the primary and foreign tables that establish a relation.
40		* The array keys must be columns of the table for this relation, and the array values
41		* must be the corresponding columns from the primary table.
42		* Do not prefix or quote the column names as this will be done automatically by Yii.
43		* This property is only used in relational context.
44		*/
45		public $link;
46		/**
47		* @var array\|object the query associated with the junction table. Please call [[via()]]
48		* to set this property instead of directly setting it.
49		* This property is only used in relational context.
50		* @see via()
51		*/
52		public $via;
53		/**
54		* @var string the name of the relation that is the inverse of this relation.
55		* For example, an order has a customer, which means the inverse of the "customer" relation
56		* is the "orders", and the inverse of the "orders" relation is the "customer".
57		* If this property is set, the primary record(s) will be referenced through the specified relation.
58		* For example, `$customer->orders[0]->customer` and `$customer` will be the same object,
59		* and accessing the customer of an order will not trigger new DB query.
60		* This property is only used in relational context.
61		* @see inverseOf()
62		*/
63		public $inverseOf;
64
65		private $viaMap;
66
67		/**
68		* Clones internal objects.
69		*/
70	12	public function __clone()
71		{
72	12	parent::__clone();
73		// make a clone of "via" object so that the same query object can be reused multiple times
74	12	if (is_object($this->via)) {
75		$this->via = clone $this->via;
76	12	} elseif (is_array($this->via)) {
77	6	$this->via = [$this->via[0], clone $this->via[1]];
78		}
79	12	}
80
81		/**
82		* Specifies the relation associated with the junction table.
83		*
84		* Use this method to specify a pivot record/table when declaring a relation in the [[ActiveRecord]] class:
85		*
86		* ```php
87		* class Order extends ActiveRecord
88		* {
89		* public function getOrderItems() {
90		* return $this->hasMany(OrderItem::className(), ['order_id' => 'id']);
91		* }
92		*
93		* public function getItems() {
94		* return $this->hasMany(Item::className(), ['id' => 'item_id'])
95		* ->via('orderItems');
96		* }
97		* }
98		* ```
99		*
100		* @param string $relationName the relation name. This refers to a relation declared in [[primaryModel]].
101		* @param callable $callable a PHP callback for customizing the relation associated with the junction table.
102		* Its signature should be `function($query)`, where `$query` is the query to be customized.
103		* @return $this the relation object itself.
104		*/
105	72	public function via($relationName, callable $callable = null)
106		{
107	72	$relation = $this->primaryModel->getRelation($relationName);
108	72	$this->via = [$relationName, $relation];
109	72	if ($callable !== null) {
110	48	call_user_func($callable, $relation);
111		}
112
113	72	return $this;
114		}
115
116		/**
117		* Sets the name of the relation that is the inverse of this relation.
118		* For example, a customer has orders, which means the inverse of the "orders" relation is the "customer".
119		* If this property is set, the primary record(s) will be referenced through the specified relation.
120		* For example, `$customer->orders[0]->customer` and `$customer` will be the same object,
121		* and accessing the customer of an order will not trigger a new DB query.
122		*
123		* Use this method when declaring a relation in the [[ActiveRecord]] class, e.g. in Customer model:
124		*
125		* ```php
126		* public function getOrders()
127		* {
128		* return $this->hasMany(Order::className(), ['customer_id' => 'id'])->inverseOf('customer');
129		* }
130		* ```
131		*
132		* This also may be used for Order model, but with caution:
133		*
134		* ```php
135		* public function getCustomer()
136		* {
137		* return $this->hasOne(Customer::className(), ['id' => 'customer_id'])->inverseOf('orders');
138		* }
139		* ```
140		*
141		* in this case result will depend on how order(s) was loaded.
142		* Let's suppose customer has several orders. If only one order was loaded:
143		*
144		* ```php
145		* $orders = Order::find()->where(['id' => 1])->all();
146		* $customerOrders = $orders[0]->customer->orders;
147		* ```
148		*
149		* variable `$customerOrders` will contain only one order. If orders was loaded like this:
150		*
151		* ```php
152		* $orders = Order::find()->with('customer')->where(['customer_id' => 1])->all();
153		* $customerOrders = $orders[0]->customer->orders;
154		* ```
155		*
156		* variable `$customerOrders` will contain all orders of the customer.
157		*
158		* @param string $relationName the name of the relation that is the inverse of this relation.
159		* @return $this the relation object itself.
160		*/
161	12	public function inverseOf($relationName)
162		{
163	12	$this->inverseOf = $relationName;
164	12	return $this;
165		}
166
167		/**
168		* Finds the related records for the specified primary record.
169		* This method is invoked when a relation of an ActiveRecord is being accessed in a lazy fashion.
170		* @param string $name the relation name
171		* @param ActiveRecordInterface\|BaseActiveRecord $model the primary model
172		* @return mixed the related record(s)
173		* @throws InvalidArgumentException if the relation is invalid
174		*/
175	73	public function findFor($name, $model)
176		{
177	73	if (method_exists($model, 'get' . $name)) {
178	73	$method = new \ReflectionMethod($model, 'get' . $name);
179	73	$realName = lcfirst(substr($method->getName(), 3));
180	73	if ($realName !== $name) {
181		throw new InvalidArgumentException('Relation names are case sensitive. ' . get_class($model) . " has a relation named \"$realName\" instead of \"$name\".");
182		}
183		}
184
185	73	return $this->multiple ? $this->all() : $this->one();
186		}
187
188		/**
189		* If applicable, populate the query's primary model into the related records' inverse relationship.
190		* @param array $result the array of related records as generated by [[populate()]]
191		* @since 2.0.9
192		*/
193	12	private function addInverseRelations(&$result)
194		{
195	12	if ($this->inverseOf === null) {
196		return;
197		}
198
199	12	foreach ($result as $i => $relatedModel) {
200	12	if ($relatedModel instanceof ActiveRecordInterface) {
201	12	if (!isset($inverseRelation)) {
202	12	$inverseRelation = $relatedModel->getRelation($this->inverseOf);
203		}
204	12	$relatedModel->populateRelation($this->inverseOf, $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel);
205		} else {
206	9	if (!isset($inverseRelation)) {
207		/* @var $modelClass ActiveRecordInterface */
208	9	$modelClass = $this->modelClass;
209	9	$inverseRelation = $modelClass::instance()->getRelation($this->inverseOf);
210		}
211	12	$result[$i][$this->inverseOf] = $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel;
212		}
213		}
214	12	}
215
216		/**
217		* Finds the related records and populates them into the primary models.
218		* @param string $name the relation name
219		* @param array $primaryModels primary models
220		* @return array the related models
221		* @throws InvalidConfigException if [[link]] is invalid
222		*/
223	90	public function populateRelation($name, &$primaryModels)
224		{
225	90	if (!is_array($this->link)) {
226		throw new InvalidConfigException('Invalid link: it must be an array of key-value pairs.');
227		}
228
229	90	if ($this->via instanceof self) {
230		// via junction table
231		/* @var $viaQuery ActiveRelationTrait */
232	9	$viaQuery = $this->via;
233	9	$viaModels = $viaQuery->findJunctionRows($primaryModels);
234	9	$this->filterByModels($viaModels);
235	90	} elseif (is_array($this->via)) {
236		// via relation
237		/* @var $viaQuery ActiveRelationTrait\|ActiveQueryTrait */
238	39	list($viaName, $viaQuery) = $this->via;
239	39	if ($viaQuery->asArray === null) {
240		// inherit asArray from primary query
241	39	$viaQuery->asArray($this->asArray);
242		}
243	39	$viaQuery->primaryModel = null;
244	39	$viaModels = $viaQuery->populateRelation($viaName, $primaryModels);
245	39	$this->filterByModels($viaModels);
246		} else {
247	90	$this->filterByModels($primaryModels);
248		}
249
250	90	if (!$this->multiple && count($primaryModels) === 1) {
251	33	$model = $this->one();
252	33	$primaryModel = reset($primaryModels);
253	33	if ($primaryModel instanceof ActiveRecordInterface) {
254	33	$primaryModel->populateRelation($name, $model);
255		} else {
256	3	$primaryModels[key($primaryModels)][$name] = $model;
257		}
258	33	if ($this->inverseOf !== null) {
259	6	$this->populateInverseRelation($primaryModels, [$model], $name, $this->inverseOf);
260		}
261
262	33	return [$model];
263		}
264
265		// https://github.com/yiisoft/yii2/issues/3197
266		// delay indexing related models after buckets are built
267	69	$indexBy = $this->indexBy;
268	69	$this->indexBy = null;
269	69	$models = $this->all();
270
271	69	if (isset($viaModels, $viaQuery)) {
272	39	$buckets = $this->buildBuckets($models, $this->link, $viaModels, $viaQuery);
273		} else {
274	69	$buckets = $this->buildBuckets($models, $this->link);
275		}
276
277	69	$this->indexBy = $indexBy;
278	69	if ($this->indexBy !== null && $this->multiple) {
279	15	$buckets = $this->indexBuckets($buckets, $this->indexBy);
280		}
281
282	69	$link = array_values($this->link);
283	69	if (isset($viaQuery)) {
284	39	$deepViaQuery = $viaQuery;
285	39	while ($deepViaQuery->via) {
286	3	$deepViaQuery = is_array($deepViaQuery->via) ? $deepViaQuery->via[1] : $deepViaQuery->via;
287		};
288	39	$link = array_values($deepViaQuery->link);
289		}
290	69	foreach ($primaryModels as $i => $primaryModel) {
291	69	if ($this->multiple && count($link) === 1 && is_array($keys = $primaryModel[reset($link)])) {
292		$value = [];
293		foreach ($keys as $key) {
294		$key = $this->normalizeModelKey($key);
295		if (isset($buckets[$key])) {
296		if ($this->indexBy !== null) {
297		// if indexBy is set, array_merge will cause renumbering of numeric array
298		foreach ($buckets[$key] as $bucketKey => $bucketValue) {
299		$value[$bucketKey] = $bucketValue;
300		}
301		} else {
302		$value = array_merge($value, $buckets[$key]);
303		}
304		}
305		}
306		} else {
307	69	$key = $this->getModelKey($primaryModel, $link);
308	69	$value = isset($buckets[$key]) ? $buckets[$key] : ($this->multiple ? [] : null);
309		}
310	69	if ($primaryModel instanceof ActiveRecordInterface) {
311	69	$primaryModel->populateRelation($name, $value);
312		} else {
313	69	$primaryModels[$i][$name] = $value;
314		}
315		}
316	69	if ($this->inverseOf !== null) {
317	6	$this->populateInverseRelation($primaryModels, $models, $name, $this->inverseOf);
318		}
319
320	69	return $models;
321		}
322
323		/**
324		* @param ActiveRecordInterface[] $primaryModels primary models
325		* @param ActiveRecordInterface[] $models models
326		* @param string $primaryName the primary relation name
327		* @param string $name the relation name
328		*/
329	9	private function populateInverseRelation(&$primaryModels, $models, $primaryName, $name)
330		{
331	9	if (empty($models) \|\| empty($primaryModels)) {
332		return;
333		}
334	9	$model = reset($models);
335		/* @var $relation ActiveQueryInterface\|ActiveQuery */
336	9	if ($model instanceof ActiveRecordInterface) {
337	9	$relation = $model->getRelation($name);
338		} else {
339		/* @var $modelClass ActiveRecordInterface */
340	6	$modelClass = $this->modelClass;
341	6	$relation = $modelClass::instance()->getRelation($name);
342		}
343
344	9	if ($relation->multiple) {
345	6	$buckets = $this->buildBuckets($primaryModels, $relation->link, null, null, false);
346	6	if ($model instanceof ActiveRecordInterface) {
347	6	foreach ($models as $model) {
348	6	$key = $this->getModelKey($model, $relation->link);
349	6	$model->populateRelation($name, isset($buckets[$key]) ? $buckets[$key] : []);
350		}
351		} else {
352	3	foreach ($primaryModels as $i => $primaryModel) {
353	3	if ($this->multiple) {
354		foreach ($primaryModel as $j => $m) {
355		$key = $this->getModelKey($m, $relation->link);
356		$primaryModels[$i][$j][$name] = isset($buckets[$key]) ? $buckets[$key] : [];
357		}
358	3	} elseif (!empty($primaryModel[$primaryName])) {
359	3	$key = $this->getModelKey($primaryModel[$primaryName], $relation->link);
360	6	$primaryModels[$i][$primaryName][$name] = isset($buckets[$key]) ? $buckets[$key] : [];
361		}
362		}
363		}
364	6	} elseif ($this->multiple) {
365	6	foreach ($primaryModels as $i => $primaryModel) {
366	6	foreach ($primaryModel[$primaryName] as $j => $m) {
367	6	if ($m instanceof ActiveRecordInterface) {
368	6	$m->populateRelation($name, $primaryModel);
369		} else {
370	6	$primaryModels[$i][$primaryName][$j][$name] = $primaryModel;
371		}
372		}
373		}
374		} else {
375		foreach ($primaryModels as $i => $primaryModel) {
376		if ($primaryModels[$i][$primaryName] instanceof ActiveRecordInterface) {
377		$primaryModels[$i][$primaryName]->populateRelation($name, $primaryModel);
378		} elseif (!empty($primaryModels[$i][$primaryName])) {
379		$primaryModels[$i][$primaryName][$name] = $primaryModel;
380		}
381		}
382		}
383	9	}
384
385		/**
386		* @param array $models
387		* @param array $link
388		* @param array $viaModels
389		* @param null\|self $viaQuery
390		* @param bool $checkMultiple
391		* @return array
392		*/
393	72	private function buildBuckets($models, $link, $viaModels = null, $viaQuery = null, $checkMultiple = true)
394		{
395	72	if ($viaModels !== null) {
396	39	$map = [];
397	39	$viaLink = $viaQuery->link;
398	39	$viaLinkKeys = array_keys($viaLink);
399	39	$linkValues = array_values($link);
400	39	foreach ($viaModels as $viaModel) {
401	39	$key1 = $this->getModelKey($viaModel, $viaLinkKeys);
402	39	$key2 = $this->getModelKey($viaModel, $linkValues);
403	39	$map[$key2][$key1] = true;
404		}
405
406	39	$viaQuery->viaMap = $map;
407
408	39	$viaVia = $viaQuery->via;
409	39	while ($viaVia) {
410	3	$viaViaQuery = is_array($viaVia) ? $viaVia[1] : $viaVia;
411	3	$map = $this->mapVia($map, $viaViaQuery->viaMap);
412
413	3	$viaVia = $viaViaQuery->via;
414		};
415		}
416
417	72	$buckets = [];
418	72	$linkKeys = array_keys($link);
419
420	72	if (isset($map)) {
421	39	foreach ($models as $model) {
422	39	$key = $this->getModelKey($model, $linkKeys);
423	39	if (isset($map[$key])) {
424	39	foreach (array_keys($map[$key]) as $key2) {
425	39	$buckets[$key2][] = $model;
426		}
427		}
428		}
429		} else {
430	72	foreach ($models as $model) {
431	72	$key = $this->getModelKey($model, $linkKeys);
432	72	$buckets[$key][] = $model;
433		}
434		}
435
436	72	if ($checkMultiple && !$this->multiple) {
437	21	foreach ($buckets as $i => $bucket) {
438	21	$buckets[$i] = reset($bucket);
439		}
440		}
441
442	72	return $buckets;
443		}
444
445		/**
446		* @param array $map
447		* @param array $viaMap
448		* @return array
449		*/
450	3	private function mapVia($map, $viaMap) {
451	3	$resultMap = [];
452	3	foreach ($map as $key => $linkKeys) {
453	3	foreach (array_keys($linkKeys) as $linkKey) {
454	3	$resultMap[$key] = $viaMap[$linkKey];
455		}
456		}
457	3	return $resultMap;
458		}
459
460		/**
461		* Indexes buckets by column name.
462		*
463		* @param array $buckets
464		* @param string\|callable $indexBy the name of the column by which the query results should be indexed by.
465		* This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data.
466		* @return array
467		*/
468	15	private function indexBuckets($buckets, $indexBy)
469		{
470	15	$result = [];
471	15	foreach ($buckets as $key => $models) {
472	15	$result[$key] = [];
473	15	foreach ($models as $model) {
474	15	$index = is_string($indexBy) ? $model[$indexBy] : call_user_func($indexBy, $model);
475	15	$result[$key][$index] = $model;
476		}
477		}
478
479	15	return $result;
480		}
481
482		/**
483		* @param array $attributes the attributes to prefix
484		* @return array
485		*/
486	175	private function prefixKeyColumns($attributes)
487		{
488	175	if ($this instanceof ActiveQuery && (!empty($this->join) \|\| !empty($this->joinWith))) {
489	27	if (empty($this->from)) {
490		/* @var $modelClass ActiveRecord */
491	6	$modelClass = $this->modelClass;
492	6	$alias = $modelClass::tableName();
493		} else {
494	27	foreach ($this->from as $alias => $table) {
495	27	if (!is_string($alias)) {
496	27	$alias = $table;
497		}
498	27	break;
499		}
500		}
501	27	if (isset($alias)) {
502	27	foreach ($attributes as $i => $attribute) {
503	27	$attributes[$i] = "$alias.$attribute";
504		}
505		}
506		}
507
508	175	return $attributes;
509		}
510
511		/**
512		* @param array $models
513		*/
514	175	private function filterByModels($models)
515		{
516	175	$attributes = array_keys($this->link);
517
518	175	$attributes = $this->prefixKeyColumns($attributes);
519
520	175	$values = [];
521	175	if (count($attributes) === 1) {
522		// single key
523	172	$attribute = reset($this->link);
524	172	foreach ($models as $model) {
525	172	if (($value = $model[$attribute]) !== null) {
526	169	if (is_array($value)) {
527		$values = array_merge($values, $value);
528	169	} elseif ($value instanceof ArrayExpression && $value->getDimension() === 1) {
529		$values = array_merge($values, $value->getValue());
530		} else {
531	172	$values[] = $value;
532		}
533		}
534		}
535	172	if (empty($values)) {
536	172	$this->emulateExecution();
537		}
538		} else {
539		// composite keys
540
541		// ensure keys of $this->link are prefixed the same way as $attributes
542	6	$prefixedLink = array_combine($attributes, $this->link);
543	6	foreach ($models as $model) {
544	6	$v = [];
545	6	foreach ($prefixedLink as $attribute => $link) {
546	6	$v[$attribute] = $model[$link];
547		}
548	6	$values[] = $v;
549	6	if (empty($v)) {
550	6	$this->emulateExecution();
551		}
552		}
553		}
554	175	$this->andWhere(['in', $attributes, array_unique($values, SORT_REGULAR)]);
		0 ignored issues – show Bug introduced 2015-11-20 21:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `andWhere()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
555	175	}
556
557		/**
558		* @param ActiveRecordInterface\|array $model
559		* @param array $attributes
560		* @return string
561		*/
562	72	private function getModelKey($model, $attributes)
563		{
564	72	$key = [];
565	72	foreach ($attributes as $attribute) {
566	72	$key[] = $this->normalizeModelKey($model[$attribute]);
567		}
568	72	if (count($key) > 1) {
569		return serialize($key);
570		}
571	72	$key = reset($key);
572	72	return is_scalar($key) ? $key : serialize($key);
573		}
574
575		/**
576		* @param mixed $value raw key value.
577		* @return string normalized key value.
578		*/
579	72	private function normalizeModelKey($value)
580		{
581	72	if (is_object($value) && method_exists($value, '__toString')) {
582		// ensure matching to special objects, which are convertable to string, for cross-DBMS relations, for example: `\|MongoId`
583		$value = $value->__toString();
584		}
585
586	72	return $value;
587		}
588
589		/**
590		* @param array $primaryModels either array of AR instances or arrays
591		* @return array
592		*/
593	21	private function findJunctionRows($primaryModels)
594		{
595	21	if (empty($primaryModels)) {
596		return [];
597		}
598	21	$this->filterByModels($primaryModels);
599		/* @var $primaryModel ActiveRecord */
600	21	$primaryModel = reset($primaryModels);
601	21	if (!$primaryModel instanceof ActiveRecordInterface) {
602		// when primaryModels are array of arrays (asArray case)
603		$primaryModel = $this->modelClass;
604		}
605
606	21	return $this->asArray()->all($primaryModel::getDb());
607		}
608		}
609

yiisoft / yii2

Push — master ( 63faf5...4333b9 )

framework/db/ActiveRelationTrait.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like