BelongsToMany

class BelongsToMany extends Relation (View source)

Traits

InteractsWithPivotTable
ForwardsCalls
Macroable

Properties

static protected array $macros The registered string macros. from Macroable
protected Builder $query The Eloquent query builder instance. from Relation
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 database. from Relation
protected string $table The intermediate table for the relation.
protected string $foreignPivotKey The foreign key of the parent model.
protected string $relatedPivotKey The associated key of the relation.
protected string $parentKey The key name of the parent model.
protected string $relatedKey The key name of the related model.
protected string $relationName The "name" of the relationship.
protected array $pivotColumns The pivot table columns to retrieve.
protected array $pivotWheres Any pivot table restrictions for where clauses.
protected array $pivotWhereIns Any pivot table restrictions for whereIn clauses.
protected array $pivotWhereNulls Any pivot table restrictions for whereNull clauses.
protected array $pivotValues The default values for the pivot columns.
bool $withTimestamps Indicates if timestamps are available on the pivot table.
protected string $pivotCreatedAt The custom pivot table column for the created_at timestamp.
protected string $pivotUpdatedAt The custom pivot table column for the updated_at timestamp.
protected string $using The class name of the custom pivot model to use for the relationship.
protected string $accessor The name of the accessor to use for the "pivot" relationship.
static protected int $selfJoinCount The count of self joins.

Methods

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

Forward a method call to the given object.

 from ForwardsCalls
static void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

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

Register a custom 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 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
void __construct(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)

Create a new belongs to many 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.
Collection getEager()

Get the relationship for eager loading.

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

Execute the query as a "select" statement.
void touch()

Touch all of the related models for the relationship.
int rawUpdate(array $attributes = [])

Run a raw update against the base query.

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

Add the constraints for a relationship count query.

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

Add the constraints for a relationship query.
array getKeys(array $models, string|null $key = null)

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

 from Relation
Builder getQuery()

Get the underlying query for the relation.

 from Relation
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

 from Relation
Model getParent()

Get the parent model of the relation.

 from Relation
string getQualifiedParentKeyName()

Get the fully qualified parent key name for the relation.
Model getRelated()

Get the related model of the relation.

 from Relation
string createdAt()

Get the name of the "created at" column.
string updatedAt()

Get the name of the "updated at" column.
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 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
array toggle(mixed $ids, bool $touch = true)

Toggles a model (or models) from the parent.

 from InteractsWithPivotTable
array syncWithoutDetaching(Collection|Model|array $ids)

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

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

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

 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 $id, array $attributes = [], bool $touch = true)

Attach a model to the parent.

 from InteractsWithPivotTable
void attachUsingCustomClass(mixed $id, 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.

 from InteractsWithPivotTable
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.

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

Create a new pivot model instance.

 from InteractsWithPivotTable
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.

 from InteractsWithPivotTable
$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.
$this performJoin(Builder|null $query = null)

Set the join clause for the relation query.
$this addWhereConstraints()

Set the where clause for the relation query.
array buildDictionary(Collection $results)

Build model dictionary keyed by the relation's foreign key.
string getPivotClass()

Get the class being used for pivot models.
$this using(string $class)

Specify the custom pivot model to use for the relationship.
$this as(string $accessor)

Specify the custom pivot accessor to use for the relationship.
$this wherePivot(string $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Set a where clause for a pivot table column.
$this wherePivotBetween(string $column, array $values, string $boolean = 'and', bool $not = false)

Set a "where between" clause for a pivot table column.
$this orWherePivotBetween(string $column, array $values)

Set a "or where between" clause for a pivot table column.
$this wherePivotNotBetween(string $column, array $values, string $boolean = 'and')

Set a "where pivot not between" clause for a pivot table column.
$this orWherePivotNotBetween(string $column, array $values)

Set a "or where not between" clause for a pivot table column.
$this wherePivotIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)

Set a "where in" clause for a pivot table column.
$this orWherePivot(string $column, mixed $operator = null, mixed $value = null)

Set an "or where" clause for a pivot table column.
$this withPivotValue(string|array $column, mixed $value = null)

Set a where clause for a pivot table column.
$this orWherePivotIn(string $column, mixed $values)

Set an "or where in" clause for a pivot table column.
$this wherePivotNotIn(string $column, mixed $values, string $boolean = 'and')

Set a "where not in" clause for a pivot table column.
$this orWherePivotNotIn(string $column, mixed $values)

Set an "or where not in" clause for a pivot table column.
$this wherePivotNull(string $column, string $boolean = 'and', bool $not = false)

Set a "where null" clause for a pivot table column.
$this wherePivotNotNull(string $column, string $boolean = 'and')

Set a "where not null" clause for a pivot table column.
$this orWherePivotNull(string $column, bool $not = false)

Set a "or where null" clause for a pivot table column.
$this orWherePivotNotNull(string $column)

Set a "or where not null" clause for a pivot table column.
Collection|Model findOrNew(mixed $id, array $columns = ['*'])

Find a related model by its primary key or return new instance of the related model.
Model firstOrNew(array $attributes)

Get the first related model record matching the attributes or instantiate it.
Model firstOrCreate(array $attributes, array $joining = [], bool $touch = true)

Get the first related record matching the attributes or create it.
Model updateOrCreate(array $attributes, array $values = [], array $joining = [], bool $touch = true)

Create or update a related record matching the attributes, and fill it with values.
Model|Collection|null find(mixed $id, array $columns = ['*'])

Find a related model by its primary key.
Collection findMany(Arrayable|array $ids, array $columns = ['*'])

Find multiple related models by their primary keys.
Model|Collection findOrFail(mixed $id, array $columns = ['*'])

Find a related model by its primary key or throw an exception.
Model|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.
mixed first(array $columns = ['*'])

Execute the query and get the first result.
Model|BelongsToMany firstOrFail(array $columns = ['*'])

Execute the query and get the first result or throw an exception.
array shouldSelect(array $columns = ['*'])

Get the select columns for the relation query.
array aliasedPivotColumns()

Get the pivot columns for the relation.
LengthAwarePaginator paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Get a paginator for the "select" statement.
Paginator simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Paginate the given query into a simple paginator.
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.
LazyCollection cursor()

Get a lazy collection for the given query.
void hydratePivotRelation(array $models)

Hydrate the pivot table relationship on the models.
array migratePivotAttributes(Model $model)

Get the pivot attributes from a model.
void touchIfTouching()

If we're touching the parent model, touch.
bool touchingParent()

Determine if we should touch the parent on sync.
string guessInverseRelation()

Attempt to guess the name of the inverse of the relation.
Collection allRelatedIds()

Get all of the IDs for the related models.
Model save(Model $model, array $pivotAttributes = [], bool $touch = true)

Save a new model and attach it to the parent model.
array saveMany(Collection|array $models, array $pivotAttributes = [])

Save an array of new models and attach them to the parent model.
Model create(array $attributes = [], array $joining = [], bool $touch = true)

Create a new instance of the related model.
array createMany(iterable $records, array $joinings = [])

Create an array of new instances of the related models.
Builder getRelationExistenceQueryForSelfJoin(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table.
string getExistenceCompareKey()

Get the key for comparing against the parent key in "has" query.
string getRelationCountHash()

Get a relationship join table hash.
$this withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)

Specify that the pivot table has creation and update timestamps.
string getForeignPivotKeyName()

Get the foreign key for the relation.
string getQualifiedForeignPivotKeyName()

Get the fully qualified foreign key for the relation.
string getRelatedPivotKeyName()

Get the "related key" for the relation.
string getQualifiedRelatedPivotKeyName()

Get the fully qualified "related key" for the relation.
string getParentKeyName()

Get the parent key for the relationship.
string getRelatedKeyName()

Get the related key for the relationship.
string getTable()

Get the intermediate table for the relationship.
string getRelationName()

Get the relationship name for the relationship.
string getPivotAccessor()

Get the name of the pivot accessor for this relationship.
array getPivotColumns()

Get the pivot columns for this relationship.

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

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

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 mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(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 $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)

Create a new belongs to many relationship instance.

Parameters

Builder $query
Model $parent
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string|null $relationName

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

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

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

void touch()

Touch all of the related models for the relationship.

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

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

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

Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

Builder getBaseQuery()

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 for the relation.

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

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

array syncWithoutDetaching(Collection|Model|array $ids)

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

Parameters

Collection|Model|array $ids

Return Value

array

array 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

Return Value

array

protected array formatRecordsList(array $records)

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

Parameters

array $records

Return Value

array

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

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

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

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

Attach a model to the parent.

Parameters

mixed $id
array $attributes
bool $touch

Return Value

void

protected void attachUsingCustomClass(mixed $id, array $attributes)

Attach a model to the parent using a custom class.

Parameters

mixed $id
array $attributes

Return Value

void

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

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

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

protected array baseAttachRecord(int $id, bool $timed)

Create a new pivot attachment record.

Parameters

int $id
bool $timed

Return Value

array

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

bool hasPivotColumn(string $column)

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

Parameters

string $column

Return Value

bool

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

Detach models from the relationship.

Parameters

mixed $ids
bool $touch

Return Value

int

protected int detachUsingCustomClass(mixed $ids)

Detach models from the relationship using a custom class.

Parameters

mixed $ids

Return Value

int

protected Collection getCurrentlyAttachedPivots()

Get the pivot models that are currently attached.

Return Value

Collection

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

Create a new pivot model instance.

Parameters

array $attributes
bool $exists

Return Value

Pivot

Pivot newExistingPivot(array $attributes = [])

Create a new existing pivot model instance.

Parameters

array $attributes

Return Value

Pivot

Builder newPivotStatement()

Get a new plain query builder for the pivot table.

Return Value

Builder

Builder newPivotStatementForId(mixed $id)

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

Parameters

mixed $id

Return Value

Builder

Builder newPivotQuery()

Create a new query builder for the pivot table.

Return Value

Builder

$this withPivot(array|mixed $columns)

Set the columns on the pivot table to retrieve.

Parameters

array|mixed $columns

Return Value

$this

protected array parseIds(mixed $value)

Get all of the IDs from the given mixed value.

Parameters

mixed $value

Return Value

array

protected mixed parseId(mixed $value)

Get the ID from the given mixed value.

Parameters

mixed $value

Return Value

mixed

protected array castKeys(array $keys)

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

Parameters

array $keys

Return Value

array

protected mixed castKey(mixed $key)

Cast the given key to convert to primary key type.

Parameters

mixed $key

Return Value

mixed

protected array castAttributes(array $attributes)

Cast the given pivot attributes.

Parameters

array $attributes

Return Value

array

protected mixed getTypeSwapValue(string $type, mixed $value)

Converts a given value to a given type value.

Parameters

string $type
mixed $value

Return Value

mixed

protected string resolveTableName(string $table)

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

Parameters

string $table

Return Value

string

protected $this performJoin(Builder|null $query = null)

Set the join clause for the relation query.

Parameters

Builder|null $query

Return Value

$this

protected $this addWhereConstraints()

Set the where clause for the relation 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

string getPivotClass()

Get the class being used for pivot models.

Return Value

string

$this using(string $class)

Specify the custom pivot model to use for the relationship.

Parameters

string $class

Return Value

$this

$this as(string $accessor)

Specify the custom pivot accessor to use for the relationship.

Parameters

string $accessor

Return Value

$this

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

Set a where clause for a pivot table column.

Parameters

string $column
mixed $operator
mixed $value
string $boolean

Return Value

$this

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

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

Parameters

string $column
array $values
string $boolean
bool $not

Return Value

$this

$this orWherePivotBetween(string $column, array $values)

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

Parameters

string $column
array $values

Return Value

$this

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

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

Parameters

string $column
array $values
string $boolean

Return Value

$this

$this orWherePivotNotBetween(string $column, array $values)

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

Parameters

string $column
array $values

Return Value

$this

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

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

Parameters

string $column
mixed $values
string $boolean
bool $not

Return Value

$this

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

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

Parameters

string $column
mixed $operator
mixed $value

Return Value

$this

$this withPivotValue(string|array $column, mixed $value = null)

Set a where clause for a pivot table column.

In addition, new pivot records will receive this value.

Parameters

string|array $column
mixed $value

Return Value

$this

Exceptions

InvalidArgumentException

$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

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

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

Parameters

string $column
mixed $values
string $boolean

Return Value

$this

$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

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

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

Parameters

string $column
string $boolean
bool $not

Return Value

$this

$this wherePivotNotNull(string $column, string $boolean = 'and')

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

Parameters

string $column
string $boolean

Return Value

$this

$this orWherePivotNull(string $column, bool $not = false)

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

Parameters

string $column
bool $not

Return Value

$this

$this orWherePivotNotNull(string $column)

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

Parameters

string $column

Return Value

$this

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

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

Parameters

mixed $id
array $columns

Return Value

Collection|Model

Model firstOrNew(array $attributes)

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

Parameters

array $attributes

Return Value

Model

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

Get the first related record matching the attributes or create it.

Parameters

array $attributes
array $joining
bool $touch

Return Value

Model

Model 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

Return Value

Model

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

Find a related model by its primary key.

Parameters

mixed $id
array $columns

Return Value

Model|Collection|null

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

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

Parameters

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

Return Value

Model|BelongsToMany

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

Execute the query and get the first result.

Parameters

array $columns

Return Value

mixed

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

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

Parameters

array $columns

Return Value

Model|BelongsToMany

Exceptions

ModelNotFoundException

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

Get the select columns for the relation query.

Parameters

array $columns

Return Value

array

protected array aliasedPivotColumns()

Get the pivot columns for the relation.

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

Return Value

array

LengthAwarePaginator 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

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

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 cursor()

Get a lazy collection for the given query.

Return Value

LazyCollection

protected void hydratePivotRelation(array $models)

Hydrate the pivot table relationship on the models.

Parameters

array $models

Return Value

void

protected array migratePivotAttributes(Model $model)

Get the pivot attributes from a model.

Parameters

Model $model

Return Value

array

void touchIfTouching()

If we're touching the parent model, touch.

Return Value

void

protected bool touchingParent()

Determine if we should touch the parent on sync.

Return Value

bool

protected string guessInverseRelation()

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

Return Value

string

Collection allRelatedIds()

Get all of the IDs for the related models.

Return Value

Collection

Model 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

Return Value

Model

array saveMany(Collection|array $models, array $pivotAttributes = [])

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

Parameters

Collection|array $models
array $pivotAttributes

Return Value

array

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

Create a new instance of the related model.

Parameters

array $attributes
array $joining
bool $touch

Return Value

Model

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

Create an array of new instances of the related models.

Parameters

iterable $records
array $joinings

Return Value

array

Builder 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

Builder

string getExistenceCompareKey()

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

Return Value

string

string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

$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

string getForeignPivotKeyName()

Get the foreign key for the relation.

Return Value

string

string getQualifiedForeignPivotKeyName()

Get the fully qualified foreign key for the relation.

Return Value

string

string getRelatedPivotKeyName()

Get the "related key" for the relation.

Return Value

string

string getQualifiedRelatedPivotKeyName()

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

Return Value

string

string getParentKeyName()

Get the parent key for the relationship.

Return Value

string

string getRelatedKeyName()

Get the related key for the relationship.

Return Value

string

string getTable()

Get the intermediate table for the relationship.

Return Value

string

string getRelationName()

Get the relationship name for the relationship.

Return Value

string

string getPivotAccessor()

Get the name of the pivot accessor for this relationship.

Return Value

string

array getPivotColumns()

Get the pivot columns for this relationship.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Database/Eloquent/Relations/BelongsToMany.html