BelongsToMany

class BelongsToMany extends Relation (View source)

Properties

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 protected 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 $foreignKey The foreign key of the parent model.
protected string $otherKey The associated key of the relation.
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 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.
static protected int $selfJoinCount The count of self joins.

Methods

void __construct(Builder $query, Model $parent, string $table, string $foreignKey, string $otherKey, string $relationName = null)

Create a new belongs to many relationship instance.
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
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 getRelationCountQuery(Builder $query, Builder $parent)

Add the constraints for a relationship count query.

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

Add the constraints for a relationship query.
static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

 from Relation
array getKeys(array $models, string $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.

 from 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 wrap(string $value)

Wrap the given value with the parent query's grammar.

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

Handle dynamic method calls to the relationship.

 from Relation
void __clone()

Force a clone of the underlying query builder when cloning.

 from Relation
BelongsToMany wherePivot(string $column, string $operator = null, mixed $value = null, string $boolean = 'and')

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

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

Set an "or where" clause for a pivot table column.
BelongsToMany orWherePivotIn(string $column, mixed $values)

Set an "or where in" clause for a pivot table column.
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.
Collection get(array $columns = ['*'])

Execute the query as a "select" statement.
LengthAwarePaginator paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Get a paginator for the "select" statement.
Paginator simplePaginate(int $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.
void hydratePivotRelation(array $models)

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

Get the pivot attributes from a model.
Builder getRelationQueryForSelfJoin(Builder $query, Builder $parent, array|mixed $columns = ['*'])

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

Get a relationship join table hash.
BelongsToMany getSelectColumns(array $columns = ['*'])

Set the select clause for the relation query.
array getAliasedPivotColumns()

Get the pivot columns for the relation.
bool hasPivotColumn(string $column)

Determine whether the given column is defined as a pivot column.
$this setJoin(Builder|null $query = null)

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

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

Build model dictionary keyed by the relation's foreign key.
Collection getRelatedIds()

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

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

Save an array of new models and attach them to the parent model.
Model|Collection|null find(mixed $id, array $columns = ['*'])

Find a related model by its primary key.
Collection findMany(mixed $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.
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 create(array $attributes, array $joining = [], bool $touch = true)

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

Create an array of new instances of the related models.
array toggle(mixed $ids, bool $touch = true)

Toggles a model (or models) from the parent.
array syncWithoutDetaching(Collection|array $ids)

Sync the intermediate tables with a list of IDs without detaching.
array sync(Collection|Collection|array $ids, bool $detaching = true)

Sync the intermediate tables with a list of IDs or collection of models.
array formatRecordsList(array $records)

Format the sync/toggle list so that it is keyed by ID.
array attachNew(array $records, array $current, bool $touch = true)

Attach all of the IDs that aren't in the current array.
array castKeys(array $keys)

Cast the given keys to integers if they are numeric and string otherwise.
int updateExistingPivot(mixed $id, array $attributes, bool $touch = true)

Update an existing pivot record on the table.
void attach(mixed $id, array $attributes = [], bool $touch = true)

Attach a model to the parent.
array createAttachRecords(array $ids, array $attributes)

Create an array of records to insert into the pivot table.
array attacher(int $key, mixed $value, array $attributes, bool $timed)

Create a full attachment record payload.
array getAttachId(mixed $key, mixed $value, array $attributes)

Get the attach record ID and extra attributes.
array createAttachRecord(int $id, bool $timed)

Create a new pivot attachment record.
array setTimestampsOnAttach(array $record, bool $exists = false)

Set the creation and update timestamps on an attach record.
int detach(mixed $ids = [], bool $touch = true)

Detach models from the relationship.
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.
Builder newPivotQuery()

Create a new query builder for the pivot table.
Builder newPivotStatement()

Get a new plain query builder for the pivot table.
Builder newPivotStatementForId(mixed $id)

Get a new pivot statement for a given "other" ID.
Pivot newPivot(array $attributes = [], bool $exists = false)

Create a new pivot model instance.
Pivot newExistingPivot(array $attributes = [])

Create a new existing pivot model instance.
$this withPivot(array|mixed $columns)

Set the columns on the pivot table to retrieve.
BelongsToMany withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)

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

Get the related model's updated at column name.
string getHasCompareKey()

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

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

Get the fully qualified "other key" for the relation.
string getTable()

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

Get the relationship name for the relationship.

Details

void __construct(Builder $query, Model $parent, string $table, string $foreignKey, string $otherKey, string $relationName = null)

Create a new belongs to many relationship instance.

Parameters

Builder $query
Model $parent
string $table
string $foreignKey
string $otherKey
string $relationName

Return Value

void

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

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 getRelationCountQuery(Builder $query, Builder $parent)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parent

Return Value

Builder

Builder getRelationQuery(Builder $query, Builder $parent, array|mixed $columns = ['*'])

Add the constraints for a relationship query.

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

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

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

Parameters

array $models
string $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.

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

string wrap(string $value)

Wrap the given value with the parent query's grammar.

Parameters

string $value

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

mixed __call(string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

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

Set a where clause for a pivot table column.

Parameters

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

Return Value

BelongsToMany

BelongsToMany 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

BelongsToMany

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

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

Parameters

string $column
string $operator
mixed $value

Return Value

BelongsToMany

BelongsToMany orWherePivotIn(string $column, mixed $values)

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

Parameters

string $column
mixed $values

Return Value

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

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

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

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

Get a paginator for the "select" statement.

Parameters

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

Return Value

LengthAwarePaginator

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

Paginate the given query into a simple paginator.

Parameters

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

Return Value

Paginator

bool chunk(int $count, callable $callback)

Chunk the results of the query.

Parameters

int $count
callable $callback

Return Value

bool

protected void hydratePivotRelation(array $models)

Hydrate the pivot table relationship on the models.

Parameters

array $models

Return Value

void

protected array cleanPivotAttributes(Model $model)

Get the pivot attributes from a model.

Parameters

Model $model

Return Value

array

Builder getRelationQueryForSelfJoin(Builder $query, Builder $parent, array|mixed $columns = ['*'])

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

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

protected BelongsToMany getSelectColumns(array $columns = ['*'])

Set the select clause for the relation query.

Parameters

array $columns

Return Value

BelongsToMany

protected array getAliasedPivotColumns()

Get the pivot columns for the relation.

Return Value

array

protected bool hasPivotColumn(string $column)

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

Parameters

string $column

Return Value

bool

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

Set the join clause for the relation query.

Parameters

Builder|null $query

Return Value

$this

protected $this setWhere()

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

Collection getRelatedIds()

Get all of the IDs for the related models.

Return Value

Collection

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

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

Parameters

Model $model
array $joining
bool $touch

Return Value

Model

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

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

Parameters

Collection|array $models
array $joinings

Return Value

array

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(mixed $ids, array $columns = ['*'])

Find multiple related models by their primary keys.

Parameters

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

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 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(array $records, array $joinings = [])

Create an array of new instances of the related models.

Parameters

array $records
array $joinings

Return Value

array

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|array $ids)

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

Parameters

Collection|array $ids

Return Value

array

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

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

Parameters

Collection|Collection|array $ids
bool $detaching

Return Value

array

protected array formatRecordsList(array $records)

Format the sync/toggle 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 IDs that aren't in the current array.

Parameters

array $records
array $current
bool $touch

Return Value

array

protected array castKeys(array $keys)

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

Parameters

array $keys

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

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 array createAttachRecords(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 attacher(int $key, mixed $value, array $attributes, bool $timed)

Create a full attachment record payload.

Parameters

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

Return Value

array

protected array getAttachId(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 createAttachRecord(int $id, bool $timed)

Create a new pivot attachment record.

Parameters

int $id
bool $timed

Return Value

array

protected array setTimestampsOnAttach(array $record, bool $exists = false)

Set the creation and update timestamps on an attach record.

Parameters

array $record
bool $exists

Return Value

array

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

Detach models from the relationship.

Parameters

mixed $ids
bool $touch

Return Value

int

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

protected Builder newPivotQuery()

Create a new query builder for the pivot table.

Return Value

Builder

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

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

$this withPivot(array|mixed $columns)

Set the columns on the pivot table to retrieve.

Parameters

array|mixed $columns

Return Value

$this

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

Specify that the pivot table has creation and update timestamps.

Parameters

mixed $createdAt
mixed $updatedAt

Return Value

BelongsToMany

string getRelatedFreshUpdate()

Get the related model's updated at column name.

Return Value

string

string getHasCompareKey()

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

Return Value

string

string getForeignKey()

Get the fully qualified foreign key for the relation.

Return Value

string

string getOtherKey()

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

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

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