class HasManyThrough extends Relation (View source)

Traits

Properties

protected Builder $query

The decorated query builder instance.

from  DecoratesQueryBuilder
static protected array $macros

The registered string macros.

from  Macroable
protected Model $parent

The parent model instance.

from  Relation
$related

The related model instance.

from  Relation
static protected bool $constraints

Indicates if the relation is adding constraints.

from  Relation
static array $morphMap

An array to map class names to their morph names in the database.

from  Relation
static protected bool $requireMorphMap

Prevents morph relationships without a morph map.

from  Relation
static protected int $selfJoinCount

The count of self joins.

from  Relation
protected Model $throughParent

The "through" parent model instance.

protected Model $farParent

The far parent model instance.

protected string $firstKey

The near key on the relationship.

protected string $secondKey

The far key on the relationship.

protected string $localKey

The local key on the relationship.

protected string $secondLocalKey

The local key on the intermediary model.

Methods

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

static void
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

toBase()

Get a base query builder instance.

select($columns = ['*'])

{@inheritdoc}

selectSub($query, $as)

{@inheritdoc}

selectRaw($expression, array $bindings = [])

{@inheritdoc}

fromSub($query, $as)

{@inheritdoc}

fromRaw($expression, $bindings = [])

{@inheritdoc}

addSelect($column)

{@inheritdoc}

distinct()

{@inheritdoc}

from($table, $as = null)

{@inheritdoc}

join($table, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

joinWhere($table, $first, $operator, $second, $type = 'inner')

{@inheritdoc}

joinSub($query, $as, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

leftJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

leftJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

leftJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

rightJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

rightJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

rightJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

crossJoin($table, $first = null, $operator = null, $second = null)

{@inheritdoc}

crossJoinSub($query, $as)

{@inheritdoc}

mergeWheres($wheres, $bindings)

{@inheritdoc}

where($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

prepareValueAndOperator($value, $operator, $useDefault = false)

{@inheritdoc}

orWhere($column, $operator = null, $value = null)

{@inheritdoc}

whereColumn($first, $operator = null, $second = null, $boolean = 'and')

{@inheritdoc}

orWhereColumn($first, $operator = null, $second = null)

{@inheritdoc}

whereRaw($sql, $bindings = [], $boolean = 'and')

{@inheritdoc}

orWhereRaw($sql, $bindings = [])

{@inheritdoc}

whereIn($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereIn($column, $values)

{@inheritdoc}

whereNotIn($column, $values, $boolean = 'and')

{@inheritdoc}

orWhereNotIn($column, $values)

{@inheritdoc}

whereIntegerInRaw($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereIntegerInRaw($column, $values)

{@inheritdoc}

whereIntegerNotInRaw($column, $values, $boolean = 'and')

{@inheritdoc}

orWhereIntegerNotInRaw($column, $values)

{@inheritdoc}

whereNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereNull($column)

{@inheritdoc}

whereNotNull($columns, $boolean = 'and')

{@inheritdoc}

whereBetween($column, iterable $values, $boolean = 'and', $not = false)

{@inheritdoc}

whereBetweenColumns($column, array $values, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereBetween($column, iterable $values)

{@inheritdoc}

orWhereBetweenColumns($column, array $values)

{@inheritdoc}

whereNotBetween($column, iterable $values, $boolean = 'and')

{@inheritdoc}

whereNotBetweenColumns($column, array $values, $boolean = 'and')

{@inheritdoc}

orWhereNotBetween($column, iterable $values)

{@inheritdoc}

orWhereNotBetweenColumns($column, array $values)

{@inheritdoc}

orWhereNotNull($column)

{@inheritdoc}

whereDate($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereDate($column, $operator, $value = null)

{@inheritdoc}

whereTime($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereTime($column, $operator, $value = null)

{@inheritdoc}

whereDay($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereDay($column, $operator, $value = null)

{@inheritdoc}

whereMonth($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereMonth($column, $operator, $value = null)

{@inheritdoc}

whereYear($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereYear($column, $operator, $value = null)

{@inheritdoc}

whereNested(Closure $callback, $boolean = 'and')

{@inheritdoc}

addNestedWhereQuery($query, $boolean = 'and')

{@inheritdoc}

whereExists(Closure $callback, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereExists(Closure $callback, $not = false)

{@inheritdoc}

whereNotExists(Closure $callback, $boolean = 'and')

{@inheritdoc}

orWhereNotExists(Closure $callback)

{@inheritdoc}

whereRowValues($columns, $operator, $values, $boolean = 'and')

{@inheritdoc}

orWhereRowValues($columns, $operator, $values)

{@inheritdoc}

whereJsonContains($column, $value, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereJsonContains($column, $value)

{@inheritdoc}

whereJsonDoesntContain($column, $value, $boolean = 'and')

{@inheritdoc}

orWhereJsonDoesntContain($column, $value)

{@inheritdoc}

whereJsonLength($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereJsonLength($column, $operator, $value = null)

{@inheritdoc}

groupBy(...$groups)

{@inheritdoc}

groupByRaw($sql, array $bindings = [])

{@inheritdoc}

having($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

orHaving($column, $operator = null, $value = null)

{@inheritdoc}

havingNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

orHavingNull($column)

{@inheritdoc}

havingNotNull($columns, $boolean = 'and')

No description

orHavingNotNull($column)

No description

havingBetween($column, array $values, $boolean = 'and', $not = false)

No description

havingRaw($sql, array $bindings = [], $boolean = 'and')

No description

orHavingRaw($sql, array $bindings = [])

No description

orderBy($column, $direction = 'asc')

No description

orderByDesc($column)

No description

latest($column = 'created_at')

No description

oldest($column = 'created_at')

No description

inRandomOrder($seed = '')

No description

orderByRaw($sql, $bindings = [])

No description

skip($value)

No description

offset($value)

No description

take($value)

No description

limit($value)

No description

forPage($page, $perPage = 15)

No description

forPageBeforeId($perPage = 15, $lastId = 0, $column = 'id')

No description

forPageAfterId($perPage = 15, $lastId = 0, $column = 'id')

No description

reorder($column = null, $direction = 'asc')

No description

union($query, $all = false)

No description

unionAll($query)

No description

lock($value = true)

No description

lockForUpdate()

No description

sharedLock()

No description

toSql()

No description

find($id, $columns = ['*'])

Find a related model by its primary key.

value($column)

No description

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

Execute the query as a "select" statement.

cursor()

Get a generator for the given query.

pluck($column, $key = null)

No description

implode($column, $glue = '')

No description

exists()

No description

doesntExist()

No description

existsOr(Closure $callback)

No description

doesntExistOr(Closure $callback)

No description

count($columns = '*')

No description

min($column)

No description

max($column)

No description

sum($column)

No description

avg($column)

No description

average($column)

No description

aggregate($function, $columns = ['*'])

No description

numericAggregate($function, $columns = ['*'])

No description

insert(array $values)

No description

insertOrIgnore(array $values)

No description

insertGetId(array $values, $sequence = null)

No description

insertUsing(array $columns, $query)

No description

update(array $values)

No description

updateOrInsert(array $attributes, array $values = [])

No description

upsert(array $values, $uniqueBy, $update = null)

No description

increment($column, $amount = 1, array $extra = [])

No description

decrement($column, $amount = 1, array $extra = [])

No description

delete($id = null)

No description

truncate()

No description

newQuery()

No description

raw($value)

No description

getBindings()

No description

getRawBindings()

No description

setBindings(array $bindings, $type = 'where')

No description

addBinding($value, $type = 'where')

No description

mergeBindings(Builder $query)

No description

cleanBindings(array $bindings)

No description

getConnection()

No description

getProcessor()

No description

getGrammar()

No description

useWritePdo()

No description

clone()

No description

cloneWithout(array $properties)

No description

cloneWithoutBindings(array $except)

No description

mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

static void
macro(string $name, object|callable $macro)

Register a custom macro.

static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

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

Dynamically handle calls to the class.

void
__construct(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Create a new has many through relationship instance.

static mixed
noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

from  Relation
void
addConstraints()

Set the base constraints on the relation query.

void
addEagerConstraints(array $models)

Set the constraints for an eager load of the relation.

array
initRelation(array $models, string $relation)

Initialize the relation on a set of models.

array
match(array $models, Collection $results, string $relation)

Match the eagerly loaded results to their parents.

mixed
getResults()

Get the results of the relationship.

getEager()

Get the relationship for eager loading.

from  Relation
sole(array|string $columns = ['*'])

Execute the query and get the first result if it's the sole matching record.

from  Relation
void
touch()

Touch all of the related models for the relationship.

from  Relation
int
rawUpdate(array $attributes = [])

Run a raw update against the base query.

from  Relation
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

from  Relation
getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query.

string
getRelationCountHash(bool $incrementJoinCount = true)

Get a relationship join table hash.

from  Relation
array
getKeys(array $models, string|null $key = null)

Get all of the primary keys for an array of models.

from  Relation
getRelationQuery()

Get the query builder that will contain the relationship constraints.

from  Relation
getQuery()

Get the underlying query for the relation.

from  Relation
getBaseQuery() deprecated

Get the base query builder driving the Eloquent builder.

from  Relation
getParent()

Get the parent model of the relation.

from  Relation
string
getQualifiedParentKeyName()

Get the fully qualified parent key name.

getRelated()

Get the related model of the relation.

from  Relation
string
createdAt()

Get the name of the "created at" column.

from  Relation
string
updatedAt()

Get the name of the "updated at" column.

from  Relation
string
relatedUpdatedAt()

Get the name of the related model's "updated at" column.

from  Relation
string
whereInMethod(Model $model, string $key)

Get the name of the "where in" method for eager loading.

from  Relation
static void
requireMorphMap(bool $requireMorphMap = true)

Prevent polymorphic relationships from being used without model mappings.

from  Relation
static bool
requiresMorphMap()

Determine if polymorphic relationships require explicit model mapping.

from  Relation
static array
enforceMorphMap(array $map, bool $merge = true)

Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.

from  Relation
static array
morphMap(array $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

from  Relation
static array|null
buildMorphMapFromModels(array $models = null)

Builds a table-keyed array from model class names.

from  Relation
static string|null
getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

from  Relation
void
__clone()

Force a clone of the underlying query builder when cloning.

from  Relation
mixed
getDictionaryKey(mixed $attribute)

Get a dictionary key attribute - casting it to a string if necessary.

void
performJoin(Builder $query = null)

Set the join clause on the query.

bool
throughParentSoftDeletes()

Determine whether "through" parent of the relation uses Soft Deletes.

$this
withTrashedParents()

Indicate that trashed "through" parents should be included in the query.

array
buildDictionary(Collection $results)

Build model dictionary keyed by the relation's foreign key.

firstOrNew(array $attributes)

Get the first related model record matching the attributes or instantiate it.

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

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

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

Add a basic where clause to the query, and return the first result.

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

Execute the query and get the first related model.

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

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

firstOr(Closure|array $columns = ['*'], Closure $callback = null)

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

findMany(Arrayable|array $ids, array $columns = ['*'])

Find multiple related models by their primary keys.

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

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

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

Get a paginator for the "select" statement.

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

Paginate the given query into a simple paginator.

array
shouldSelect(array $columns = ['*'])

Set the select clause for the relation query.

bool
chunk(int $count, callable $callback)

Chunk the results of the query.

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

Chunk the results of a query by comparing numeric IDs.

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

Execute a callback over each item while chunking.

lazy(int $chunkSize = 1000)

Query lazily, by chunks of the given size.

lazyById($chunkSize = 1000, string|null $column = null, string|null $alias = null)

Query lazily, by chunking the results of a query by comparing IDs.

prepareQueryBuilder(array $columns = ['*'])

Prepare the query builder for query execution.

getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table.

getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table as the through parent.

string
getQualifiedFarKeyName()

Get the qualified foreign key on the related model.

string
getFirstKeyName()

Get the foreign key on the "through" model.

string
getQualifiedFirstKeyName()

Get the qualified foreign key on the "through" model.

string
getForeignKeyName()

Get the foreign key on the related model.

string
getQualifiedForeignKeyName()

Get the qualified foreign key on the related model.

string
getLocalKeyName()

Get the local key on the far parent model.

string
getQualifiedLocalKeyName()

Get the qualified local key on the far parent model.

string
getSecondLocalKeyName()

Get the local key on the intermediary model.

Details

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

abstract Builder toBase()

Get a base query builder instance.

Return Value

Builder

select($columns = ['*'])

{@inheritdoc}

Parameters

$columns

selectSub($query, $as)

{@inheritdoc}

Parameters

$query
$as

selectRaw($expression, array $bindings = [])

{@inheritdoc}

Parameters

$expression
array $bindings

fromSub($query, $as)

{@inheritdoc}

Parameters

$query
$as

fromRaw($expression, $bindings = [])

{@inheritdoc}

Parameters

$expression
$bindings

addSelect($column)

{@inheritdoc}

Parameters

$column

distinct()

{@inheritdoc}

from($table, $as = null)

{@inheritdoc}

Parameters

$table
$as

join($table, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

Parameters

$table
$first
$operator
$second
$type
$where

joinWhere($table, $first, $operator, $second, $type = 'inner')

{@inheritdoc}

Parameters

$table
$first
$operator
$second
$type

joinSub($query, $as, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

Parameters

$query
$as
$first
$operator
$second
$type
$where

leftJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

leftJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

leftJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$query
$as
$first
$operator
$second

rightJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

rightJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

rightJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$query
$as
$first
$operator
$second

crossJoin($table, $first = null, $operator = null, $second = null)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

crossJoinSub($query, $as)

{@inheritdoc}

Parameters

$query
$as

mergeWheres($wheres, $bindings)

{@inheritdoc}

Parameters

$wheres
$bindings

where($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

prepareValueAndOperator($value, $operator, $useDefault = false)

{@inheritdoc}

Parameters

$value
$operator
$useDefault

orWhere($column, $operator = null, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereColumn($first, $operator = null, $second = null, $boolean = 'and')

{@inheritdoc}

Parameters

$first
$operator
$second
$boolean

orWhereColumn($first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$first
$operator
$second

whereRaw($sql, $bindings = [], $boolean = 'and')

{@inheritdoc}

Parameters

$sql
$bindings
$boolean

orWhereRaw($sql, $bindings = [])

{@inheritdoc}

Parameters

$sql
$bindings

whereIn($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
$values
$boolean
$not

orWhereIn($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereNotIn($column, $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$values
$boolean

orWhereNotIn($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereIntegerInRaw($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
$values
$boolean
$not

orWhereIntegerInRaw($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereIntegerNotInRaw($column, $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$values
$boolean

orWhereIntegerNotInRaw($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$columns
$boolean
$not

orWhereNull($column)

{@inheritdoc}

Parameters

$column

whereNotNull($columns, $boolean = 'and')

{@inheritdoc}

Parameters

$columns
$boolean

whereBetween($column, iterable $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
iterable $values
$boolean
$not

whereBetweenColumns($column, array $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
array $values
$boolean
$not

orWhereBetween($column, iterable $values)

{@inheritdoc}

Parameters

$column
iterable $values

orWhereBetweenColumns($column, array $values)

{@inheritdoc}

Parameters

$column
array $values

whereNotBetween($column, iterable $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
iterable $values
$boolean

whereNotBetweenColumns($column, array $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
array $values
$boolean

orWhereNotBetween($column, iterable $values)

{@inheritdoc}

Parameters

$column
iterable $values

orWhereNotBetweenColumns($column, array $values)

{@inheritdoc}

Parameters

$column
array $values

orWhereNotNull($column)

{@inheritdoc}

Parameters

$column

whereDate($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereDate($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereTime($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereTime($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereDay($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereDay($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereMonth($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereMonth($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereYear($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereYear($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereNested(Closure $callback, $boolean = 'and')

{@inheritdoc}

Parameters

Closure $callback
$boolean

addNestedWhereQuery($query, $boolean = 'and')

{@inheritdoc}

Parameters

$query
$boolean

whereExists(Closure $callback, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

Closure $callback
$boolean
$not

orWhereExists(Closure $callback, $not = false)

{@inheritdoc}

Parameters

Closure $callback
$not

whereNotExists(Closure $callback, $boolean = 'and')

{@inheritdoc}

Parameters

Closure $callback
$boolean

orWhereNotExists(Closure $callback)

{@inheritdoc}

Parameters

Closure $callback

whereRowValues($columns, $operator, $values, $boolean = 'and')

{@inheritdoc}

Parameters

$columns
$operator
$values
$boolean

orWhereRowValues($columns, $operator, $values)

{@inheritdoc}

Parameters

$columns
$operator
$values

whereJsonContains($column, $value, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
$value
$boolean
$not

orWhereJsonContains($column, $value)

{@inheritdoc}

Parameters

$column
$value

whereJsonDoesntContain($column, $value, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$value
$boolean

orWhereJsonDoesntContain($column, $value)

{@inheritdoc}

Parameters

$column
$value

whereJsonLength($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereJsonLength($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

groupBy(...$groups)

{@inheritdoc}

Parameters

...$groups

groupByRaw($sql, array $bindings = [])

{@inheritdoc}

Parameters

$sql
array $bindings

having($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orHaving($column, $operator = null, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

havingNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$columns
$boolean
$not

orHavingNull($column)

{@inheritdoc}

Parameters

$column

havingNotNull($columns, $boolean = 'and')

No description

Parameters

$columns
$boolean

orHavingNotNull($column)

No description

Parameters

$column

havingBetween($column, array $values, $boolean = 'and', $not = false)

No description

Parameters

$column
array $values
$boolean
$not

havingRaw($sql, array $bindings = [], $boolean = 'and')

No description

Parameters

$sql
array $bindings
$boolean

orHavingRaw($sql, array $bindings = [])

No description

Parameters

$sql
array $bindings

orderBy($column, $direction = 'asc')

No description

Parameters

$column
$direction

orderByDesc($column)

No description

Parameters

$column

latest($column = 'created_at')

No description

Parameters

$column

oldest($column = 'created_at')

No description

Parameters

$column

inRandomOrder($seed = '')

No description

Parameters

$seed

orderByRaw($sql, $bindings = [])

No description

Parameters

$sql
$bindings

skip($value)

No description

Parameters

$value

offset($value)

No description

Parameters

$value

take($value)

No description

Parameters

$value

limit($value)

No description

Parameters

$value

forPage($page, $perPage = 15)

No description

Parameters

$page
$perPage

forPageBeforeId($perPage = 15, $lastId = 0, $column = 'id')

No description

Parameters

$perPage
$lastId
$column

forPageAfterId($perPage = 15, $lastId = 0, $column = 'id')

No description

Parameters

$perPage
$lastId
$column

reorder($column = null, $direction = 'asc')

No description

Parameters

$column
$direction

union($query, $all = false)

No description

Parameters

$query
$all

unionAll($query)

No description

Parameters

$query

lock($value = true)

No description

Parameters

$value

lockForUpdate()

No description

sharedLock()

No description

toSql()

No description

find($id, $columns = ['*'])

Find a related model by its primary key.

Parameters

$id
$columns

value($column)

No description

Parameters

$column

Collection get(array $columns = ['*'])

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

cursor()

Get a generator for the given query.

pluck($column, $key = null)

No description

Parameters

$column
$key

implode($column, $glue = '')

No description

Parameters

$column
$glue

exists()

No description

doesntExist()

No description

existsOr(Closure $callback)

No description

Parameters

Closure $callback

doesntExistOr(Closure $callback)

No description

Parameters

Closure $callback

count($columns = '*')

No description

Parameters

$columns

min($column)

No description

Parameters

$column

max($column)

No description

Parameters

$column

sum($column)

No description

Parameters

$column

avg($column)

No description

Parameters

$column

average($column)

No description

Parameters

$column

aggregate($function, $columns = ['*'])

No description

Parameters

$function
$columns

numericAggregate($function, $columns = ['*'])

No description

Parameters

$function
$columns

insert(array $values)

No description

Parameters

array $values

insertOrIgnore(array $values)

No description

Parameters

array $values

insertGetId(array $values, $sequence = null)

No description

Parameters

array $values
$sequence

insertUsing(array $columns, $query)

No description

Parameters

array $columns
$query

update(array $values)

No description

Parameters

array $values

updateOrInsert(array $attributes, array $values = [])

No description

Parameters

array $attributes
array $values

upsert(array $values, $uniqueBy, $update = null)

No description

Parameters

array $values
$uniqueBy
$update

increment($column, $amount = 1, array $extra = [])

No description

Parameters

$column
$amount
array $extra

decrement($column, $amount = 1, array $extra = [])

No description

Parameters

$column
$amount
array $extra

delete($id = null)

No description

Parameters

$id

truncate()

No description

newQuery()

No description

raw($value)

No description

Parameters

$value

getBindings()

No description

getRawBindings()

No description

setBindings(array $bindings, $type = 'where')

No description

Parameters

array $bindings
$type

addBinding($value, $type = 'where')

No description

Parameters

$value
$type

mergeBindings(Builder $query)

No description

Parameters

Builder $query

cleanBindings(array $bindings)

No description

Parameters

array $bindings

getConnection()

No description

getProcessor()

No description

getGrammar()

No description

useWritePdo()

No description

clone()

No description

cloneWithout(array $properties)

No description

Parameters

array $properties

cloneWithoutBindings(array $except)

No description

Parameters

array $except

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Create a new has many through relationship instance.

Parameters

Builder $query
Model $farParent
Model $throughParent
string $firstKey
string $secondKey
string $localKey
string $secondLocalKey

Return Value

void

static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

void addConstraints()

Set the base constraints on the relation query.

Return Value

void

void addEagerConstraints(array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

array initRelation(array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

array match(array $models, Collection $results, string $relation)

Match the eagerly loaded results to their parents.

Parameters

array $models
Collection $results
string $relation

Return Value

array

mixed getResults()

Get the results of the relationship.

Return Value

mixed

Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

Model sole(array|string $columns = ['*'])

Execute the query and get the first result if it's the sole matching record.

Parameters

array|string $columns

Return Value

Model

Exceptions

ModelNotFoundException
MultipleRecordsFoundException

void touch()

Touch all of the related models for the relationship.

Return Value

void

int rawUpdate(array $attributes = [])

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parentQuery

Return Value

Builder

Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

string getRelationCountHash(bool $incrementJoinCount = true)

Get a relationship join table hash.

Parameters

bool $incrementJoinCount

Return Value

string

protected array getKeys(array $models, string|null $key = null)

Get all of the primary keys for an array of models.

Parameters

array $models
string|null $key

Return Value

array

protected Builder getRelationQuery()

Get the query builder that will contain the relationship constraints.

Return Value

Builder

Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

Builder getBaseQuery() deprecated

deprecated Use toBase() instead

Get the base query builder driving the Eloquent builder.

Return Value

Builder

Model getParent()

Get the parent model of the relation.

Return Value

Model

string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

Model getRelated()

Get the related model of the relation.

Return Value

Model

string createdAt()

Get the name of the "created at" column.

Return Value

string

string updatedAt()

Get the name of the "updated at" column.

Return Value

string

string relatedUpdatedAt()

Get the name of the related model's "updated at" column.

Return Value

string

protected string whereInMethod(Model $model, string $key)

Get the name of the "where in" method for eager loading.

Parameters

Model $model
string $key

Return Value

string

static void requireMorphMap(bool $requireMorphMap = true)

Prevent polymorphic relationships from being used without model mappings.

Parameters

bool $requireMorphMap

Return Value

void

static bool requiresMorphMap()

Determine if polymorphic relationships require explicit model mapping.

Return Value

bool

static array enforceMorphMap(array $map, bool $merge = true)

Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.

Parameters

array $map
bool $merge

Return Value

array

static array morphMap(array $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

Parameters

array $map
bool $merge

Return Value

array

static protected array|null buildMorphMapFromModels(array $models = null)

Builds a table-keyed array from model class names.

Parameters

array $models

Return Value

array|null

static string|null getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

Parameters

string $alias

Return Value

string|null

void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

protected mixed getDictionaryKey(mixed $attribute)

Get a dictionary key attribute - casting it to a string if necessary.

Parameters

mixed $attribute

Return Value

mixed

Exceptions

InvalidArgumentException

protected void performJoin(Builder $query = null)

Set the join clause on the query.

Parameters

Builder $query

Return Value

void

bool throughParentSoftDeletes()

Determine whether "through" parent of the relation uses Soft Deletes.

Return Value

bool

$this withTrashedParents()

Indicate that trashed "through" parents should be included in the query.

Return Value

$this

protected array buildDictionary(Collection $results)

Build model dictionary keyed by the relation's foreign key.

Parameters

Collection $results

Return Value

array

Model firstOrNew(array $attributes)

Get the first related model record matching the attributes or instantiate it.

Parameters

array $attributes

Return Value

Model

Model updateOrCreate(array $attributes, array $values = [])

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

Parameters

array $attributes
array $values

Return Value

Model

Model|HasManyThrough firstWhere(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Add a basic where clause to the query, and return the first result.

Parameters

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

Return Value

Model|HasManyThrough

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

Execute the query and get the first related model.

Parameters

array $columns

Return Value

mixed

Model|HasManyThrough firstOrFail(array $columns = ['*'])

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

Parameters

array $columns

Return Value

Model|HasManyThrough

Exceptions

ModelNotFoundException

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

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

Parameters

Closure|array $columns
Closure $callback

Return Value

Model|HasManyThrough|mixed

Collection findMany(Arrayable|array $ids, array $columns = ['*'])

Find multiple related models by their primary keys.

Parameters

Arrayable|array $ids
array $columns

Return Value

Collection

Model|Collection findOrFail(mixed $id, array $columns = ['*'])

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

Parameters

mixed $id
array $columns

Return Value

Model|Collection

Exceptions

ModelNotFoundException

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

Get a paginator for the "select" statement.

Parameters

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

Return Value

LengthAwarePaginator

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

Paginate the given query into a simple paginator.

Parameters

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

Return Value

Paginator

protected array shouldSelect(array $columns = ['*'])

Set the select clause for the relation query.

Parameters

array $columns

Return Value

array

bool chunk(int $count, callable $callback)

Chunk the results of the query.

Parameters

int $count
callable $callback

Return Value

bool

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

Chunk the results of a query by comparing numeric IDs.

Parameters

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

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

LazyCollection lazy(int $chunkSize = 1000)

Query lazily, by chunks of the given size.

Parameters

int $chunkSize

Return Value

LazyCollection

LazyCollection lazyById($chunkSize = 1000, string|null $column = null, string|null $alias = null)

Query lazily, by chunking the results of a query by comparing IDs.

Parameters

$chunkSize
string|null $column
string|null $alias

Return Value

LazyCollection

protected Builder prepareQueryBuilder(array $columns = ['*'])

Prepare the query builder for query execution.

Parameters

array $columns

Return Value

Builder

Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

Builder getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table as the through parent.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

string getQualifiedFarKeyName()

Get the qualified foreign key on the related model.

Return Value

string

string getFirstKeyName()

Get the foreign key on the "through" model.

Return Value

string

string getQualifiedFirstKeyName()

Get the qualified foreign key on the "through" model.

Return Value

string

string getForeignKeyName()

Get the foreign key on the related model.

Return Value

string

string getQualifiedForeignKeyName()

Get the qualified foreign key on the related model.

Return Value

string

string getLocalKeyName()

Get the local key on the far parent model.

Return Value

string

string getQualifiedLocalKeyName()

Get the qualified local key on the far parent model.

Return Value

string

string getSecondLocalKeyName()

Get the local key on the intermediary model.

Return Value

string