class Builder (View source)

Traits

Methods

bool
chunk(int $count, callable $callback)

Chunk the results of the query.

bool
each(callable $callback, int $count = 1000)

Execute a callback over each item while chunking.

mixed
first(array $columns = array('*'))

Execute the query and get the first result.

mixed
when(mixed $value, Closure $callback, Closure $default = null)

Apply the callback's query changes if the given "value" is true.

has(string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

Add a relationship count / exists condition to the query.

orHas(string $relation, string $operator = '>=', int $count = 1)

Add a relationship count / exists condition to the query with an "or".

doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)

Add a relationship count / exists condition to the query.

whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Add a relationship count / exists condition to the query with where clauses.

orWhereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Add a relationship count / exists condition to the query with where clauses and an "or".

whereDoesntHave(string $relation, Closure $callback = null)

Add a relationship count / exists condition to the query with where clauses.

$this
withCount(mixed $relations)

Add subselect queries to count the relations.

mergeConstraintsFrom(Builder $from)

Merge the where constraints from another query to the current query.

void
__construct(Builder $query)

Create a new Eloquent query builder instance.

$this
withGlobalScope(string $identifier, Scope|Closure $scope)

Register a new global scope.

$this
withoutGlobalScope(Scope|string $scope)

Remove a registered global scope.

$this
withoutGlobalScopes(array $scopes = null)

Remove all or passed registered global scopes.

array
removedScopes()

Get an array of global scopes that were removed from the query.

$this
whereKey(mixed $id)

Add a where clause on the primary key to the query.

$this
where(string|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and')

Add a basic where clause to the query.

orWhere(string|Closure $column, string $operator = null, mixed $value = null)

Add an "or where" clause to the query.

hydrate(array $items)

Create a collection of models from plain arrays.

fromQuery(string $query, array $bindings = array())

Create a collection of models from a raw query.

find(mixed $id, array $columns = array('*'))

Find a model by its primary key.

findMany(array $ids, array $columns = array('*'))

Find multiple models by their primary keys.

findOrFail(mixed $id, array $columns = array('*'))

Find a model by its primary key or throw an exception.

findOrNew(mixed $id, array $columns = array('*'))

Find a model by its primary key or return fresh model instance.

firstOrNew(array $attributes, array $values = array())

Get the first record matching the attributes or instantiate it.

firstOrCreate(array $attributes, array $values = array())

Get the first record matching the attributes or create it.

updateOrCreate(array $attributes, array $values = array())

Create or update a record matching the attributes, and fill it with values.

firstOrFail(array $columns = array('*'))

Execute the query and get the first result or throw an exception.

Model|Builder|mixed
firstOr(Closure|array $columns = array('*'), Closure $callback = null)

Execute the query and get the first result or call a callback.

mixed
value(string $column)

Get a single column's value from the first result of a query.

get(array $columns = array('*'))

Execute the query as a "select" statement.

Model[]
getModels(array $columns = array('*'))

Get the hydrated models without eager loading.

array
eagerLoadRelations(array $models)

Eager load the relationships for the models.

getRelation(string $name)

Get the relation instance for the given relation name.

cursor()

Get a generator for the given query.

bool
chunkById(int $count, callable $callback, string $column = null, string|null $alias = null)

Chunk the results of a query by comparing numeric IDs.

pluck(string $column, string|null $key = null)

Get an array with the values of a given column.

paginate(int $perPage = null, array $columns = array('*'), string $pageName = 'page', int|null $page = null)

Paginate the given query.

simplePaginate(int $perPage = null, array $columns = array('*'), string $pageName = 'page', int|null $page = null)

Paginate the given query into a simple paginator.

create(array $attributes = array())

Save a new model and return the instance.

forceCreate(array $attributes)

Save a new model and return the instance. Allow mass-assignment.

int
update(array $values)

Update a record in the database.

int
increment(string $column, int $amount = 1, array $extra = array())

Increment a column's value by a given amount.

int
decrement(string $column, int $amount = 1, array $extra = array())

Decrement a column's value by a given amount.

mixed
delete()

Delete a record from the database.

mixed
forceDelete()

Run the default delete function on the builder.

void
onDelete(Closure $callback)

Register a replacement for the default delete function.

mixed
scopes(array $scopes)

Call the given local model scopes.

applyScopes()

Apply the scopes to the Eloquent builder instance and return it.

$this
with(mixed $relations)

Set the relationships that should be eager loaded.

$this
without(mixed $relations)

Prevent the specified relations from being eager loaded.

newModelInstance(array $attributes = array())

Create a new instance of the model being queried.

getQuery()

Get the underlying query builder instance.

$this
setQuery(Builder $query)

Set the underlying query builder instance.

toBase()

Get a base query builder instance.

array
getEagerLoads()

Get the relationships being eagerly loaded.

$this
setEagerLoads(array $eagerLoad)

Set the relationships being eagerly loaded.

getModel()

Get the model instance being queried.

$this
setModel(Model $model)

Set a model instance for the model being queried.

getMacro(string $name)

Get the given macro by name.

mixed
__call(string $method, array $parameters)

Dynamically handle calls into the query instance.

static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls into the query instance.

void
__clone()

Force a clone of the underlying query builder when cloning.

Details

bool chunk(int $count, callable $callback)

Chunk the results of the query.

Parameters

int $count
callable $callback

Return Value

bool

bool each(callable $callback, int $count = 1000)

Execute a callback over each item while chunking.

Parameters

callable $callback
int $count

Return Value

bool

mixed first(array $columns = array('*'))

Execute the query and get the first result.

Parameters

array $columns

Return Value

mixed

mixed when(mixed $value, Closure $callback, Closure $default = null)

Apply the callback's query changes if the given "value" is true.

Parameters

mixed $value
Closure $callback
Closure $default

Return Value

mixed

Builder|QueriesRelationships has(string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

Add a relationship count / exists condition to the query.

Parameters

string $relation
string $operator
int $count
string $boolean
Closure $callback

Return Value

Builder|QueriesRelationships

Builder|QueriesRelationships orHas(string $relation, string $operator = '>=', int $count = 1)

Add a relationship count / exists condition to the query with an "or".

Parameters

string $relation
string $operator
int $count

Return Value

Builder|QueriesRelationships

Builder|QueriesRelationships doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)

Add a relationship count / exists condition to the query.

Parameters

string $relation
string $boolean
Closure $callback

Return Value

Builder|QueriesRelationships

Builder|QueriesRelationships whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Add a relationship count / exists condition to the query with where clauses.

Parameters

string $relation
Closure $callback
string $operator
int $count

Return Value

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Add a relationship count / exists condition to the query with where clauses and an "or".

Parameters

string $relation
Closure $callback
string $operator
int $count

Return Value

Builder|QueriesRelationships

Builder|QueriesRelationships whereDoesntHave(string $relation, Closure $callback = null)

Add a relationship count / exists condition to the query with where clauses.

Parameters

string $relation
Closure $callback

Return Value

Builder|QueriesRelationships

$this withCount(mixed $relations)

Add subselect queries to count the relations.

Parameters

mixed $relations

Return Value

$this

Builder|QueriesRelationships mergeConstraintsFrom(Builder $from)

Merge the where constraints from another query to the current query.

Parameters

Builder $from

Return Value

Builder|QueriesRelationships

at line line 95
void __construct(Builder $query)

Create a new Eloquent query builder instance.

Parameters

Builder $query

Return Value

void

at line line 107
$this withGlobalScope(string $identifier, Scope|Closure $scope)

Register a new global scope.

Parameters

string $identifier
Scope|Closure $scope

Return Value

$this

at line line 124
$this withoutGlobalScope(Scope|string $scope)

Remove a registered global scope.

Parameters

Scope|string $scope

Return Value

$this

at line line 143
$this withoutGlobalScopes(array $scopes = null)

Remove all or passed registered global scopes.

Parameters

array $scopes

Return Value

$this

at line line 161
array removedScopes()

Get an array of global scopes that were removed from the query.

Return Value

array

at line line 172
$this whereKey(mixed $id)

Add a where clause on the primary key to the query.

Parameters

mixed $id

Return Value

$this

at line line 192
$this where(string|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and')

Add a basic where clause to the query.

Parameters

string|Closure $column
string $operator
mixed $value
string $boolean

Return Value

$this

at line line 215
Builder|Builder orWhere(string|Closure $column, string $operator = null, mixed $value = null)

Add an "or where" clause to the query.

Parameters

string|Closure $column
string $operator
mixed $value

Return Value

Builder|Builder

at line line 226
Collection hydrate(array $items)

Create a collection of models from plain arrays.

Parameters

array $items

Return Value

Collection

at line line 242
Collection fromQuery(string $query, array $bindings = array())

Create a collection of models from a raw query.

Parameters

string $query
array $bindings

Return Value

Collection

at line line 256
Model|Collection|Builder[]|Builder|null find(mixed $id, array $columns = array('*'))

Find a model by its primary key.

Parameters

mixed $id
array $columns

Return Value

Model|Collection|Builder[]|Builder|null

at line line 272
Collection findMany(array $ids, array $columns = array('*'))

Find multiple models by their primary keys.

Parameters

array $ids
array $columns

Return Value

Collection

at line line 290
Model|Collection findOrFail(mixed $id, array $columns = array('*'))

Find a model by its primary key or throw an exception.

Parameters

mixed $id
array $columns

Return Value

Model|Collection

Exceptions

ModelNotFoundException

at line line 314
Model findOrNew(mixed $id, array $columns = array('*'))

Find a model by its primary key or return fresh model instance.

Parameters

mixed $id
array $columns

Return Value

Model

at line line 330
Model firstOrNew(array $attributes, array $values = array())

Get the first record matching the attributes or instantiate it.

Parameters

array $attributes
array $values

Return Value

Model

at line line 346
Model firstOrCreate(array $attributes, array $values = array())

Get the first record matching the attributes or create it.

Parameters

array $attributes
array $values

Return Value

Model

at line line 364
Model updateOrCreate(array $attributes, array $values = array())

Create or update a record matching the attributes, and fill it with values.

Parameters

array $attributes
array $values

Return Value

Model

at line line 379
Model|Builder firstOrFail(array $columns = array('*'))

Execute the query and get the first result or throw an exception.

Parameters

array $columns

Return Value

Model|Builder

Exceptions

ModelNotFoundException

at line line 395
Model|Builder|mixed firstOr(Closure|array $columns = array('*'), Closure $callback = null)

Execute the query and get the first result or call a callback.

Parameters

Closure|array $columns
Closure $callback

Return Value

Model|Builder|mixed

at line line 416
mixed value(string $column)

Get a single column's value from the first result of a query.

Parameters

string $column

Return Value

mixed

at line line 429
Collection|Builder[] get(array $columns = array('*'))

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection|Builder[]

at line line 449
Model[] getModels(array $columns = array('*'))

Get the hydrated models without eager loading.

Parameters

array $columns

Return Value

Model[]

at line line 462
array eagerLoadRelations(array $models)

Eager load the relationships for the models.

Parameters

array $models

Return Value

array

at line line 510
Relation getRelation(string $name)

Get the relation instance for the given relation name.

Parameters

string $name

Return Value

Relation

at line line 574
Generator cursor()

Get a generator for the given query.

Return Value

Generator

at line line 590
bool chunkById(int $count, callable $callback, string $column = null, string|null $alias = null)

Chunk the results of a query by comparing numeric IDs.

Parameters

int $count
callable $callback
string $column
string|null $alias

Return Value

bool

at line line 644
Collection pluck(string $column, string|null $key = null)

Get an array with the values of a given column.

Parameters

string $column
string|null $key

Return Value

Collection

at line line 673
LengthAwarePaginator paginate(int $perPage = null, array $columns = array('*'), string $pageName = 'page', int|null $page = null)

Paginate the given query.

Parameters

int $perPage
array $columns
string $pageName
int|null $page

Return Value

LengthAwarePaginator

Exceptions

InvalidArgumentException

at line line 698
Paginator simplePaginate(int $perPage = null, array $columns = array('*'), string $pageName = 'page', int|null $page = null)

Paginate the given query into a simple paginator.

Parameters

int $perPage
array $columns
string $pageName
int|null $page

Return Value

Paginator

at line line 721
Model create(array $attributes = array())

Save a new model and return the instance.

Parameters

array $attributes

Return Value

Model

at line line 734
Model forceCreate(array $attributes)

Save a new model and return the instance. Allow mass-assignment.

Parameters

array $attributes

Return Value

Model

at line line 747
int update(array $values)

Update a record in the database.

Parameters

array $values

Return Value

int

at line line 760
int increment(string $column, int $amount = 1, array $extra = array())

Increment a column's value by a given amount.

Parameters

string $column
int $amount
array $extra

Return Value

int

at line line 775
int decrement(string $column, int $amount = 1, array $extra = array())

Decrement a column's value by a given amount.

Parameters

string $column
int $amount
array $extra

Return Value

int

at line line 805
mixed delete()

Delete a record from the database.

Return Value

mixed

at line line 821
mixed forceDelete()

Run the default delete function on the builder.

Since we do not apply scopes here, the row will actually be deleted.

Return Value

mixed

at line line 832
void onDelete(Closure $callback)

Register a replacement for the default delete function.

Parameters

Closure $callback

Return Value

void

at line line 843
mixed scopes(array $scopes)

Call the given local model scopes.

Parameters

array $scopes

Return Value

mixed

at line line 872
Builder|Builder applyScopes()

Apply the scopes to the Eloquent builder instance and return it.

Return Value

Builder|Builder

at line line 998
$this with(mixed $relations)

Set the relationships that should be eager loaded.

Parameters

mixed $relations

Return Value

$this

at line line 1013
$this without(mixed $relations)

Prevent the specified relations from being eager loaded.

Parameters

mixed $relations

Return Value

$this

at line line 1028
Model newModelInstance(array $attributes = array())

Create a new instance of the model being queried.

Parameters

array $attributes

Return Value

Model

at line line 1115
Builder getQuery()

Get the underlying query builder instance.

Return Value

Builder

at line line 1126
$this setQuery(Builder $query)

Set the underlying query builder instance.

Parameters

Builder $query

Return Value

$this

at line line 1138
Builder toBase()

Get a base query builder instance.

Return Value

Builder

at line line 1148
array getEagerLoads()

Get the relationships being eagerly loaded.

Return Value

array

at line line 1159
$this setEagerLoads(array $eagerLoad)

Set the relationships being eagerly loaded.

Parameters

array $eagerLoad

Return Value

$this

at line line 1171
Model getModel()

Get the model instance being queried.

Return Value

Model

at line line 1182
$this setModel(Model $model)

Set a model instance for the model being queried.

Parameters

Model $model

Return Value

$this

at line line 1197
Closure getMacro(string $name)

Get the given macro by name.

Parameters

string $name

Return Value

Closure

at line line 1209
mixed __call(string $method, array $parameters)

Dynamically handle calls into the query instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line line 1253
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls into the query instance.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 1277
void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void