BelongsToMany
class BelongsToMany extends Relation
Traits
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 |
| protected Model | $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 | $relatedKey | 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. |
|
| protected string | $using | The class name of the custom pivot model to use for the relationship. |
|
| static protected int | $selfJoinCount | The count of self joins. |
Methods
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new belongs to many relationship instance.
Set the base constraints on the relation query.
Set the constraints for an eager load of the relation.
Initialize the relation on a set of models.
Match the eagerly loaded results to their parents.
Get the results of the relationship.
Touch all of the related models for the relationship.
Add the constraints for a relationship count query.
Add the constraints for a relationship query.
Get all of the primary keys for an array of models.
Get the name of the "created at" column.
Get the name of the "updated at" column.
Set or get the morph map for polymorphic relations.
Builds a table-keyed array from model class names.
Get the model associated with a custom polymorphic type.
Toggles a model (or models) from the parent.
Sync the intermediate tables with a list of IDs without detaching.
Sync the intermediate tables with a list of IDs or collection of models.
Format the sync / toggle record list so that it is keyed by ID.
Attach all of the records that aren't in the given current records.
Update an existing pivot record on the table.
Attach a model to the parent.
Create an array of records to insert into the pivot table.
Create a full attachment record payload.
Get the attach record ID and extra attributes.
Create a new pivot attachment record.
Set the creation and update timestamps on an attach record.
Determine whether the given column is defined as a pivot column.
Detach models from the relationship.
Create a new pivot model instance.
Create a new existing pivot model instance.
Get a new plain query builder for the pivot table.
Get a new pivot statement for a given "other" ID.
Create a new query builder for the pivot table.
Set the columns on the pivot table to retrieve.
Get all of the IDs from the given mixed value.
Cast the given keys to integers if they are numeric and string otherwise.
Cast the given key to an integer if it is numeric.
Set the where clause for the relation query.
Specify the custom pivot model to use for the relationship.
Set a where clause for a pivot table column.
Set a "where in" clause for a pivot table column.
Set an "or where" clause for a pivot table column.
Set an "or where in" clause for a pivot table column.
Find a related model by its primary key or return new instance of the related model.
Get the first related model record matching the attributes or instantiate it.
Get the first related record matching the attributes or create it.
Create or update a related record matching the attributes, and fill it with values.
Find a related model by its primary key.
Find multiple related models by their primary keys.
Find a related model by its primary key or throw an exception.
Execute the query and get the first result.
Execute the query and get the first result or throw an exception.
Execute the query as a "select" statement.
Get the select columns for the relation query.
Get the pivot columns for the relation.
Get a paginator for the "select" statement.
Paginate the given query into a simple paginator.
Chunk the results of the query.
Hydrate the pivot table relationship on the models.
If we're touching the parent model, touch.
Determine if we should touch the parent on sync.
Attempt to guess the name of the inverse of the relation.
Get all of the IDs for the related models.
Save an array of new models and attach them to the parent model.
Create a new instance of the related model.
Create an array of new instances of the related models.
Add the constraints for a relationship query on the same table.
Get the key for comparing against the parent key in "has" query.
Get a relationship join table hash.
Specify that the pivot table has creation and update timestamps.
Get the fully qualified foreign key for the relation.
Get the fully qualified "related key" for the relation.
Get the intermediate table for the relationship.
Get the relationship name for the relationship.
Details
in
Macroable at line 24
static void
macro(string $name, callable $macro)
Register a custom macro.
in
Macroable at line 35
static bool
hasMacro(string $name)
Checks if macro is registered.
in
Macroable at line 49
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 71
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 104
void
__construct(Builder $query, Model $parent, string $table, string $foreignKey, string $relatedKey, string $relationName = null)
Create a new belongs to many relationship instance.
in
Relation at line 79
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
at line 119
void
addConstraints()
Set the base constraints on the relation query.
at line 170
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
at line 182
array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
at line 199
array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
at line 464
mixed
getResults()
Get the results of the relationship.
in
Relation at line 141
Collection
getEager()
Get the relationship for eager loading.
at line 670
void
touch()
Touch all of the related models for the relationship.
E.g.: Touch all roles associated with this user.
in
Relation at line 164
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
in
Relation at line 176
Builder
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
at line 785
Builder
getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query.
in
Relation at line 207
protected array
getKeys(array $models, string $key = null)
Get all of the primary keys for an array of models.
in
Relation at line 229
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
in
Relation at line 249
string
getQualifiedParentKeyName()
Get the fully qualified parent key name.
at line 857
string
createdAt()
Get the name of the "created at" column.
at line 867
string
updatedAt()
Get the name of the "updated at" column.
in
Relation at line 289
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
in
Relation at line 301
static array
morphMap(array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
in
Relation at line 319
static protected array|null
buildMorphMapFromModels(array $models = null)
Builds a table-keyed array from model class names.
in
Relation at line 336
static string|null
getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
in
Relation at line 370
void
__clone()
Force a clone of the underlying query builder when cloning.
in
InteractsWithPivotTable at line 20
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.
in
InteractsWithPivotTable at line 70
array
syncWithoutDetaching(Collection|array $ids)
Sync the intermediate tables with a list of IDs without detaching.
in
InteractsWithPivotTable at line 82
array
sync(Collection|Collection|array $ids, bool $detaching = true)
Sync the intermediate tables with a list of IDs or collection of models.
in
InteractsWithPivotTable at line 132
protected array
formatRecordsList(array $records)
Format the sync / toggle record list so that it is keyed by ID.
in
InteractsWithPivotTable at line 151
protected array
attachNew(array $records, array $current, bool $touch = true)
Attach all of the records that aren't in the given current records.
in
InteractsWithPivotTable at line 185
int
updateExistingPivot(mixed $id, array $attributes, bool $touch = true)
Update an existing pivot record on the table.
in
InteractsWithPivotTable at line 208
void
attach(mixed $id, array $attributes = [], bool $touch = true)
Attach a model to the parent.
in
InteractsWithPivotTable at line 229
protected array
formatAttachRecords(array $ids, array $attributes)
Create an array of records to insert into the pivot table.
in
InteractsWithPivotTable at line 257
protected array
formatAttachRecord(int $key, mixed $value, array $attributes, bool $hasTimestamps)
Create a full attachment record payload.
in
InteractsWithPivotTable at line 274
protected array
extractAttachIdAndAttributes(mixed $key, mixed $value, array $attributes)
Get the attach record ID and extra attributes.
in
InteractsWithPivotTable at line 288
protected array
baseAttachRecord(int $id, bool $timed)
Create a new pivot attachment record.
in
InteractsWithPivotTable at line 311
protected array
addTimestampsToAttachment(array $record, bool $exists = false)
Set the creation and update timestamps on an attach record.
in
InteractsWithPivotTable at line 332
protected bool
hasPivotColumn(string $column)
Determine whether the given column is defined as a pivot column.
in
InteractsWithPivotTable at line 344
int
detach(mixed $ids = null, bool $touch = true)
Detach models from the relationship.
in
InteractsWithPivotTable at line 380
Pivot
newPivot(array $attributes = [], bool $exists = false)
Create a new pivot model instance.
in
InteractsWithPivotTable at line 395
Pivot
newExistingPivot(array $attributes = [])
Create a new existing pivot model instance.
in
InteractsWithPivotTable at line 405
Builder
newPivotStatement()
Get a new plain query builder for the pivot table.
in
InteractsWithPivotTable at line 416
Builder
newPivotStatementForId(mixed $id)
Get a new pivot statement for a given "other" ID.
in
InteractsWithPivotTable at line 426
protected Builder
newPivotQuery()
Create a new query builder for the pivot table.
in
InteractsWithPivotTable at line 447
$this
withPivot(array|mixed $columns)
Set the columns on the pivot table to retrieve.
in
InteractsWithPivotTable at line 462
protected array
parseIds(mixed $value)
Get all of the IDs from the given mixed value.
in
InteractsWithPivotTable at line 485
protected array
castKeys(array $keys)
Cast the given keys to integers if they are numeric and string otherwise.
in
InteractsWithPivotTable at line 498
protected mixed
castKey(mixed $key)
Cast the given key to an integer if it is numeric.
at line 134
protected $this
performJoin(Builder|null $query = null)
Set the join clause for the relation query.
at line 155
protected $this
addWhereConstraints()
Set the where clause for the relation query.
at line 223
protected array
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
at line 243
BelongsToMany
using(string $class)
Specify the custom pivot model to use for the relationship.
at line 259
BelongsToMany
wherePivot(string $column, string $operator = null, mixed $value = null, string $boolean = 'and')
Set a where clause for a pivot table column.
at line 275
BelongsToMany
wherePivotIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)
Set a "where in" clause for a pivot table column.
at line 290
BelongsToMany
orWherePivot(string $column, string $operator = null, mixed $value = null)
Set an "or where" clause for a pivot table column.
at line 302
BelongsToMany
orWherePivotIn(string $column, mixed $values)
Set an "or where in" clause for a pivot table column.
at line 314
Collection|Model
findOrNew(mixed $id, array $columns = ['*'])
Find a related model by its primary key or return new instance of the related model.
at line 329
Model
firstOrNew(array $attributes)
Get the first related model record matching the attributes or instantiate it.
at line 346
Model
firstOrCreate(array $attributes, array $joining = [], bool $touch = true)
Get the first related record matching the attributes or create it.
at line 364
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.
at line 384
Model|Collection|null
find(mixed $id, array $columns = ['*'])
Find a related model by its primary key.
at line 398
Collection
findMany(mixed $ids, array $columns = ['*'])
Find multiple related models by their primary keys.
at line 414
Model|Collection
findOrFail(mixed $id, array $columns = ['*'])
Find a related model by its primary key or throw an exception.
at line 435
mixed
first(array $columns = ['*'])
Execute the query and get the first result.
at line 450
Model|BelongsToMany
firstOrFail(array $columns = ['*'])
Execute the query and get the first result or throw an exception.
at line 475
Collection
get(array $columns = ['*'])
Execute the query as a "select" statement.
at line 506
protected BelongsToMany
shouldSelect(array $columns = ['*'])
Get the select columns for the relation query.
at line 522
protected array
aliasedPivotColumns()
Get the pivot columns for the relation.
"pivot_" is prefixed ot each column for easy removal later.
at line 540
LengthAwarePaginator
paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Get a paginator for the "select" statement.
at line 558
Paginator
simplePaginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Paginate the given query into a simple paginator.
at line 574
bool
chunk(int $count, callable $callback)
Chunk the results of the query.
at line 591
protected void
hydratePivotRelation(array $models)
Hydrate the pivot table relationship on the models.
at line 609
protected array
migratePivotAttributes(Model $model)
Get the pivot attributes from a model.
at line 632
void
touchIfTouching()
If we're touching the parent model, touch.
at line 648
protected bool
touchingParent()
Determine if we should touch the parent on sync.
at line 658
protected string
guessInverseRelation()
Attempt to guess the name of the inverse of the relation.
at line 691
Collection
allRelatedIds()
Get all of the IDs for the related models.
at line 708
Model
save(Model $model, array $pivotAttributes = [], bool $touch = true)
Save a new model and attach it to the parent model.
at line 724
array
saveMany(Collection|array $models, array $pivotAttributes = [])
Save an array of new models and attach them to the parent model.
at line 743
Model
create(array $attributes, array $joining = [], bool $touch = true)
Create a new instance of the related model.
at line 764
array
createMany(array $records, array $joinings = [])
Create an array of new instances of the related models.
at line 804
Builder
getRelationExistenceQueryForSelfJoin(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
at line 822
string
getExistenceCompareKey()
Get the key for comparing against the parent key in "has" query.
at line 832
string
getRelationCountHash()
Get a relationship join table hash.
at line 844
BelongsToMany
withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)
Specify that the pivot table has creation and update timestamps.
at line 877
string
getQualifiedForeignKeyName()
Get the fully qualified foreign key for the relation.
at line 887
string
getQualifiedRelatedKeyName()
Get the fully qualified "related key" for the relation.
at line 897
string
getTable()
Get the intermediate table for the relationship.
at line 907
string
getRelationName()
Get the relationship name for the relationship.