class MorphToMany extends BelongsToMany (View source)
InteractsWithPivotTable |
Macroable |
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. | 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 array | $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 string | $pivotCreatedAt | The custom pivot table column for the created_at timestamp. | from BelongsToMany |
protected string | $pivotUpdatedAt | The custom pivot table column for the updated_at timestamp. | from BelongsToMany |
protected string | $using | The class name of the custom pivot model to use for the relationship. | from BelongsToMany |
protected string | $accessor | The name of the accessor to use for the "pivot" relationship. | from BelongsToMany |
static protected int | $selfJoinCount | The count of self joins. | from BelongsToMany |
protected string | $morphType | The type of the polymorphic relation. | |
protected string | $morphClass | The class name of the morph type constraint. | |
protected bool | $inverse | Indicates if we are connecting the inverse of the relation. |
static void | macro(string $name, object|callable $macro) Register a custom macro. | from Macroable |
static void | mixin(object $mixin) 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 $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null, bool $inverse = false) Create a new morph 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. | from BelongsToMany |
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. | from BelongsToMany |
array | match(array $models, Collection $results, string $relation) Match the eagerly loaded results to their parents. | from BelongsToMany |
mixed | getResults() Get the results of the relationship. | from BelongsToMany |
Collection | getEager() Get the relationship for eager loading. | from Relation |
Collection | get(array $columns = ['*']) Execute the query as a "select" statement. | 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 |
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 count query. | |
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 for the relation. | from BelongsToMany |
Model | 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 |
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|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 |
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 |
void | attach(mixed $id, array $attributes = [], bool $touch = true) Attach a model to the parent. | 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 |
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 |
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 an integer if it is numeric. | from InteractsWithPivotTable |
array | castAttributes(array $attributes) Cast the given pivot attributes. | from InteractsWithPivotTable |
$this | performJoin(Builder|null $query = null) Set the join clause for the relation query. | from BelongsToMany |
$this | addWhereConstraints() Set the where clause for the relation query. | |
array | buildDictionary(Collection $results) Build model dictionary keyed by the relation's foreign key. | from BelongsToMany |
BelongsToMany | using(string $class) Specify the custom pivot model to use for the relationship. | from BelongsToMany |
BelongsToMany | as(string $accessor) Specify the custom pivot accessor to use for the relationship. | from BelongsToMany |
BelongsToMany | wherePivot(string $column, string $operator = null, mixed $value = null, string $boolean = 'and') Set a where clause for a pivot table column. | from BelongsToMany |
BelongsToMany | wherePivotIn(string $column, mixed $values, string $boolean = 'and', bool $not = false) Set a "where in" clause for a pivot table column. | from BelongsToMany |
BelongsToMany | orWherePivot(string $column, string $operator = null, mixed $value = null) Set an "or where" clause for a pivot table column. | from BelongsToMany |
BelongsToMany | orWherePivotIn(string $column, mixed $values) Set an "or where in" clause for a pivot table column. | from BelongsToMany |
Collection|Model | findOrNew(mixed $id, array $columns = ['*']) Find a related model by its primary key or return new instance of the related model. | from BelongsToMany |
Model | firstOrNew(array $attributes) Get the first related model record matching the attributes or instantiate it. | from BelongsToMany |
Model | firstOrCreate(array $attributes, array $joining = [], bool $touch = true) Get the first related record matching the attributes or create it. | from BelongsToMany |
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. | from BelongsToMany |
Model|Collection|null | find(mixed $id, array $columns = ['*']) Find a related model by its primary key. | from BelongsToMany |
Collection | findMany(mixed $ids, array $columns = ['*']) Find multiple related models by their primary keys. | from BelongsToMany |
Model|Collection | findOrFail(mixed $id, array $columns = ['*']) Find a related model by its primary key or throw an exception. | from BelongsToMany |
mixed | first(array $columns = ['*']) Execute the query and get the first result. | from BelongsToMany |
Model|BelongsToMany | firstOrFail(array $columns = ['*']) Execute the query and get the first result or throw an exception. | from BelongsToMany |
BelongsToMany | shouldSelect(array $columns = ['*']) Get the select columns for the relation query. | from BelongsToMany |
array | aliasedPivotColumns() Get the pivot columns for the relation. | from BelongsToMany |
LengthAwarePaginator | paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null) Get a paginator for the "select" statement. | from BelongsToMany |
Paginator | simplePaginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null) Paginate the given query into a simple paginator. | from BelongsToMany |
bool | chunk(int $count, callable $callback) Chunk the results of the query. | 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 | allRelatedIds() Get all of the IDs for the related models. | from BelongsToMany |
Model | save(Model $model, array $pivotAttributes = [], bool $touch = true) Save a new model and attach it to the parent model. | from BelongsToMany |
array | saveMany(Collection|array $models, array $pivotAttributes = []) Save an array of new models and attach them to the parent model. | from BelongsToMany |
Model | create(array $attributes = [], array $joining = [], bool $touch = true) Create a new instance of the related model. | from BelongsToMany |
array | createMany(array $records, array $joinings = []) Create an array of new instances of the related models. | from BelongsToMany |
Builder | getRelationExistenceQueryForSelfJoin(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query on the same table. | from BelongsToMany |
string | getExistenceCompareKey() Get the key for comparing against the parent key in "has" query. | from BelongsToMany |
string | getRelationCountHash() Get a relationship join table hash. | from BelongsToMany |
BelongsToMany | withTimestamps(mixed $createdAt = null, mixed $updatedAt = null) Specify that the pivot table has creation and update timestamps. | from BelongsToMany |
string | getQualifiedForeignPivotKeyName() Get the fully qualified foreign key for the relation. | from BelongsToMany |
string | getQualifiedRelatedPivotKeyName() Get the fully qualified "related key" 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 |
string | getMorphType() Get the foreign key "type" name. | |
string | getMorphClass() Get the class name of the parent model. |
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new morph 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.
Execute the query as a "select" statement.
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 count query.
Get all of the primary keys for an array of models.
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 for the relation.
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.
Builds a table-keyed array from model class names.
Get the model associated with a custom polymorphic type.
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.
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.
Cast the given pivot attributes.
Set the join clause for the relation query.
Set the where clause for the relation query.
Build model dictionary keyed by the relation's foreign key.
Specify the custom pivot model to use for the relationship.
Specify the custom pivot accessor 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.
Get the select columns for the relation query.
Get the pivot columns for the relation.
"pivot_" is prefixed ot each column for easy removal later.
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.
Get the pivot attributes from a model.
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 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.
Get the foreign key "type" name.
Get the class name of the parent model.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Database/Eloquent/Relations/MorphToMany.html