class BelongsToMany extends Relation (View source)
InteractsWithPivotTable |
Macroable |
static void | macro(string $name, callable $macro) Register a custom macro. | 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 $foreignKey, string $relatedKey, string $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 |
void | touch() Touch all of the related models for the relationship. | |
int | rawUpdate(array $attributes = array()) 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 = array('*')) Add the constraints for a relationship query. | |
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 |
static array | morphMap(array $map = null, bool $merge = true) Set or get the morph map for polymorphic relations. | 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|array $ids) Sync the intermediate tables with a list of IDs without detaching. | from InteractsWithPivotTable |
array | sync(Collection|Collection|array $ids, bool $detaching = true) Sync the intermediate tables with a list of IDs or collection of models. | from InteractsWithPivotTable |
int | updateExistingPivot(mixed $id, array $attributes, bool $touch = true) Update an existing pivot record on the table. | from InteractsWithPivotTable |
void | attach(mixed $id, array $attributes = array(), bool $touch = true) Attach a model to the parent. | from InteractsWithPivotTable |
int | detach(mixed $ids = null, bool $touch = true) Detach models from the relationship. | from InteractsWithPivotTable |
Pivot | newPivot(array $attributes = array(), bool $exists = false) Create a new pivot model instance. | from InteractsWithPivotTable |
Pivot | newExistingPivot(array $attributes = array()) 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 |
$this | withPivot(array|mixed $columns) Set the columns on the pivot table to retrieve. | from InteractsWithPivotTable |
BelongsToMany | using(string $class) Specify the custom pivot model to use for the relationship. | |
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. | |
Collection|Model | findOrNew(mixed $id, array $columns = array('*')) 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 = array(), bool $touch = true) Get the first related record matching the attributes or create it. | |
Model | updateOrCreate(array $attributes, array $values = array(), array $joining = array(), 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 = array('*')) Find a related model by its primary key. | |
Collection | findMany(mixed $ids, array $columns = array('*')) Find multiple related models by their primary keys. | |
Model|Collection | findOrFail(mixed $id, array $columns = array('*')) Find a related model by its primary key or throw an exception. | |
mixed | first(array $columns = array('*')) Execute the query and get the first result. | |
Model|BelongsToMany | firstOrFail(array $columns = array('*')) Execute the query and get the first result or throw an exception. | |
Collection | get(array $columns = array('*')) Execute the query as a "select" statement. | |
LengthAwarePaginator | paginate(int $perPage = null, array $columns = array('*'), string $pageName = 'page', int|null $page = null) Get a paginator for the "select" statement. | |
Paginator | simplePaginate(int $perPage = null, array $columns = array('*'), 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 | touchIfTouching() If we're touching the parent model, touch. | |
Collection | allRelatedIds() Get all of the IDs for the related models. | |
Model | save(Model $model, array $pivotAttributes = array(), bool $touch = true) Save a new model and attach it to the parent model. | |
array | saveMany(Collection|array $models, array $pivotAttributes = array()) Save an array of new models and attach them to the parent model. | |
Model | create(array $attributes, array $joining = array(), bool $touch = true) Create a new instance of the related model. | |
array | createMany(array $records, array $joinings = array()) Create an array of new instances of the related models. | |
Builder | getRelationExistenceQueryForSelfJoin(Builder $query, Builder $parentQuery, array|mixed $columns = array('*')) 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. | |
BelongsToMany | withTimestamps(mixed $createdAt = null, mixed $updatedAt = null) Specify that the pivot table has creation and update timestamps. | |
string | getQualifiedForeignKeyName() Get the fully qualified foreign key for the relation. | |
string | getQualifiedRelatedKeyName() Get the fully qualified "related key" for the relation. | |
string | getTable() Get the intermediate table for the relationship. | |
string | getRelationName() Get the relationship name for the relationship. |
Register a custom macro.
Checks if macro is registered.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new belongs to many relationship instance.
Run a callback with constraints disabled on the relation.
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.
Get the relationship for eager loading.
Touch all of the related models for the relationship.
E.g.: Touch all roles associated with this user.
Run a raw update against the base query.
Add the constraints for a relationship count query.
Add the constraints for a relationship query.
Get the underlying query for the relation.
Get the base query builder driving the Eloquent builder.
Get the parent model of the relation.
Get the fully qualified parent key name.
Get the related model of the relation.
Get the name of the "created at" column.
Get the name of the "updated at" column.
Get the name of the related model's "updated at" column.
Set or get the morph map for polymorphic relations.
Force a clone of the underlying query builder when cloning.
Toggles a model (or models) from the parent.
Each existing model is detached, and non existing ones are attached.
Sync the intermediate tables with a list of IDs without detaching.
Sync the intermediate tables with a list of IDs or collection of models.
Update an existing pivot record on the table.
Attach a model to the parent.
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.
Set the columns on the pivot table to retrieve.
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 a paginator for the "select" statement.
Paginate the given query into a simple paginator.
Chunk the results of the query.
If we're touching the parent model, touch.
Get all of the IDs for the related models.
Save a new model and attach it to the parent model.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Database/Eloquent/Relations/BelongsToMany.html