123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557 |
- <?php
-
- namespace Illuminate\Database\Eloquent\Relations;
-
- use Illuminate\Database\Eloquent\Model;
- use Illuminate\Database\Eloquent\Builder;
- use Illuminate\Database\Eloquent\Collection;
- use Illuminate\Database\Eloquent\SoftDeletes;
- use Illuminate\Database\Eloquent\ModelNotFoundException;
-
- class HasManyThrough extends Relation
- {
- /**
- * The "through" parent model instance.
- *
- * @var \Illuminate\Database\Eloquent\Model
- */
- protected $throughParent;
-
- /**
- * The far parent model instance.
- *
- * @var \Illuminate\Database\Eloquent\Model
- */
- protected $farParent;
-
- /**
- * The near key on the relationship.
- *
- * @var string
- */
- protected $firstKey;
-
- /**
- * The far key on the relationship.
- *
- * @var string
- */
- protected $secondKey;
-
- /**
- * The local key on the relationship.
- *
- * @var string
- */
- protected $localKey;
-
- /**
- * The local key on the intermediary model.
- *
- * @var string
- */
- protected $secondLocalKey;
-
- /**
- * The count of self joins.
- *
- * @var int
- */
- protected static $selfJoinCount = 0;
-
- /**
- * Create a new has many through relationship instance.
- *
- * @param \Illuminate\Database\Eloquent\Builder $query
- * @param \Illuminate\Database\Eloquent\Model $farParent
- * @param \Illuminate\Database\Eloquent\Model $throughParent
- * @param string $firstKey
- * @param string $secondKey
- * @param string $localKey
- * @param string $secondLocalKey
- * @return void
- */
- public function __construct(Builder $query, Model $farParent, Model $throughParent, $firstKey, $secondKey, $localKey, $secondLocalKey)
- {
- $this->localKey = $localKey;
- $this->firstKey = $firstKey;
- $this->secondKey = $secondKey;
- $this->farParent = $farParent;
- $this->throughParent = $throughParent;
- $this->secondLocalKey = $secondLocalKey;
-
- parent::__construct($query, $throughParent);
- }
-
- /**
- * Set the base constraints on the relation query.
- *
- * @return void
- */
- public function addConstraints()
- {
- $localValue = $this->farParent[$this->localKey];
-
- $this->performJoin();
-
- if (static::$constraints) {
- $this->query->where($this->getQualifiedFirstKeyName(), '=', $localValue);
- }
- }
-
- /**
- * Set the join clause on the query.
- *
- * @param \Illuminate\Database\Eloquent\Builder|null $query
- * @return void
- */
- protected function performJoin(Builder $query = null)
- {
- $query = $query ?: $this->query;
-
- $farKey = $this->getQualifiedFarKeyName();
-
- $query->join($this->throughParent->getTable(), $this->getQualifiedParentKeyName(), '=', $farKey);
-
- if ($this->throughParentSoftDeletes()) {
- $query->whereNull($this->throughParent->getQualifiedDeletedAtColumn());
- }
- }
-
- /**
- * Get the fully qualified parent key name.
- *
- * @return string
- */
- public function getQualifiedParentKeyName()
- {
- return $this->parent->qualifyColumn($this->secondLocalKey);
- }
-
- /**
- * Determine whether "through" parent of the relation uses Soft Deletes.
- *
- * @return bool
- */
- public function throughParentSoftDeletes()
- {
- return in_array(SoftDeletes::class, class_uses_recursive(
- get_class($this->throughParent)
- ));
- }
-
- /**
- * Set the constraints for an eager load of the relation.
- *
- * @param array $models
- * @return void
- */
- public function addEagerConstraints(array $models)
- {
- $this->query->whereIn(
- $this->getQualifiedFirstKeyName(), $this->getKeys($models, $this->localKey)
- );
- }
-
- /**
- * Initialize the relation on a set of models.
- *
- * @param array $models
- * @param string $relation
- * @return array
- */
- public function initRelation(array $models, $relation)
- {
- foreach ($models as $model) {
- $model->setRelation($relation, $this->related->newCollection());
- }
-
- return $models;
- }
-
- /**
- * 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)
- {
- $dictionary = $this->buildDictionary($results);
-
- // Once we have the dictionary we can simply spin through the parent models to
- // link them up with their children using the keyed dictionary to make the
- // matching very convenient and easy work. Then we'll just return them.
- foreach ($models as $model) {
- if (isset($dictionary[$key = $model->getAttribute($this->localKey)])) {
- $model->setRelation(
- $relation, $this->related->newCollection($dictionary[$key])
- );
- }
- }
-
- return $models;
- }
-
- /**
- * Build model dictionary keyed by the relation's foreign key.
- *
- * @param \Illuminate\Database\Eloquent\Collection $results
- * @return array
- */
- protected function buildDictionary(Collection $results)
- {
- $dictionary = [];
-
- // First we will create a dictionary of models keyed by the foreign key of the
- // relationship as this will allow us to quickly access all of the related
- // models without having to do nested looping which will be quite slow.
- foreach ($results as $result) {
- $dictionary[$result->{$this->firstKey}][] = $result;
- }
-
- return $dictionary;
- }
-
- /**
- * Get the first related model record matching the attributes or instantiate it.
- *
- * @param array $attributes
- * @return \Illuminate\Database\Eloquent\Model
- */
- public function firstOrNew(array $attributes)
- {
- if (is_null($instance = $this->where($attributes)->first())) {
- $instance = $this->related->newInstance($attributes);
- }
-
- return $instance;
- }
-
- /**
- * Create or update a related record matching the attributes, and fill it with values.
- *
- * @param array $attributes
- * @param array $values
- * @return \Illuminate\Database\Eloquent\Model
- */
- public function updateOrCreate(array $attributes, array $values = [])
- {
- $instance = $this->firstOrNew($attributes);
-
- $instance->fill($values)->save();
-
- return $instance;
- }
-
- /**
- * Execute the query and get the first related model.
- *
- * @param array $columns
- * @return mixed
- */
- public function first($columns = ['*'])
- {
- $results = $this->take(1)->get($columns);
-
- return count($results) > 0 ? $results->first() : null;
- }
-
- /**
- * Execute the query and get the first result or throw an exception.
- *
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Model|static
- *
- * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
- */
- public function firstOrFail($columns = ['*'])
- {
- if (! is_null($model = $this->first($columns))) {
- return $model;
- }
-
- throw (new ModelNotFoundException)->setModel(get_class($this->related));
- }
-
- /**
- * Find a related model by its primary key.
- *
- * @param mixed $id
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|null
- */
- public function find($id, $columns = ['*'])
- {
- if (is_array($id)) {
- return $this->findMany($id, $columns);
- }
-
- return $this->where(
- $this->getRelated()->getQualifiedKeyName(), '=', $id
- )->first($columns);
- }
-
- /**
- * Find multiple related models by their primary keys.
- *
- * @param mixed $ids
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Collection
- */
- public function findMany($ids, $columns = ['*'])
- {
- if (empty($ids)) {
- return $this->getRelated()->newCollection();
- }
-
- return $this->whereIn(
- $this->getRelated()->getQualifiedKeyName(), $ids
- )->get($columns);
- }
-
- /**
- * Find a related model by its primary key or throw an exception.
- *
- * @param mixed $id
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection
- *
- * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
- */
- public function findOrFail($id, $columns = ['*'])
- {
- $result = $this->find($id, $columns);
-
- if (is_array($id)) {
- if (count($result) === count(array_unique($id))) {
- return $result;
- }
- } elseif (! is_null($result)) {
- return $result;
- }
-
- throw (new ModelNotFoundException)->setModel(get_class($this->related));
- }
-
- /**
- * Get the results of the relationship.
- *
- * @return mixed
- */
- public function getResults()
- {
- return $this->get();
- }
-
- /**
- * Execute the query as a "select" statement.
- *
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Collection
- */
- public function get($columns = ['*'])
- {
- $builder = $this->prepareQueryBuilder($columns);
-
- $models = $builder->getModels();
-
- // If we actually found models we will also eager load any relationships that
- // have been specified as needing to be eager loaded. This will solve the
- // n + 1 query problem for the developer and also increase performance.
- if (count($models) > 0) {
- $models = $builder->eagerLoadRelations($models);
- }
-
- return $this->related->newCollection($models);
- }
-
- /**
- * Get a paginator for the "select" statement.
- *
- * @param int $perPage
- * @param array $columns
- * @param string $pageName
- * @param int $page
- * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
- */
- public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
- {
- $this->query->addSelect($this->shouldSelect($columns));
-
- return $this->query->paginate($perPage, $columns, $pageName, $page);
- }
-
- /**
- * Paginate the given query into a simple paginator.
- *
- * @param int $perPage
- * @param array $columns
- * @param string $pageName
- * @param int|null $page
- * @return \Illuminate\Contracts\Pagination\Paginator
- */
- public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
- {
- $this->query->addSelect($this->shouldSelect($columns));
-
- return $this->query->simplePaginate($perPage, $columns, $pageName, $page);
- }
-
- /**
- * Set the select clause for the relation query.
- *
- * @param array $columns
- * @return array
- */
- protected function shouldSelect(array $columns = ['*'])
- {
- if ($columns == ['*']) {
- $columns = [$this->related->getTable().'.*'];
- }
-
- return array_merge($columns, [$this->getQualifiedFirstKeyName()]);
- }
-
- /**
- * Chunk the results of the query.
- *
- * @param int $count
- * @param callable $callback
- * @return bool
- */
- public function chunk($count, callable $callback)
- {
- return $this->prepareQueryBuilder()->chunk($count, $callback);
- }
-
- /**
- * Execute a callback over each item while chunking.
- *
- * @param callable $callback
- * @param int $count
- * @return bool
- */
- public function each(callable $callback, $count = 1000)
- {
- return $this->chunk($count, function ($results) use ($callback) {
- foreach ($results as $key => $value) {
- if ($callback($value, $key) === false) {
- return false;
- }
- }
- });
- }
-
- /**
- * Prepare the query builder for query execution.
- *
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Builder
- */
- protected function prepareQueryBuilder($columns = ['*'])
- {
- return $this->query->applyScopes()->addSelect(
- $this->shouldSelect($this->query->getQuery()->columns ? [] : $columns)
- );
- }
-
- /**
- * Add the constraints for a relationship query.
- *
- * @param \Illuminate\Database\Eloquent\Builder $query
- * @param \Illuminate\Database\Eloquent\Builder $parentQuery
- * @param array|mixed $columns
- * @return \Illuminate\Database\Eloquent\Builder
- */
- public function getRelationExistenceQuery(Builder $query, Builder $parentQuery, $columns = ['*'])
- {
- if ($parentQuery->getQuery()->from == $query->getQuery()->from) {
- return $this->getRelationExistenceQueryForSelfRelation($query, $parentQuery, $columns);
- }
-
- $this->performJoin($query);
-
- return $query->select($columns)->whereColumn(
- $this->getQualifiedLocalKeyName(), '=', $this->getQualifiedFirstKeyName()
- );
- }
-
- /**
- * Add the constraints for a relationship query on the same table.
- *
- * @param \Illuminate\Database\Eloquent\Builder $query
- * @param \Illuminate\Database\Eloquent\Builder $parentQuery
- * @param array|mixed $columns
- * @return \Illuminate\Database\Eloquent\Builder
- */
- public function getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, $columns = ['*'])
- {
- $query->from($query->getModel()->getTable().' as '.$hash = $this->getRelationCountHash());
-
- $query->join($this->throughParent->getTable(), $this->getQualifiedParentKeyName(), '=', $hash.'.'.$this->secondLocalKey);
-
- if ($this->throughParentSoftDeletes()) {
- $query->whereNull($this->throughParent->getQualifiedDeletedAtColumn());
- }
-
- $query->getModel()->setTable($hash);
-
- return $query->select($columns)->whereColumn(
- $parentQuery->getQuery()->from.'.'.$query->getModel()->getKeyName(), '=', $this->getQualifiedFirstKeyName()
- );
- }
-
- /**
- * Get a relationship join table hash.
- *
- * @return string
- */
- public function getRelationCountHash()
- {
- return 'laravel_reserved_'.static::$selfJoinCount++;
- }
-
- /**
- * Get the qualified foreign key on the related model.
- *
- * @return string
- */
- public function getQualifiedFarKeyName()
- {
- return $this->getQualifiedForeignKeyName();
- }
-
- /**
- * Get the qualified foreign key on the "through" model.
- *
- * @return string
- */
- public function getQualifiedFirstKeyName()
- {
- return $this->throughParent->qualifyColumn($this->firstKey);
- }
-
- /**
- * Get the qualified foreign key on the related model.
- *
- * @return string
- */
- public function getQualifiedForeignKeyName()
- {
- return $this->related->qualifyColumn($this->secondKey);
- }
-
- /**
- * Get the qualified local key on the far parent model.
- *
- * @return string
- */
- public function getQualifiedLocalKeyName()
- {
- return $this->farParent->qualifyColumn($this->localKey);
- }
- }
|