123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284 |
- <?php
-
- namespace Illuminate\Database\Eloquent\Relations;
-
- use BadMethodCallException;
- use Illuminate\Database\Eloquent\Model;
- use Illuminate\Database\Eloquent\Builder;
- use Illuminate\Database\Eloquent\Collection;
-
- /**
- * @mixin \Illuminate\Database\Eloquent\Builder
- */
- class MorphTo extends BelongsTo
- {
- /**
- * The type of the polymorphic relation.
- *
- * @var string
- */
- protected $morphType;
-
- /**
- * The models whose relations are being eager loaded.
- *
- * @var \Illuminate\Database\Eloquent\Collection
- */
- protected $models;
-
- /**
- * All of the models keyed by ID.
- *
- * @var array
- */
- protected $dictionary = [];
-
- /**
- * A buffer of dynamic calls to query macros.
- *
- * @var array
- */
- protected $macroBuffer = [];
-
- /**
- * Create a new morph to relationship instance.
- *
- * @param \Illuminate\Database\Eloquent\Builder $query
- * @param \Illuminate\Database\Eloquent\Model $parent
- * @param string $foreignKey
- * @param string $ownerKey
- * @param string $type
- * @param string $relation
- * @return void
- */
- public function __construct(Builder $query, Model $parent, $foreignKey, $ownerKey, $type, $relation)
- {
- $this->morphType = $type;
-
- parent::__construct($query, $parent, $foreignKey, $ownerKey, $relation);
- }
-
- /**
- * Set the constraints for an eager load of the relation.
- *
- * @param array $models
- * @return void
- */
- public function addEagerConstraints(array $models)
- {
- $this->buildDictionary($this->models = Collection::make($models));
- }
-
- /**
- * Build a dictionary with the models.
- *
- * @param \Illuminate\Database\Eloquent\Collection $models
- * @return void
- */
- protected function buildDictionary(Collection $models)
- {
- foreach ($models as $model) {
- if ($model->{$this->morphType}) {
- $this->dictionary[$model->{$this->morphType}][$model->{$this->foreignKey}][] = $model;
- }
- }
- }
-
- /**
- * Get the results of the relationship.
- *
- * @return mixed
- */
- public function getResults()
- {
- return $this->ownerKey ? parent::getResults() : null;
- }
-
- /**
- * Get the results of the relationship.
- *
- * Called via eager load method of Eloquent query builder.
- *
- * @return mixed
- */
- public function getEager()
- {
- foreach (array_keys($this->dictionary) as $type) {
- $this->matchToMorphParents($type, $this->getResultsByType($type));
- }
-
- return $this->models;
- }
-
- /**
- * Get all of the relation results for a type.
- *
- * @param string $type
- * @return \Illuminate\Database\Eloquent\Collection
- */
- protected function getResultsByType($type)
- {
- $instance = $this->createModelByType($type);
-
- $ownerKey = $this->ownerKey ?? $instance->getKeyName();
-
- $query = $this->replayMacros($instance->newQuery())
- ->mergeConstraintsFrom($this->getQuery())
- ->with($this->getQuery()->getEagerLoads());
-
- return $query->whereIn(
- $instance->getTable().'.'.$ownerKey, $this->gatherKeysByType($type)
- )->get();
- }
-
- /**
- * Gather all of the foreign keys for a given type.
- *
- * @param string $type
- * @return array
- */
- protected function gatherKeysByType($type)
- {
- return collect($this->dictionary[$type])->map(function ($models) {
- return head($models)->{$this->foreignKey};
- })->values()->unique()->all();
- }
-
- /**
- * Create a new model instance by type.
- *
- * @param string $type
- * @return \Illuminate\Database\Eloquent\Model
- */
- public function createModelByType($type)
- {
- $class = Model::getActualClassNameForMorph($type);
-
- return new $class;
- }
-
- /**
- * Match the eagerly loaded results to their parents.
- *
- * @param array $models
- * @param \Illuminate\Database\Eloquent\Collection $results
- * @param string $relation
- * @return array
- */
- public function match(array $models, Collection $results, $relation)
- {
- return $models;
- }
-
- /**
- * Match the results for a given type to their parents.
- *
- * @param string $type
- * @param \Illuminate\Database\Eloquent\Collection $results
- * @return void
- */
- protected function matchToMorphParents($type, Collection $results)
- {
- foreach ($results as $result) {
- $ownerKey = ! is_null($this->ownerKey) ? $result->{$this->ownerKey} : $result->getKey();
-
- if (isset($this->dictionary[$type][$ownerKey])) {
- foreach ($this->dictionary[$type][$ownerKey] as $model) {
- $model->setRelation($this->relation, $result);
- }
- }
- }
- }
-
- /**
- * Associate the model instance to the given parent.
- *
- * @param \Illuminate\Database\Eloquent\Model $model
- * @return \Illuminate\Database\Eloquent\Model
- */
- public function associate($model)
- {
- $this->parent->setAttribute(
- $this->foreignKey, $model instanceof Model ? $model->getKey() : null
- );
-
- $this->parent->setAttribute(
- $this->morphType, $model instanceof Model ? $model->getMorphClass() : null
- );
-
- return $this->parent->setRelation($this->relation, $model);
- }
-
- /**
- * Dissociate previously associated model from the given parent.
- *
- * @return \Illuminate\Database\Eloquent\Model
- */
- public function dissociate()
- {
- $this->parent->setAttribute($this->foreignKey, null);
-
- $this->parent->setAttribute($this->morphType, null);
-
- return $this->parent->setRelation($this->relation, null);
- }
-
- /**
- * Get the foreign key "type" name.
- *
- * @return string
- */
- public function getMorphType()
- {
- return $this->morphType;
- }
-
- /**
- * Get the dictionary used by the relationship.
- *
- * @return array
- */
- public function getDictionary()
- {
- return $this->dictionary;
- }
-
- /**
- * Replay stored macro calls on the actual related instance.
- *
- * @param \Illuminate\Database\Eloquent\Builder $query
- * @return \Illuminate\Database\Eloquent\Builder
- */
- protected function replayMacros(Builder $query)
- {
- foreach ($this->macroBuffer as $macro) {
- $query->{$macro['method']}(...$macro['parameters']);
- }
-
- return $query;
- }
-
- /**
- * Handle dynamic method calls to the relationship.
- *
- * @param string $method
- * @param array $parameters
- * @return mixed
- */
- public function __call($method, $parameters)
- {
- try {
- return parent::__call($method, $parameters);
- }
-
- // If we tried to call a method that does not exist on the parent Builder instance,
- // we'll assume that we want to call a query macro (e.g. withTrashed) that only
- // exists on related models. We will just store the call and replay it later.
- catch (BadMethodCallException $e) {
- $this->macroBuffer[] = compact('method', 'parameters');
-
- return $this;
- }
- }
- }
|