Illuminate\Database\Eloquent\Relations\MorphToMany

class MorphToMany extends BelongsToMany (View source)

Traits

ForwardsCalls

Macroable

Properties

static protected array	$macros	The registered string macros.	from Macroable
protected TRelatedModel>	$query	The Eloquent query builder instance.	from Relation
protected TDeclaringModel	$parent	The parent model instance.	from Relation
protected TRelatedModel	$related	The related model instance.	from Relation
protected bool	$eagerKeysWereEmpty	Indicates whether the eagerly loaded relation should implicitly return an empty collection.	from Relation
static protected bool	$constraints	Indicates if the relation is adding constraints.	from Relation
static Model>>	$morphMap	An array to map morph names to their class 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 string	$table	The intermediate table for the relation.	from BelongsToMany
protected string	$foreignPivotKey	The foreign key of the parent model.	from BelongsToMany
protected string	$relatedPivotKey	The associated key of the relation.	from BelongsToMany
protected string	$parentKey	The key name of the parent model.	from BelongsToMany
protected string	$relatedKey	The key name of the related model.	from BelongsToMany
protected string	$relationName	The "name" of the relationship.	from BelongsToMany
protected (string\|Expression)[]	$pivotColumns	The pivot table columns to retrieve.	from BelongsToMany
protected array	$pivotWheres	Any pivot table restrictions for where clauses.	from BelongsToMany
protected array	$pivotWhereIns	Any pivot table restrictions for whereIn clauses.	from BelongsToMany
protected array	$pivotWhereNulls	Any pivot table restrictions for whereNull clauses.	from BelongsToMany
protected array	$pivotValues	The default values for the pivot columns.	from BelongsToMany
bool	$withTimestamps	Indicates if timestamps are available on the pivot table.	from BelongsToMany
protected string\|null	$pivotCreatedAt	The custom pivot table column for the created_at timestamp.	from BelongsToMany
protected string\|null	$pivotUpdatedAt	The custom pivot table column for the updated_at timestamp.	from BelongsToMany
protected TPivotModel>	$using	The class name of the custom pivot model to use for the relationship.	from BelongsToMany
protected TAccessor	$accessor	The name of the accessor to use for the "pivot" relationship.	from BelongsToMany
protected string	$morphType	The type of the polymorphic relation.
protected TRelatedModel>	$morphClass	The class name of the morph type constraint.
protected bool	$inverse	Indicates if we are connecting the inverse of the relation.

Methods

mixed

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

Forward a method call to the given object.

from ForwardsCalls

mixed

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

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

from ForwardsCalls

static never

throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

from ForwardsCalls

static void

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

from Macroable

static void

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

Mix another object into the class.

from Macroable

static bool

hasMacro(string $name)

Checks if macro is registered.

from Macroable

static void

flushMacros()

Flush the existing macros.

from Macroable

static mixed

__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

mixed

__call(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

__construct(Builder $query, Model $parent, string $name, string|TRelatedModel> $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Create a new morph to many relationship instance.

static

noConstraints(Closure $callback)

No description

from Relation

void

addConstraints()

Set the base constraints on the relation query.

from BelongsToMany

void

addEagerConstraints(array $models)

No description

TDeclaringModel>

initRelation(array $models, string $relation)

No description

from BelongsToMany

TDeclaringModel>

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

No description

from BelongsToMany

TResult

getResults()

No description

from BelongsToMany

TRelatedModel>

getEager()

Get the relationship for eager loading.

from Relation

TRelatedModel

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

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

from Relation

TRelatedModel>

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

No description

from BelongsToMany

void

touch()

Touch all of the related models for the relationship.

from BelongsToMany

int

rawUpdate(array $attributes = [])

Run a raw update against the base query.

from Relation

TRelatedModel>

getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

from Relation

TRelatedModel>

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

No description

string

getRelationCountHash(bool $incrementJoinCount = true)

Get a relationship join table hash.

from Relation

array<int,int|string|null>

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

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

from Relation

TRelatedModel>

getRelationQuery()

Get the query builder that will contain the relationship constraints.

from Relation

TRelatedModel>

getQuery()

Get the underlying query for the relation.

from Relation

Builder

getBaseQuery()

Get the base query builder driving the Eloquent builder.

from Relation

Builder

toBase()

Get a base query builder instance.

from Relation

TDeclaringModel

getParent()

Get the parent model of the relation.

from Relation

string

getQualifiedParentKeyName()

Get the fully qualified parent key name for the relation.

from BelongsToMany

TRelatedModel

getRelated()

Get the related model of the relation.

from Relation

string

createdAt()

Get the name of the "created at" column.

from BelongsToMany

string

updatedAt()

Get the name of the "updated at" column.

from BelongsToMany

string

relatedUpdatedAt()

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

from Relation

void

whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)

Add a whereIn eager constraint for the given set of model keys to be loaded.

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 Model>>

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

Set or get the morph map for polymorphic relations.

from Relation

static Model>>|null

buildMorphMapFromModels(array|null $models = null)

Builds a table-keyed array from model class names.

from Relation

static Model>|null

getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

from Relation

static int|string

getMorphAlias(string $className)

Get the alias associated with a custom polymorphic class.

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.

from InteractsWithDictionary

array

toggle(mixed $ids, bool $touch = true)

Toggles a model (or models) from the parent.

from InteractsWithPivotTable

syncWithoutDetaching(Collection|Model|array $ids)

Sync the intermediate tables with a list of IDs without detaching.

from InteractsWithPivotTable

sync(Collection|Model|array $ids, bool $detaching = true)

Sync the intermediate tables with a list of IDs or collection of models.

from InteractsWithPivotTable

syncWithPivotValues(Collection|Model|array $ids, array $values, bool $detaching = true)

Sync the intermediate tables with a list of IDs or collection of models with the given pivot values.

from InteractsWithPivotTable

array

formatRecordsList(array $records)

Format the sync / toggle record list so that it is keyed by ID.

from InteractsWithPivotTable

array

attachNew(array $records, array $current, bool $touch = true)

Attach all of the records that aren't in the given current records.

from InteractsWithPivotTable

int

updateExistingPivot(mixed $id, array $attributes, bool $touch = true)

Update an existing pivot record on the table.

from InteractsWithPivotTable

int

updateExistingPivotUsingCustomClass(mixed $id, array $attributes, bool $touch)

Update an existing pivot record on the table via a custom class.

from InteractsWithPivotTable

void

attach(mixed $ids, array $attributes = [], bool $touch = true)

Attach a model to the parent.

from InteractsWithPivotTable

void

attachUsingCustomClass(mixed $ids, array $attributes)

Attach a model to the parent using a custom class.

from InteractsWithPivotTable

array

formatAttachRecords(array $ids, array $attributes)

Create an array of records to insert into the pivot table.

from InteractsWithPivotTable

array

formatAttachRecord(int $key, mixed $value, array $attributes, bool $hasTimestamps)

Create a full attachment record payload.

from InteractsWithPivotTable

array

extractAttachIdAndAttributes(mixed $key, mixed $value, array $attributes)

Get the attach record ID and extra attributes.

from InteractsWithPivotTable

array

baseAttachRecord(int $id, bool $timed)

Create a new pivot attachment record.

array

addTimestampsToAttachment(array $record, bool $exists = false)

Set the creation and update timestamps on an attach record.

from InteractsWithPivotTable

bool

hasPivotColumn(string $column)

Determine whether the given column is defined as a pivot column.

from InteractsWithPivotTable

int

detach(mixed $ids = null, bool $touch = true)

Detach models from the relationship.

from InteractsWithPivotTable

int

detachUsingCustomClass(mixed $ids)

Detach models from the relationship using a custom class.

from InteractsWithPivotTable

Collection

getCurrentlyAttachedPivots()

Get the pivot models that are currently attached.

Pivot

newPivot(array $attributes = [], bool $exists = false)

Create a new pivot model instance.

Pivot

newExistingPivot(array $attributes = [])

Create a new existing pivot model instance.

from InteractsWithPivotTable

Builder

newPivotStatement()

Get a new plain query builder for the pivot table.

from InteractsWithPivotTable

Builder

newPivotStatementForId(mixed $id)

Get a new pivot statement for a given "other" ID.

from InteractsWithPivotTable

Builder

newPivotQuery()

Create a new query builder for the pivot table.

$this

withPivot(array|mixed $columns)

Set the columns on the pivot table to retrieve.

from InteractsWithPivotTable

array

parseIds(mixed $value)

Get all of the IDs from the given mixed value.

from InteractsWithPivotTable

mixed

parseId(mixed $value)

Get the ID from the given mixed value.

from InteractsWithPivotTable

array

castKeys(array $keys)

Cast the given keys to integers if they are numeric and string otherwise.

from InteractsWithPivotTable

mixed

castKey(mixed $key)

Cast the given key to convert to primary key type.

from InteractsWithPivotTable

array

castAttributes(array $attributes)

Cast the given pivot attributes.

from InteractsWithPivotTable

mixed

getTypeSwapValue(string $type, mixed $value)

Converts a given value to a given type value.

from InteractsWithPivotTable

string

resolveTableName(string $table)

Attempt to resolve the intermediate table name from the given string.

from BelongsToMany

$this

performJoin(TRelatedModel>|null $query = null)

Set the join clause for the relation query.

from BelongsToMany

$this

addWhereConstraints()

Set the where clause for the relation query.

TRelatedModel>[]

buildDictionary(Collection $results)

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

from BelongsToMany

TPivotModel>

getPivotClass()

Get the class being used for pivot models.

from BelongsToMany

$this

using(TNewPivotModel> $class)

Specify the custom pivot model to use for the relationship.

from BelongsToMany

$this

as(TNewAccessor $accessor)

Specify the custom pivot accessor to use for the relationship.

from BelongsToMany

$this

wherePivot(string|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Set a where clause for a pivot table column.

from BelongsToMany

$this

wherePivotBetween(string|Expression $column, array $values, string $boolean = 'and', bool $not = false)

Set a "where between" clause for a pivot table column.

from BelongsToMany

$this

orWherePivotBetween(string|Expression $column, array $values)

Set a "or where between" clause for a pivot table column.

from BelongsToMany

$this

wherePivotNotBetween(string|Expression $column, array $values, string $boolean = 'and')

Set a "where pivot not between" clause for a pivot table column.

from BelongsToMany

$this

orWherePivotNotBetween(string|Expression $column, array $values)

Set a "or where not between" clause for a pivot table column.

from BelongsToMany

$this

wherePivotIn(string|Expression $column, mixed $values, string $boolean = 'and', bool $not = false)

Set a "where in" clause for a pivot table column.

from BelongsToMany

$this

orWherePivot(string|Expression $column, mixed $operator = null, mixed $value = null)

Set an "or where" clause for a pivot table column.

from BelongsToMany

$this

withPivotValue(string|Expression|array<string,string> $column, mixed $value = null)

Set a where clause for a pivot table column.

from BelongsToMany

$this

orWherePivotIn(string $column, mixed $values)

Set an "or where in" clause for a pivot table column.

from BelongsToMany

$this

wherePivotNotIn(string|Expression $column, mixed $values, string $boolean = 'and')

Set a "where not in" clause for a pivot table column.

from BelongsToMany

$this

orWherePivotNotIn(string $column, mixed $values)

Set an "or where not in" clause for a pivot table column.

from BelongsToMany

$this

wherePivotNull(string|Expression $column, string $boolean = 'and', bool $not = false)

Set a "where null" clause for a pivot table column.

from BelongsToMany

$this

wherePivotNotNull(string|Expression $column, string $boolean = 'and')

Set a "where not null" clause for a pivot table column.

from BelongsToMany

$this

orWherePivotNull(string|Expression $column, bool $not = false)

Set a "or where null" clause for a pivot table column.

from BelongsToMany

$this

orWherePivotNotNull(string|Expression $column)

Set a "or where not null" clause for a pivot table column.

from BelongsToMany

$this

orderByPivot(string|Expression $column, string $direction = 'asc')

Add an "order by" clause for a pivot table column.

from BelongsToMany

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

Find a related model by its primary key or return a new instance of the related model.

from BelongsToMany

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

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

from BelongsToMany

firstOrCreate(array $attributes = [], array $values = [], array $joining = [], bool $touch = true)

Get the first record matching the attributes. If the record is not found, create it.

from BelongsToMany

createOrFirst(array $attributes = [], array $values = [], array $joining = [], bool $touch = true)

Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.

from BelongsToMany

updateOrCreate(array $attributes, array $values = [], array $joining = [], bool $touch = true)

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

from BelongsToMany

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

Find a related model by its primary key.

from BelongsToMany

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

Find a sole related model by its primary key.

from BelongsToMany

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

Find multiple related models by their primary keys.

from BelongsToMany

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

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

from BelongsToMany

findOr($id, $columns = ['*'], Closure|null $callback = null)

No description

from BelongsToMany

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.

from BelongsToMany

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

Execute the query and get the first result.

from BelongsToMany

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

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

from BelongsToMany

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

No description

from BelongsToMany

array

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

Get the select columns for the relation query.

from BelongsToMany

array

aliasedPivotColumns()

Get the pivot columns for the relation.

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

Get a paginator for the "select" statement.

from BelongsToMany

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

Paginate the given query into a simple paginator.

from BelongsToMany

cursorPaginate(int|null $perPage = null, array $columns = ['*'], string $cursorName = 'cursor', string|null $cursor = null)

Paginate the given query into a cursor paginator.

from BelongsToMany

bool

chunk(int $count, callable $callback)

Chunk the results of the query.

from BelongsToMany

bool

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

Chunk the results of a query by comparing numeric IDs.

from BelongsToMany

bool

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

Chunk the results of a query by comparing IDs in descending order.

from BelongsToMany

bool

eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

Execute a callback over each item while chunking by ID.

from BelongsToMany

bool

orderedChunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null, bool $descending = false)

Chunk the results of a query by comparing IDs in a given order.

from BelongsToMany

bool

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

Execute a callback over each item while chunking.

from BelongsToMany

lazy(int $chunkSize = 1000)

Query lazily, by chunks of the given size.

from BelongsToMany

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

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

from BelongsToMany

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

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

from BelongsToMany

cursor()

Get a lazy collection for the given query.

from BelongsToMany

TRelatedModel>

prepareQueryBuilder()

Prepare the query builder for query execution.

from BelongsToMany

void

hydratePivotRelation(array $models)

Hydrate the pivot table relationship on the models.

from BelongsToMany

array

migratePivotAttributes(Model $model)

Get the pivot attributes from a model.

from BelongsToMany

void

touchIfTouching()

If we're touching the parent model, touch.

from BelongsToMany

bool

touchingParent()

Determine if we should touch the parent on sync.

from BelongsToMany

string

guessInverseRelation()

Attempt to guess the name of the inverse of the relation.

from BelongsToMany

Collection<int,int|string>

allRelatedIds()

Get all of the IDs for the related models.

from BelongsToMany

save(Model $model, array $pivotAttributes = [], bool $touch = true)

Save a new model and attach it to the parent model.

from BelongsToMany

saveQuietly(Model $model, array $pivotAttributes = [], bool $touch = true)

Save a new model without raising any events and attach it to the parent model.

from BelongsToMany

TContainer

saveMany(TContainer $models, array $pivotAttributes = [])

Save an array of new models and attach them to the parent model.

from BelongsToMany

TContainer

saveManyQuietly(TContainer $models, array $pivotAttributes = [])

Save an array of new models without raising any events and attach them to the parent model.

from BelongsToMany

create(array $attributes = [], array $joining = [], bool $touch = true)

Create a new instance of the related model.

from BelongsToMany

createMany(iterable $records, array $joinings = [])

Create an array of new instances of the related models.

from BelongsToMany

TRelatedModel>

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

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

from BelongsToMany

$this

take(int $value)

Alias to set the "limit" value of the query.

from BelongsToMany

$this

limit(int $value)

Set the "limit" value of the query.

from BelongsToMany

string

getExistenceCompareKey()

Get the key for comparing against the parent key in "has" query.

from BelongsToMany

$this

withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)

Specify that the pivot table has creation and update timestamps.

from BelongsToMany

string

getForeignPivotKeyName()

Get the foreign key for the relation.

from BelongsToMany

string

getQualifiedForeignPivotKeyName()

Get the fully qualified foreign key for the relation.

from BelongsToMany

string

getRelatedPivotKeyName()

Get the "related key" for the relation.

from BelongsToMany

string

getQualifiedRelatedPivotKeyName()

Get the fully qualified "related key" for the relation.

from BelongsToMany

string

getParentKeyName()

Get the parent key for the relationship.

from BelongsToMany

string

getRelatedKeyName()

Get the related key for the relationship.

from BelongsToMany

string

getQualifiedRelatedKeyName()

Get the fully qualified related key name for the relation.

from BelongsToMany

string

getTable()

Get the intermediate table for the relationship.

from BelongsToMany

string

getRelationName()

Get the relationship name for the relationship.

from BelongsToMany

TAccessor

getPivotAccessor()

Get the name of the pivot accessor for this relationship.

from BelongsToMany

array

getPivotColumns()

Get the pivot columns for this relationship.

from BelongsToMany

string|Expression

qualifyPivotColumn(string|Expression $column)

Qualify the given column name by the pivot table.

from BelongsToMany

string

getMorphType()

Get the foreign key "type" name.

string

getQualifiedMorphTypeName()

Get the fully qualified morph type for the relation.

TRelatedModel>

getMorphClass()

Get the class name of the parent model.

bool

getInverse()

Get the indicator for a reverse relationship.

Details

in ForwardsCalls at line 20
`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

in ForwardsCalls at line 50
`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

in ForwardsCalls at line 65
`static protected never throwBadMethodCallException(string $method)`

Throw a bad method call exception for the given method.

Parameters

string

$method

Return Value

never

Exceptions

BadMethodCallException

in Macroable at line 29
`static void macro(string $name, object|callable $macro)`

Parameters

string	$name
object\|callable	$macro

Return Value

void

in Macroable at line 43
`static void mixin(object $mixin, bool $replace = true)`

Mix another object into the class.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
`static bool hasMacro(string $name)`

Checks if macro is registered.

Parameters

string

$name

Return Value

bool

in Macroable at line 72
`static void flushMacros()`

Flush the existing macros.

Return Value

void

in Macroable at line 86
`static mixed __callStatic(string $method, array $parameters)`

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
`mixed __call(string $method, array $parameters)`

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 57
`__construct(Builder $query, Model $parent, string $name, string|TRelatedModel> $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)`

Create a new morph to many relationship instance.

Parameters

Builder	$query
Model	$parent
string	$name
string\|TRelatedModel>	$table
string	$foreignPivotKey
string	$relatedPivotKey
string	$parentKey
string	$relatedKey
string\|null	$relationName
bool	$inverse

in Relation at line 109
`static noConstraints(Closure $callback)`

No description

Parameters

Closure

$callback

in BelongsToMany at line 208
`void addConstraints()`

Set the base constraints on the relation query.

Return Value

void

at line 94
`void addEagerConstraints(array $models)`

No description

Parameters

array

$models

Return Value

void

in BelongsToMany at line 267
`TDeclaringModel> initRelation(array $models, string $relation)`

No description

Parameters

array	$models
string	$relation

Return Value

TDeclaringModel>

in BelongsToMany at line 277
`TDeclaringModel> match(array $models, Collection $results, string $relation)`

No description

Parameters

array	$models
Collection	$results
string	$relation

Return Value

TDeclaringModel>

in BelongsToMany at line 891
`TResult getResults()`

No description

Return Value

TResult

in Relation at line 171
`TRelatedModel> getEager()`

Get the relationship for eager loading.

Return Value

TRelatedModel>

in Relation at line 187
`TRelatedModel 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

TRelatedModel

Exceptions

TRelatedModel>
MultipleRecordsFoundException

in BelongsToMany at line 899
`TRelatedModel> get(array $columns = ['*'])`

No description

Parameters

array

$columns

Return Value

TRelatedModel>

in BelongsToMany at line 1291
`void touch()`

Touch all of the related models for the relationship.

E.g.: Touch all roles associated with this user.

Return Value

void

in Relation at line 237
`int rawUpdate(array $attributes = [])`

Run a raw update against the base query.

Parameters

array

$attributes

Return Value

int

in Relation at line 249
`TRelatedModel> getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)`

Add the constraints for a relationship count query.

Parameters

Builder	$query
Builder	$parentQuery

Return Value

TRelatedModel>

at line 116
`TRelatedModel> getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])`

No description

Parameters

Builder	$query
Builder	$parentQuery
array\|mixed	$columns

Return Value

TRelatedModel>

in Relation at line 279
`string getRelationCountHash(bool $incrementJoinCount = true)`

Get a relationship join table hash.

Parameters

bool

$incrementJoinCount

Return Value

string

in Relation at line 291
`protected array<int,int|string|null> 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<int,int|string|null>

in Relation at line 303
`protected TRelatedModel> getRelationQuery()`

Get the query builder that will contain the relationship constraints.

Return Value

TRelatedModel>

in Relation at line 313
`TRelatedModel> getQuery()`

Get the underlying query for the relation.

Return Value

TRelatedModel>

in Relation at line 323
`Builder getBaseQuery()`

Get the base query builder driving the Eloquent builder.

Return Value

Builder

in Relation at line 333
`Builder toBase()`

Get a base query builder instance.

Return Value

Builder

in Relation at line 343
`TDeclaringModel getParent()`

Get the parent model of the relation.

Return Value

TDeclaringModel

in BelongsToMany at line 1602
`string getQualifiedParentKeyName()`

Get the fully qualified parent key name for the relation.

Return Value

string

in Relation at line 363
`TRelatedModel getRelated()`

Get the related model of the relation.

Return Value

TRelatedModel

in BelongsToMany at line 1532
`string createdAt()`

Get the name of the "created at" column.

Return Value

string

in BelongsToMany at line 1542
`string updatedAt()`

Get the name of the "updated at" column.

Return Value

string

in Relation at line 393
`string relatedUpdatedAt()`

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

Return Value

string

in Relation at line 407
`protected void whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)`

Add a whereIn eager constraint for the given set of model keys to be loaded.

Parameters

string	$whereIn
string	$key
array	$modelKeys
Builder\|null	$query

Return Value

void

in Relation at line 423
`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

in Relation at line 437
`static void requireMorphMap(bool $requireMorphMap = true)`

Prevent polymorphic relationships from being used without model mappings.

Parameters

bool

$requireMorphMap

Return Value

void

in Relation at line 447
`static bool requiresMorphMap()`

Determine if polymorphic relationships require explicit model mapping.

Return Value

bool

in Relation at line 459
`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

in Relation at line 473
`static Model>> morphMap(array|null $map = null, bool $merge = true)`

Set or get the morph map for polymorphic relations.

Parameters

array\|null	$map
bool	$merge

Return Value

Model>>

in Relation at line 492
`static protected Model>>|null buildMorphMapFromModels(array|null $models = null)`

Builds a table-keyed array from model class names.

Parameters

array|null

$models

Return Value

Model>>|null

in Relation at line 509
`static Model>|null getMorphedModel(string $alias)`

Get the model associated with a custom polymorphic type.

Parameters

string

$alias

Return Value

Model>|null

in Relation at line 520
`static int|string getMorphAlias(string $className)`

Get the alias associated with a custom polymorphic class.

Parameters

string

$className

Return Value

int|string

in Relation at line 546
`void __clone()`

Force a clone of the underlying query builder when cloning.

Return Value

void

in InteractsWithDictionary at line 20
`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

in InteractsWithPivotTable at line 22
`array toggle(mixed $ids, bool $touch = true)`

Toggles a model (or models) from the parent.

Each existing model is detached, and non existing ones are attached.

Parameters

mixed	$ids
bool	$touch

Return Value

array

in InteractsWithPivotTable at line 72
`syncWithoutDetaching(Collection|Model|array $ids)`

Sync the intermediate tables with a list of IDs without detaching.

Parameters

Collection|Model|array

$ids

in InteractsWithPivotTable at line 84
`sync(Collection|Model|array $ids, bool $detaching = true)`

Sync the intermediate tables with a list of IDs or collection of models.

Parameters

Collection\|Model\|array	$ids
bool	$detaching

in InteractsWithPivotTable at line 138
`syncWithPivotValues(Collection|Model|array $ids, array $values, bool $detaching = true)`

Sync the intermediate tables with a list of IDs or collection of models with the given pivot values.

Parameters

Collection\|Model\|array	$ids
array	$values
bool	$detaching

in InteractsWithPivotTable at line 151
`protected array formatRecordsList(array $records)`

Format the sync / toggle record list so that it is keyed by ID.

Parameters

array

$records

Return Value

array

in InteractsWithPivotTable at line 174
`protected array attachNew(array $records, array $current, bool $touch = true)`

Attach all of the records that aren't in the given current records.

Parameters

array	$records
array	$current
bool	$touch

Return Value

array

in InteractsWithPivotTable at line 208
`int updateExistingPivot(mixed $id, array $attributes, bool $touch = true)`

Update an existing pivot record on the table.

Parameters

mixed	$id
array	$attributes
bool	$touch

Return Value

int

in InteractsWithPivotTable at line 240
`protected int updateExistingPivotUsingCustomClass(mixed $id, array $attributes, bool $touch)`

Update an existing pivot record on the table via a custom class.

Parameters

mixed	$id
array	$attributes
bool	$touch

Return Value

int

in InteractsWithPivotTable at line 268
`void attach(mixed $ids, array $attributes = [], bool $touch = true)`

Attach a model to the parent.

Parameters

mixed	$ids
array	$attributes
bool	$touch

Return Value

void

in InteractsWithPivotTable at line 293
`protected void attachUsingCustomClass(mixed $ids, array $attributes)`

Attach a model to the parent using a custom class.

Parameters

mixed	$ids
array	$attributes

Return Value

void

in InteractsWithPivotTable at line 311
`protected array formatAttachRecords(array $ids, array $attributes)`

Create an array of records to insert into the pivot table.

Parameters

array	$ids
array	$attributes

Return Value

array

in InteractsWithPivotTable at line 339
`protected array formatAttachRecord(int $key, mixed $value, array $attributes, bool $hasTimestamps)`

Create a full attachment record payload.

Parameters

int	$key
mixed	$value
array	$attributes
bool	$hasTimestamps

Return Value

array

in InteractsWithPivotTable at line 356
`protected array extractAttachIdAndAttributes(mixed $key, mixed $value, array $attributes)`

Get the attach record ID and extra attributes.

Parameters

mixed	$key
mixed	$value
array	$attributes

Return Value

array

at line 108
`protected array baseAttachRecord(int $id, bool $timed)`

Create a new pivot attachment record.

Parameters

int	$id
bool	$timed

Return Value

array

in InteractsWithPivotTable at line 397
`protected array addTimestampsToAttachment(array $record, bool $exists = false)`

Set the creation and update timestamps on an attach record.

Parameters

array	$record
bool	$exists

Return Value

array

in InteractsWithPivotTable at line 424
`bool hasPivotColumn(string $column)`

Determine whether the given column is defined as a pivot column.

Parameters

string

$column

Return Value

bool

in InteractsWithPivotTable at line 436
`int detach(mixed $ids = null, bool $touch = true)`

Detach models from the relationship.

Parameters

mixed	$ids
bool	$touch

Return Value

int

in InteractsWithPivotTable at line 479
`protected int detachUsingCustomClass(mixed $ids)`

Detach models from the relationship using a custom class.

Parameters

mixed

$ids

Return Value

int

at line 128
`protected Collection getCurrentlyAttachedPivots()`

Get the pivot models that are currently attached.

Return Value

Collection

at line 155
`Pivot newPivot(array $attributes = [], bool $exists = false)`

Create a new pivot model instance.

Parameters

array	$attributes
bool	$exists

Return Value

Pivot

in InteractsWithPivotTable at line 537
`Pivot newExistingPivot(array $attributes = [])`

Create a new existing pivot model instance.

Parameters

array

$attributes

Return Value

Pivot

in InteractsWithPivotTable at line 547
`Builder newPivotStatement()`

Get a new plain query builder for the pivot table.

Return Value

Builder

in InteractsWithPivotTable at line 558
`Builder newPivotStatementForId(mixed $id)`

Get a new pivot statement for a given "other" ID.

Parameters

mixed

$id

Return Value

Builder

at line 143
`Builder newPivotQuery()`

Create a new query builder for the pivot table.

Return Value

Builder

in InteractsWithPivotTable at line 593
`$this withPivot(array|mixed $columns)`

Set the columns on the pivot table to retrieve.

Parameters

array|mixed

$columns

Return Value

$this

in InteractsWithPivotTable at line 608
`protected array parseIds(mixed $value)`

Get all of the IDs from the given mixed value.

Parameters

mixed

$value

Return Value

array

in InteractsWithPivotTable at line 633
`protected mixed parseId(mixed $value)`

Get the ID from the given mixed value.

Parameters

mixed

$value

Return Value

mixed

in InteractsWithPivotTable at line 644
`protected array castKeys(array $keys)`

Cast the given keys to integers if they are numeric and string otherwise.

Parameters

array

$keys

Return Value

array

in InteractsWithPivotTable at line 657
`protected mixed castKey(mixed $key)`

Cast the given key to convert to primary key type.

Parameters

mixed

$key

Return Value

mixed

in InteractsWithPivotTable at line 671
`protected array castAttributes(array $attributes)`

Cast the given pivot attributes.

Parameters

array

$attributes

Return Value

array

in InteractsWithPivotTable at line 685
`protected mixed getTypeSwapValue(string $type, mixed $value)`

Converts a given value to a given type value.

Parameters

string	$type
mixed	$value

Return Value

mixed

in BelongsToMany at line 184
`protected string resolveTableName(string $table)`

Attempt to resolve the intermediate table name from the given string.

Parameters

string

$table

Return Value

string

in BelongsToMany at line 223
`protected $this performJoin(TRelatedModel>|null $query = null)`

Set the join clause for the relation query.

Parameters

TRelatedModel>|null

$query

Return Value

$this

at line 84
`protected $this addWhereConstraints()`

Set the where clause for the relation query.

Return Value

$this

in BelongsToMany at line 303
`protected TRelatedModel>[] buildDictionary(Collection $results)`

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

Parameters

Collection

$results

Return Value

TRelatedModel>[]

in BelongsToMany at line 324
`TPivotModel> getPivotClass()`

Get the class being used for pivot models.

Return Value

TPivotModel>

in BelongsToMany at line 339
`$this using(TNewPivotModel> $class)`

Specify the custom pivot model to use for the relationship.

Parameters

TNewPivotModel>

$class

Return Value

$this

in BelongsToMany at line 356
`$this as(TNewAccessor $accessor)`

Specify the custom pivot accessor to use for the relationship.

Parameters

TNewAccessor

$accessor

Return Value

$this

in BelongsToMany at line 372
`$this wherePivot(string|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')`

Set a where clause for a pivot table column.

Parameters

string\|Expression	$column
mixed	$operator
mixed	$value
string	$boolean

Return Value

$this

in BelongsToMany at line 388
`$this wherePivotBetween(string|Expression $column, array $values, string $boolean = 'and', bool $not = false)`

Set a "where between" clause for a pivot table column.

Parameters

string\|Expression	$column
array	$values
string	$boolean
bool	$not

Return Value

$this

in BelongsToMany at line 400
`$this orWherePivotBetween(string|Expression $column, array $values)`

Set a "or where between" clause for a pivot table column.

Parameters

string\|Expression	$column
array	$values

Return Value

$this

in BelongsToMany at line 413
`$this wherePivotNotBetween(string|Expression $column, array $values, string $boolean = 'and')`

Set a "where pivot not between" clause for a pivot table column.

Parameters

string\|Expression	$column
array	$values
string	$boolean

Return Value

$this

in BelongsToMany at line 425
`$this orWherePivotNotBetween(string|Expression $column, array $values)`

Set a "or where not between" clause for a pivot table column.

Parameters

string\|Expression	$column
array	$values

Return Value

$this

in BelongsToMany at line 439
`$this wherePivotIn(string|Expression $column, mixed $values, string $boolean = 'and', bool $not = false)`

Set a "where in" clause for a pivot table column.

Parameters

string\|Expression	$column
mixed	$values
string	$boolean
bool	$not

Return Value

$this

in BelongsToMany at line 454
`$this orWherePivot(string|Expression $column, mixed $operator = null, mixed $value = null)`

Set an "or where" clause for a pivot table column.

Parameters

string\|Expression	$column
mixed	$operator
mixed	$value

Return Value

$this

in BelongsToMany at line 470
`$this withPivotValue(string|Expression|array<string,string> $column, mixed $value = null)`

Set a where clause for a pivot table column.

In addition, new pivot records will receive this value.

Parameters

string\|Expression\|array<string,string>	$column
mixed	$value

Return Value

$this

Exceptions

InvalidArgumentException

in BelongsToMany at line 496
`$this orWherePivotIn(string $column, mixed $values)`

Set an "or where in" clause for a pivot table column.

Parameters

string	$column
mixed	$values

Return Value

$this

in BelongsToMany at line 509
`$this wherePivotNotIn(string|Expression $column, mixed $values, string $boolean = 'and')`

Set a "where not in" clause for a pivot table column.

Parameters

string\|Expression	$column
mixed	$values
string	$boolean

Return Value

$this

in BelongsToMany at line 521
`$this orWherePivotNotIn(string $column, mixed $values)`

Set an "or where not in" clause for a pivot table column.

Parameters

string	$column
mixed	$values

Return Value

$this

in BelongsToMany at line 534
`$this wherePivotNull(string|Expression $column, string $boolean = 'and', bool $not = false)`

Set a "where null" clause for a pivot table column.

Parameters

string\|Expression	$column
string	$boolean
bool	$not

Return Value

$this

in BelongsToMany at line 548
`$this wherePivotNotNull(string|Expression $column, string $boolean = 'and')`

Set a "where not null" clause for a pivot table column.

Parameters

string\|Expression	$column
string	$boolean

Return Value

$this

in BelongsToMany at line 560
`$this orWherePivotNull(string|Expression $column, bool $not = false)`

Set a "or where null" clause for a pivot table column.

Parameters

string\|Expression	$column
bool	$not

Return Value

$this

in BelongsToMany at line 571
`$this orWherePivotNotNull(string|Expression $column)`

Set a "or where not null" clause for a pivot table column.

Parameters

string|Expression

$column

Return Value

$this

in BelongsToMany at line 583
`$this orderByPivot(string|Expression $column, string $direction = 'asc')`

Add an "order by" clause for a pivot table column.

Parameters

string\|Expression	$column
string	$direction

Return Value

$this

in BelongsToMany at line 599
`findOrNew(mixed $id, array $columns = ['*'])`

Find a related model by its primary key or return a new instance of the related model.

Parameters

mixed	$id
array	$columns

in BelongsToMany at line 615
`firstOrNew(array $attributes = [], array $values = [])`

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

Parameters

array	$attributes
array	$values

in BelongsToMany at line 633
`firstOrCreate(array $attributes = [], array $values = [], array $joining = [], bool $touch = true)`

Get the first record matching the attributes. If the record is not found, create it.

Parameters

array	$attributes
array	$values
array	$joining
bool	$touch

in BelongsToMany at line 659
`createOrFirst(array $attributes = [], array $values = [], array $joining = [], bool $touch = true)`

Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.

Parameters

array	$attributes
array	$values
array	$joining
bool	$touch

in BelongsToMany at line 685
`updateOrCreate(array $attributes, array $values = [], array $joining = [], bool $touch = true)`

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

Parameters

array	$attributes
array	$values
array	$joining
bool	$touch

in BelongsToMany at line 707
`find(mixed $id, array $columns = ['*'])`

Find a related model by its primary key.

Parameters

mixed	$id
array	$columns

in BelongsToMany at line 728
`findSole(mixed $id, array $columns = ['*'])`

Find a sole related model by its primary key.

Parameters

mixed	$id
array	$columns

Exceptions

TRelatedModel>
MultipleRecordsFoundException

in BelongsToMany at line 742
`findMany(Arrayable|array $ids, array $columns = ['*'])`

Find multiple related models by their primary keys.

Parameters

Arrayable\|array	$ids
array	$columns

in BelongsToMany at line 768
`findOrFail(mixed $id, array $columns = ['*'])`

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

Parameters

mixed	$id
array	$columns

Exceptions

TRelatedModel>

in BelongsToMany at line 799
`findOr($id, $columns = ['*'], Closure|null $callback = null)`

No description

Parameters

	$id
	$columns
Closure\|null	$callback

in BelongsToMany at line 831
`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

in BelongsToMany at line 842
`first(array $columns = ['*'])`

Execute the query and get the first result.

Parameters

array

$columns

in BelongsToMany at line 857
`firstOrFail(array $columns = ['*'])`

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

Parameters

array

$columns

Exceptions

TRelatedModel>

in BelongsToMany at line 875
`firstOr($columns = ['*'], Closure|null $callback = null)`

No description

Parameters

	$columns
Closure\|null	$callback

in BelongsToMany at line 932
`protected array shouldSelect(array $columns = ['*'])`

Get the select columns for the relation query.

Parameters

array

$columns

Return Value

array

at line 180
`protected array aliasedPivotColumns()`

Get the pivot columns for the relation.

"pivot_" is prefixed at each column for easy removal later.

Return Value

array

in BelongsToMany at line 969
`paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)`

Get a paginator for the "select" statement.

Parameters

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

in BelongsToMany at line 987
`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

in BelongsToMany at line 1005
`cursorPaginate(int|null $perPage = null, array $columns = ['*'], string $cursorName = 'cursor', string|null $cursor = null)`

Paginate the given query into a cursor paginator.

Parameters

int\|null	$perPage
array	$columns
string	$cursorName
string\|null	$cursor

in BelongsToMany at line 1021
`bool chunk(int $count, callable $callback)`

Chunk the results of the query.

Parameters

int	$count
callable	$callback

Return Value

bool

in BelongsToMany at line 1039
`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

in BelongsToMany at line 1053
`bool chunkByIdDesc(int $count, callable $callback, string|null $column = null, string|null $alias = null)`

Chunk the results of a query by comparing IDs in descending order.

Parameters

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

Return Value

bool

in BelongsToMany at line 1067
`bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)`

Execute a callback over each item while chunking by ID.

Parameters

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

Return Value

bool

in BelongsToMany at line 1088
`bool orderedChunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null, bool $descending = false)`

Chunk the results of a query by comparing IDs in a given order.

Parameters

int	$count
callable	$callback
string\|null	$column
string\|null	$alias
bool	$descending

Return Value

bool

in BelongsToMany at line 1110
`bool each(callable $callback, int $count = 1000)`

Execute a callback over each item while chunking.

Parameters

callable	$callback
int	$count

Return Value

bool

in BelongsToMany at line 1127
`lazy(int $chunkSize = 1000)`

Query lazily, by chunks of the given size.

Parameters

int

$chunkSize

in BelongsToMany at line 1144
`lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)`

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

Parameters

int	$chunkSize
string\|null	$column
string\|null	$alias

in BelongsToMany at line 1167
`lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)`

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

Parameters

int	$chunkSize
string\|null	$column
string\|null	$alias

in BelongsToMany at line 1187
`cursor()`

Get a lazy collection for the given query.

in BelongsToMany at line 1201
`protected TRelatedModel> prepareQueryBuilder()`

Prepare the query builder for query execution.

Return Value

TRelatedModel>

in BelongsToMany at line 1212
`protected void hydratePivotRelation(array $models)`

Hydrate the pivot table relationship on the models.

Parameters

array

$models

Return Value

void

in BelongsToMany at line 1230
`protected array migratePivotAttributes(Model $model)`

Get the pivot attributes from a model.

Parameters

Model

$model

Return Value

array

in BelongsToMany at line 1253
`void touchIfTouching()`

If we're touching the parent model, touch.

Return Value

void

in BelongsToMany at line 1269
`protected bool touchingParent()`

Determine if we should touch the parent on sync.

Return Value

bool

in BelongsToMany at line 1279
`protected string guessInverseRelation()`

Attempt to guess the name of the inverse of the relation.

Return Value

string

in BelongsToMany at line 1314
`Collection<int,int|string> allRelatedIds()`

Get all of the IDs for the related models.

Return Value

Collection<int,int|string>

in BelongsToMany at line 1327
`save(Model $model, array $pivotAttributes = [], bool $touch = true)`

Save a new model and attach it to the parent model.

Parameters

Model	$model
array	$pivotAttributes
bool	$touch

in BelongsToMany at line 1344
`saveQuietly(Model $model, array $pivotAttributes = [], bool $touch = true)`

Save a new model without raising any events and attach it to the parent model.

Parameters

Model	$model
array	$pivotAttributes
bool	$touch

in BelongsToMany at line 1360
`TContainer saveMany(TContainer $models, array $pivotAttributes = [])`

Save an array of new models and attach them to the parent model.

Parameters

TContainer	$models
array	$pivotAttributes

Return Value

TContainer

in BelongsToMany at line 1380
`TContainer saveManyQuietly(TContainer $models, array $pivotAttributes = [])`

Save an array of new models without raising any events and attach them to the parent model.

Parameters

TContainer	$models
array	$pivotAttributes

Return Value

TContainer

in BelongsToMany at line 1395
`create(array $attributes = [], array $joining = [], bool $touch = true)`

Create a new instance of the related model.

Parameters

array	$attributes
array	$joining
bool	$touch

in BelongsToMany at line 1418
`createMany(iterable $records, array $joinings = [])`

Create an array of new instances of the related models.

Parameters

iterable	$records
array	$joinings

in BelongsToMany at line 1451
`TRelatedModel> getRelationExistenceQueryForSelfJoin(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

TRelatedModel>

in BelongsToMany at line 1470
`$this take(int $value)`

Alias to set the "limit" value of the query.

Parameters

int

$value

Return Value

$this

in BelongsToMany at line 1481
`$this limit(int $value)`

Set the "limit" value of the query.

Parameters

int

$value

Return Value

$this

in BelongsToMany at line 1505
`string getExistenceCompareKey()`

Get the key for comparing against the parent key in "has" query.

Return Value

string

in BelongsToMany at line 1517
`$this withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)`

Specify that the pivot table has creation and update timestamps.

Parameters

mixed	$createdAt
mixed	$updatedAt

Return Value

$this

in BelongsToMany at line 1552
`string getForeignPivotKeyName()`

Get the foreign key for the relation.

Return Value

string

in BelongsToMany at line 1562
`string getQualifiedForeignPivotKeyName()`

Get the fully qualified foreign key for the relation.

Return Value

string

in BelongsToMany at line 1572
`string getRelatedPivotKeyName()`

Get the "related key" for the relation.

Return Value

string

in BelongsToMany at line 1582
`string getQualifiedRelatedPivotKeyName()`

Get the fully qualified "related key" for the relation.

Return Value

string

in BelongsToMany at line 1592
`string getParentKeyName()`

Get the parent key for the relationship.

Return Value

string

in BelongsToMany at line 1612
`string getRelatedKeyName()`

Get the related key for the relationship.

Return Value

string

in BelongsToMany at line 1622
`string getQualifiedRelatedKeyName()`

Get the fully qualified related key name for the relation.

Return Value

string

in BelongsToMany at line 1632
`string getTable()`

Get the intermediate table for the relationship.

Return Value

string

in BelongsToMany at line 1642
`string getRelationName()`

Get the relationship name for the relationship.

Return Value

string

in BelongsToMany at line 1652
`TAccessor getPivotAccessor()`

Get the name of the pivot accessor for this relationship.

Return Value

TAccessor

in BelongsToMany at line 1662
`array getPivotColumns()`

Get the pivot columns for this relationship.

Return Value

array

in BelongsToMany at line 1673
`string|Expression qualifyPivotColumn(string|Expression $column)`

Qualify the given column name by the pivot table.

Parameters

string|Expression

$column

Return Value

string|Expression

at line 198
`string getMorphType()`

Get the foreign key "type" name.

Return Value

string

at line 208
`string getQualifiedMorphTypeName()`

Get the fully qualified morph type for the relation.

Return Value

string

at line 218
`TRelatedModel> getMorphClass()`

Get the class name of the parent model.

Return Value

TRelatedModel>

at line 228
`bool getInverse()`

Get the indicator for a reverse relationship.

Return Value

bool

MorphToMany

Traits

Properties

Methods

Details

in ForwardsCalls at line 20 protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Parameters

Return Value

Exceptions

in ForwardsCalls at line 50 protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Parameters

Return Value

Exceptions

in ForwardsCalls at line 65 static protected never throwBadMethodCallException(string $method)

Parameters

Return Value

Exceptions

in Macroable at line 29 static void macro(string $name, object|callable $macro)

Parameters

Return Value

in Macroable at line 43 static void mixin(object $mixin, bool $replace = true)

Parameters

Return Value

Exceptions

in Macroable at line 62 static bool hasMacro(string $name)

Parameters

Return Value

in Macroable at line 72 static void flushMacros()

Return Value

in Macroable at line 86 static mixed __callStatic(string $method, array $parameters)

Parameters

Return Value

Exceptions

in Macroable at line 112 mixed __call(string $method, array $parameters)

Parameters

Return Value

Exceptions

at line 57 __construct(Builder $query, Model $parent, string $name, string|TRelatedModel> $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Parameters

in Relation at line 109 static noConstraints(Closure $callback)

Parameters

in BelongsToMany at line 208 void addConstraints()

Return Value

at line 94 void addEagerConstraints(array $models)

Parameters

Return Value

in BelongsToMany at line 267 TDeclaringModel> initRelation(array $models, string $relation)

Parameters

Return Value

in BelongsToMany at line 277 TDeclaringModel> match(array $models, Collection $results, string $relation)

Parameters

Return Value

in BelongsToMany at line 891 TResult getResults()

Return Value

in Relation at line 171 TRelatedModel> getEager()

Return Value

in Relation at line 187 TRelatedModel sole(array|string $columns = ['*'])

Parameters

Return Value

Exceptions

in BelongsToMany at line 899 TRelatedModel> get(array $columns = ['*'])

Parameters

Return Value

in BelongsToMany at line 1291 void touch()

Return Value

in Relation at line 237 int rawUpdate(array $attributes = [])

Parameters

Return Value

in Relation at line 249 TRelatedModel> getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Parameters

Return Value

at line 116 TRelatedModel> getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Parameters

Return Value

in Relation at line 279 string getRelationCountHash(bool $incrementJoinCount = true)

Parameters

Return Value

in Relation at line 291 protected array<int,int|string|null> getKeys(array $models, string|null $key = null)

Parameters

Return Value

in ForwardsCalls at line 20
`protected mixed forwardCallTo(mixed $object, string $method, array $parameters)`

in ForwardsCalls at line 50
`protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)`

in ForwardsCalls at line 65
`static protected never throwBadMethodCallException(string $method)`

in Macroable at line 29
`static void macro(string $name, object|callable $macro)`

in Macroable at line 43
`static void mixin(object $mixin, bool $replace = true)`

in Macroable at line 62
`static bool hasMacro(string $name)`

in Macroable at line 72
`static void flushMacros()`

in Macroable at line 86
`static mixed __callStatic(string $method, array $parameters)`

in Macroable at line 112
`mixed __call(string $method, array $parameters)`

at line 57
`__construct(Builder $query, Model $parent, string $name, string|TRelatedModel> $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)`

in Relation at line 109
`static noConstraints(Closure $callback)`

in BelongsToMany at line 208
`void addConstraints()`

at line 94
`void addEagerConstraints(array $models)`

in BelongsToMany at line 267
`TDeclaringModel> initRelation(array $models, string $relation)`

in BelongsToMany at line 277
`TDeclaringModel> match(array $models, Collection $results, string $relation)`

in BelongsToMany at line 891
`TResult getResults()`

in Relation at line 171
`TRelatedModel> getEager()`

in Relation at line 187
`TRelatedModel sole(array|string $columns = ['*'])`

in BelongsToMany at line 899
`TRelatedModel> get(array $columns = ['*'])`

in BelongsToMany at line 1291
`void touch()`

in Relation at line 237
`int rawUpdate(array $attributes = [])`

in Relation at line 249
`TRelatedModel> getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)`

at line 116
`TRelatedModel> getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])`

in Relation at line 279
`string getRelationCountHash(bool $incrementJoinCount = true)`

in Relation at line 291
`protected array<int,int|string|null> getKeys(array $models, string|null $key = null)`

in Relation at line 303
`protected TRelatedModel> getRelationQuery()`

in Relation at line 313
`TRelatedModel> getQuery()`

in Relation at line 323
`Builder getBaseQuery()`

in Relation at line 333
`Builder toBase()`

in Relation at line 343
`TDeclaringModel getParent()`

in BelongsToMany at line 1602
`string getQualifiedParentKeyName()`

in Relation at line 363
`TRelatedModel getRelated()`

in BelongsToMany at line 1532
`string createdAt()`

in BelongsToMany at line 1542
`string updatedAt()`

in Relation at line 393
`string relatedUpdatedAt()`

in Relation at line 407
`protected void whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)`

in Relation at line 423
`protected string whereInMethod(Model $model, string $key)`

in Relation at line 437
`static void requireMorphMap(bool $requireMorphMap = true)`

in Relation at line 447
`static bool requiresMorphMap()`

in Relation at line 459
`static array enforceMorphMap(array $map, bool $merge = true)`

in Relation at line 473
`static Model>> morphMap(array|null $map = null, bool $merge = true)`

in Relation at line 492
`static protected Model>>|null buildMorphMapFromModels(array|null $models = null)`

in Relation at line 509
`static Model>|null getMorphedModel(string $alias)`

in Relation at line 520
`static int|string getMorphAlias(string $className)`

in Relation at line 546
`void __clone()`

in InteractsWithDictionary at line 20
`protected mixed getDictionaryKey(mixed $attribute)`

in InteractsWithPivotTable at line 22
`array toggle(mixed $ids, bool $touch = true)`

in InteractsWithPivotTable at line 72
`syncWithoutDetaching(Collection|Model|array $ids)`

in InteractsWithPivotTable at line 84
`sync(Collection|Model|array $ids, bool $detaching = true)`

in InteractsWithPivotTable at line 138
`syncWithPivotValues(Collection|Model|array $ids, array $values, bool $detaching = true)`

in InteractsWithPivotTable at line 151
`protected array formatRecordsList(array $records)`

in InteractsWithPivotTable at line 174
`protected array attachNew(array $records, array $current, bool $touch = true)`

in InteractsWithPivotTable at line 208
`int updateExistingPivot(mixed $id, array $attributes, bool $touch = true)`