123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737 |
- <?php namespace Illuminate\Database\Eloquent;
- use Closure;
- use DateTime;
- use Illuminate\Database\Query\Expression;
- use Illuminate\Database\Eloquent\Relations\Relation;
- use Illuminate\Database\Query\Builder as QueryBuilder;
- class Builder {
- /**
- * The base query builder instance.
- *
- * @var \Illuminate\Database\Query\Builder
- */
- protected $query;
- /**
- * The model being queried.
- *
- * @var \Illuminate\Database\Eloquent\Model
- */
- protected $model;
- /**
- * The relationships that should be eager loaded.
- *
- * @var array
- */
- protected $eagerLoad = array();
- /**
- * The methods that should be returned from query builder.
- *
- * @var array
- */
- protected $passthru = array(
- 'toSql', 'lists', 'insert', 'insertGetId', 'pluck',
- 'count', 'min', 'max', 'avg', 'sum', 'exists',
- );
- /**
- * Create a new Eloquent query builder instance.
- *
- * @param \Illuminate\Database\Query\Builder $query
- * @return void
- */
- public function __construct(QueryBuilder $query)
- {
- $this->query = $query;
- }
- /**
- * Find a model by its primary key.
- *
- * @param mixed $id
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Model|static|null
- */
- public function find($id, $columns = array('*'))
- {
- $this->query->where($this->model->getKeyName(), '=', $id);
- return $this->first($columns);
- }
- /**
- * Find a model by its primary key or throw an exception.
- *
- * @param mixed $id
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Model|static
- */
- public function findOrFail($id, $columns = array('*'))
- {
- if ( ! is_null($model = $this->find($id, $columns))) return $model;
- throw new ModelNotFoundException;
- }
- /**
- * Execute the query and get the first result.
- *
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Model|static|null
- */
- public function first($columns = array('*'))
- {
- return $this->take(1)->get($columns)->first();
- }
- /**
- * Execute the query and get the first result or throw an exception.
- *
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Model|static
- */
- public function firstOrFail($columns = array('*'))
- {
- if ( ! is_null($model = $this->first($columns))) return $model;
- throw new ModelNotFoundException;
- }
- /**
- * Execute the query as a "select" statement.
- *
- * @param array $columns
- * @return \Illuminate\Database\Eloquent\Collection|static[]
- */
- public function get($columns = array('*'))
- {
- $models = $this->getModels($columns);
- // If we actually found models we will also eager load any relationships that
- // have been specified as needing to be eager loaded, which will solve the
- // n+1 query issue for the developers to avoid running a lot of queries.
- if (count($models) > 0)
- {
- $models = $this->eagerLoadRelations($models);
- }
- return $this->model->newCollection($models);
- }
- /**
- * Pluck a single column from the database.
- *
- * @param string $column
- * @return mixed
- */
- public function pluck($column)
- {
- $result = $this->first(array($column));
- if ($result) return $result->{$column};
- }
- /**
- * Get an array with the values of a given column.
- *
- * @param string $column
- * @param string $key
- * @return array
- */
- public function lists($column, $key = null)
- {
- $results = $this->query->lists($column, $key);
- // If the model has a mutator for the requested column, we will spin through
- // the results and mutate the values so that the mutated version of these
- // columns are returned as you would expect from these Eloquent models.
- if ($this->model->hasGetMutator($column))
- {
- foreach ($results as $key => &$value)
- {
- $fill = array($column => $value);
- $value = $this->model->newFromBuilder($fill)->$column;
- }
- }
- return $results;
- }
- /**
- * Get a paginator for the "select" statement.
- *
- * @param int $perPage
- * @param array $columns
- * @return \Illuminate\Pagination\Paginator
- */
- public function paginate($perPage = null, $columns = array('*'))
- {
- $perPage = $perPage ?: $this->model->getPerPage();
- $paginator = $this->query->getConnection()->getPaginator();
- if (isset($this->query->groups))
- {
- return $this->groupedPaginate($paginator, $perPage, $columns);
- }
- else
- {
- return $this->ungroupedPaginate($paginator, $perPage, $columns);
- }
- }
- /**
- * Get a paginator for a grouped statement.
- *
- * @param \Illuminate\Pagination\Environment $paginator
- * @param int $perPage
- * @param array $columns
- * @return \Illuminate\Pagination\Paginator
- */
- protected function groupedPaginate($paginator, $perPage, $columns)
- {
- $results = $this->get($columns)->all();
- return $this->query->buildRawPaginator($paginator, $results, $perPage);
- }
- /**
- * Get a paginator for an ungrouped statement.
- *
- * @param \Illuminate\Pagination\Environment $paginator
- * @param int $perPage
- * @param array $columns
- * @return \Illuminate\Pagination\Paginator
- */
- protected function ungroupedPaginate($paginator, $perPage, $columns)
- {
- $total = $this->query->getPaginationCount();
- // Once we have the paginator we need to set the limit and offset values for
- // the query so we can get the properly paginated items. Once we have an
- // array of items we can create the paginator instances for the items.
- $page = $paginator->getCurrentPage();
- $this->query->forPage($page, $perPage);
- return $paginator->make($this->get($columns)->all(), $total, $perPage);
- }
- /**
- * Update a record in the database.
- *
- * @param array $values
- * @return int
- */
- public function update(array $values)
- {
- return $this->query->update($this->addUpdatedAtColumn($values));
- }
- /**
- * Increment a column's value by a given amount.
- *
- * @param string $column
- * @param int $amount
- * @param array $extra
- * @return int
- */
- public function increment($column, $amount = 1, array $extra = array())
- {
- $extra = $this->addUpdatedAtColumn($extra);
- return $this->query->increment($column, $amount, $extra);
- }
- /**
- * Decrement a column's value by a given amount.
- *
- * @param string $column
- * @param int $amount
- * @param array $extra
- * @return int
- */
- public function decrement($column, $amount = 1, array $extra = array())
- {
- $extra = $this->addUpdatedAtColumn($extra);
- return $this->query->decrement($column, $amount, $extra);
- }
- /**
- * Add the "updated at" column to an array of values.
- *
- * @param array $values
- * @return array
- */
- protected function addUpdatedAtColumn(array $values)
- {
- if ( ! $this->model->usesTimestamps()) return $values;
- $column = $this->model->getUpdatedAtColumn();
- return array_add($values, $column, $this->model->freshTimestampString());
- }
- /**
- * Delete a record from the database.
- *
- * @return int
- */
- public function delete()
- {
- if ($this->model->isSoftDeleting())
- {
- return $this->softDelete();
- }
- else
- {
- return $this->query->delete();
- }
- }
- /**
- * Soft delete the record in the database.
- *
- * @return int
- */
- protected function softDelete()
- {
- $column = $this->model->getDeletedAtColumn();
- return $this->update(array($column => $this->model->freshTimestampString()));
- }
- /**
- * Force a delete on a set of soft deleted models.
- *
- * @return int
- */
- public function forceDelete()
- {
- return $this->query->delete();
- }
- /**
- * Restore the soft-deleted model instances.
- *
- * @return int
- */
- public function restore()
- {
- if ($this->model->isSoftDeleting())
- {
- $column = $this->model->getDeletedAtColumn();
- return $this->update(array($column => null));
- }
- }
- /**
- * Include the soft deleted models in the results.
- *
- * @return \Illuminate\Database\Eloquent\Builder|static
- */
- public function withTrashed()
- {
- $column = $this->model->getQualifiedDeletedAtColumn();
- foreach ($this->query->wheres as $key => $where)
- {
- // If the where clause is a soft delete date constraint, we will remove it from
- // the query and reset the keys on the wheres. This allows this developer to
- // include deleted model in a relationship result set that is lazy loaded.
- if ($this->isSoftDeleteConstraint($where, $column))
- {
- unset($this->query->wheres[$key]);
- $this->query->wheres = array_values($this->query->wheres);
- }
- }
- return $this;
- }
- /**
- * Force the result set to only included soft deletes.
- *
- * @return \Illuminate\Database\Eloquent\Builder|static
- */
- public function onlyTrashed()
- {
- $this->withTrashed();
- $this->query->whereNotNull($this->model->getQualifiedDeletedAtColumn());
- return $this;
- }
- /**
- * Determine if the given where clause is a soft delete constraint.
- *
- * @param array $where
- * @param string $column
- * @return bool
- */
- protected function isSoftDeleteConstraint(array $where, $column)
- {
- return $where['column'] == $column and $where['type'] == 'Null';
- }
- /**
- * Get the hydrated models without eager loading.
- *
- * @param array $columns
- * @return array|static[]
- */
- public function getModels($columns = array('*'))
- {
- // First, we will simply get the raw results from the query builders which we
- // can use to populate an array with Eloquent models. We will pass columns
- // that should be selected as well, which are typically just everything.
- $results = $this->query->get($columns);
- $connection = $this->model->getConnectionName();
- $models = array();
- // Once we have the results, we can spin through them and instantiate a fresh
- // model instance for each records we retrieved from the database. We will
- // also set the proper connection name for the model after we create it.
- foreach ($results as $result)
- {
- $models[] = $model = $this->model->newFromBuilder($result);
- $model->setConnection($connection);
- }
- return $models;
- }
- /**
- * Eager load the relationships for the models.
- *
- * @param array $models
- * @return array
- */
- public function eagerLoadRelations(array $models)
- {
- foreach ($this->eagerLoad as $name => $constraints)
- {
- // For nested eager loads we'll skip loading them here and they will be set as an
- // eager load on the query to retrieve the relation so that they will be eager
- // loaded on that query, because that is where they get hydrated as models.
- if (strpos($name, '.') === false)
- {
- $models = $this->loadRelation($models, $name, $constraints);
- }
- }
- return $models;
- }
- /**
- * Eagerly load the relationship on a set of models.
- *
- * @param array $models
- * @param string $name
- * @param \Closure $constraints
- * @return array
- */
- protected function loadRelation(array $models, $name, Closure $constraints)
- {
- // First we will "back up" the existing where conditions on the query so we can
- // add our eager constraints. Then we will merge the wheres that were on the
- // query back to it in order that any where conditions might be specified.
- $relation = $this->getRelation($name);
- $relation->addEagerConstraints($models);
- call_user_func($constraints, $relation);
- $models = $relation->initRelation($models, $name);
- // Once we have the results, we just match those back up to their parent models
- // using the relationship instance. Then we just return the finished arrays
- // of models which have been eagerly hydrated and are readied for return.
- $results = $relation->get();
- return $relation->match($models, $results, $name);
- }
- /**
- * Get the relation instance for the given relation name.
- *
- * @param string $relation
- * @return \Illuminate\Database\Eloquent\Relations\Relation
- */
- public function getRelation($relation)
- {
- $me = $this;
- // We want to run a relationship query without any constrains so that we will
- // not have to remove these where clauses manually which gets really hacky
- // and is error prone while we remove the developer's own where clauses.
- $query = Relation::noConstraints(function() use ($me, $relation)
- {
- return $me->getModel()->$relation();
- });
- $nested = $this->nestedRelations($relation);
- // If there are nested relationships set on the query, we will put those onto
- // the query instances so that they can be handled after this relationship
- // is loaded. In this way they will all trickle down as they are loaded.
- if (count($nested) > 0)
- {
- $query->getQuery()->with($nested);
- }
- return $query;
- }
- /**
- * Get the deeply nested relations for a given top-level relation.
- *
- * @param string $relation
- * @return array
- */
- protected function nestedRelations($relation)
- {
- $nested = array();
- // We are basically looking for any relationships that are nested deeper than
- // the given top-level relationship. We will just check for any relations
- // that start with the given top relations and adds them to our arrays.
- foreach ($this->eagerLoad as $name => $constraints)
- {
- if ($this->isNested($name, $relation))
- {
- $nested[substr($name, strlen($relation.'.'))] = $constraints;
- }
- }
- return $nested;
- }
- /**
- * Determine if the relationship is nested.
- *
- * @param string $name
- * @param string $relation
- * @return bool
- */
- protected function isNested($name, $relation)
- {
- $dots = str_contains($name, '.');
- return $dots and starts_with($name, $relation) and $name != $relation;
- }
- /**
- * Add a relationship count condition to the query.
- *
- * @param string $relation
- * @param string $operator
- * @param int $count
- * @param string $boolean
- * @return \Illuminate\Database\Eloquent\Builder|static
- */
- public function has($relation, $operator = '>=', $count = 1, $boolean = 'and')
- {
- $instance = $this->model->$relation();
- $query = $instance->getRelationCountQuery($instance->getRelated()->newQuery());
- $this->query->mergeBindings($query->getQuery());
- return $this->where(new Expression('('.$query->toSql().')'), $operator, $count, $boolean);
- }
- /**
- * Add a relationship count condition to the query with an "or".
- *
- * @param string $relation
- * @param string $operator
- * @param int $count
- * @return \Illuminate\Database\Eloquent\Builder|static
- */
- public function orHas($relation, $operator = '>=', $count = 1)
- {
- return $this->has($relation, $operator, $count, 'or');
- }
- /**
- * Set the relationships that should be eager loaded.
- *
- * @param dynamic $relations
- * @return \Illuminate\Database\Eloquent\Builder|static
- */
- public function with($relations)
- {
- if (is_string($relations)) $relations = func_get_args();
- $eagers = $this->parseRelations($relations);
- $this->eagerLoad = array_merge($this->eagerLoad, $eagers);
- return $this;
- }
- /**
- * Parse a list of relations into individuals.
- *
- * @param array $relations
- * @return array
- */
- protected function parseRelations(array $relations)
- {
- $results = array();
- foreach ($relations as $name => $constraints)
- {
- // If the "relation" value is actually a numeric key, we can assume that no
- // constraints have been specified for the eager load and we'll just put
- // an empty Closure with the loader so that we can treat all the same.
- if (is_numeric($name))
- {
- $f = function() {};
- list($name, $constraints) = array($constraints, $f);
- }
- // We need to separate out any nested includes. Which allows the developers
- // to load deep relationships using "dots" without stating each level of
- // the relationship with its own key in the array of eager load names.
- $results = $this->parseNested($name, $results);
- $results[$name] = $constraints;
- }
- return $results;
- }
- /**
- * Parse the nested relationships in a relation.
- *
- * @param string $name
- * @param array $results
- * @return array
- */
- protected function parseNested($name, $results)
- {
- $progress = array();
- // If the relation has already been set on the result array, we will not set it
- // again, since that would override any constraints that were already placed
- // on the relationships. We will only set the ones that are not specified.
- foreach (explode('.', $name) as $segment)
- {
- $progress[] = $segment;
- if ( ! isset($results[$last = implode('.', $progress)]))
- {
- $results[$last] = function() {};
- }
- }
- return $results;
- }
- /**
- * Get the underlying query builder instance.
- *
- * @return \Illuminate\Database\Query\Builder|static
- */
- public function getQuery()
- {
- return $this->query;
- }
- /**
- * Set the underlying query builder instance.
- *
- * @param \Illuminate\Database\Query\Builder $query
- * @return void
- */
- public function setQuery($query)
- {
- $this->query = $query;
- }
- /**
- * Get the relationships being eagerly loaded.
- *
- * @return array
- */
- public function getEagerLoads()
- {
- return $this->eagerLoad;
- }
- /**
- * Set the relationships being eagerly loaded.
- *
- * @param array $eagerLoad
- * @return void
- */
- public function setEagerLoads(array $eagerLoad)
- {
- $this->eagerLoad = $eagerLoad;
- }
- /**
- * Get the model instance being queried.
- *
- * @return \Illuminate\Database\Eloquent\Model
- */
- public function getModel()
- {
- return $this->model;
- }
- /**
- * Set a model instance for the model being queried.
- *
- * @param \Illuminate\Database\Eloquent\Model $model
- * @return \Illuminate\Database\Eloquent\Builder
- */
- public function setModel(Model $model)
- {
- $this->model = $model;
- $this->query->from($model->getTable());
- return $this;
- }
- /**
- * Dynamically handle calls into the query instance.
- *
- * @param string $method
- * @param array $parameters
- * @return mixed
- */
- public function __call($method, $parameters)
- {
- if (method_exists($this->model, $scope = 'scope'.ucfirst($method)))
- {
- array_unshift($parameters, $this);
- call_user_func_array(array($this->model, $scope), $parameters);
- }
- else
- {
- $result = call_user_func_array(array($this->query, $method), $parameters);
- }
- return in_array($method, $this->passthru) ? $result : $this;
- }
- }
|