MorphToMany
class MorphToMany extends BelongsToMany (View source)
Properties
| 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 |
| protected string | $table | The intermediate table for the relation. |
from BelongsToMany |
| protected string | $foreignKey | The foreign key of the parent model. |
from BelongsToMany |
| protected string | $otherKey | The associated key of the relation. |
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. |
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. |
Methods
Create a new has many relationship instance.
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.
Add the constraints for a relationship count query.
Get all of the primary keys for an array of models.
Handle dynamic method calls to the relationship.
Set a where clause for a pivot table column.
Set an or where clause for a pivot table column.
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.
Hydrate the pivot table relationship on the models.
Add the constraints for a relationship count query on the same table.
Set the select clause for the relation query.
Determine whether the given column is defined as a pivot column.
Set the where clause for the relation query.
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.
Sync the intermediate tables with a list of IDs or collection of models.
Format the sync list so that it is keyed by ID.
Attach all of the IDs that aren't in the current array.
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.
Detach models from the relationship.
Attempt to guess the name of the inverse of the relation.
Create a new query builder for the pivot table.
Get a new pivot statement for a given "other" ID.
Create a new pivot model instance.
Create a new existing pivot model instance.
Specify that the pivot table has creation and update timestamps.
Get the key for comparing against the parent key in "has" query.
Get the foreign key "type" name.
Get the class name of the parent model.
Details
void
__construct(Builder $query, Model $parent, string $name, string $table, string $foreignKey, string $otherKey, string $relationName = null, bool $inverse = false)
Create a new has 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.
void
touch()
Touch all of the related models for the relationship.
E.g.: Touch all roles associated with this user.
int
rawUpdate(array $attributes = array())
Run a raw update against the base query.
Builder
getRelationCountQuery(Builder $query, Builder $parent)
Add the constraints for a relationship count query.
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
protected array
getKeys(array $models, string $key = null)
Get all of the primary keys for an array of models.
Builder
getQuery()
Get the underlying query for the relation.
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
Model
getParent()
Get the parent model of the relation.
string
getQualifiedParentKeyName()
Get the fully qualified parent key name.
Model
getRelated()
Get the related model of the 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.
string
wrap(string $value)
Wrap the given value with the parent query's grammar.
mixed
__call(string $method, array $parameters)
Handle dynamic method calls to 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
orWherePivot(string $column, string $operator = null, mixed $value = null)
Set an or where clause for a pivot table column.
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.
Paginator
paginate(int $perPage = null, array $columns = array('*'))
Get a paginator for the "select" statement.
protected void
hydratePivotRelation(array $models)
Hydrate the pivot table relationship on the models.
protected array
cleanPivotAttributes(Model $model)
Get the pivot attributes from a model.
Builder
getRelationCountQueryForSelfJoin(Builder $query, Builder $parent)
Add the constraints for a relationship count query on the same table.
string
getRelationCountHash()
Get a relationship join table hash.
protected BelongsToMany
getSelectColumns(array $columns = array('*'))
Set the select clause for the relation query.
protected array
getAliasedPivotColumns()
Get the pivot columns for the relation.
protected bool
hasPivotColumn(string $column)
Determine whether the given column is defined as a pivot column.
protected $this
setJoin($query = null)
Set the join clause for the relation query.
protected $this
setWhere()
Set the where clause for the relation query.
protected array
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
array
getRelatedIds()
Get all of the IDs for the related models.
Model
save(Model $model, array $joining = array(), bool $touch = true)
Save a new model and attach it to the parent model.
array
saveMany(array $models, array $joinings = 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.
Model
createMany(array $records, array $joinings = array())
Create an array of new instances of the related models.
array
sync(array $ids, bool $detaching = true)
Sync the intermediate tables with a list of IDs or collection of models.
protected array
formatSyncList(array $records)
Format the sync list so that it is keyed by ID.
protected array
attachNew(array $records, array $current, bool $touch = true)
Attach all of the IDs that aren't in the current array.
void
updateExistingPivot(mixed $id, array $attributes, bool $touch = true)
Update an existing pivot record on the table.
void
attach(mixed $id, array $attributes = array(), bool $touch = true)
Attach a model to the parent.
protected array
createAttachRecords(array $ids, array $attributes)
Create an array of records to insert into the pivot table.
protected array
attacher(int $key, mixed $value, array $attributes, bool $timed)
Create a full attachment record payload.
protected array
getAttachId(mixed $key, mixed $value, array $attributes)
Get the attach record ID and extra attributes.
protected array
createAttachRecord(int $id, bool $timed)
Create a new pivot attachment record.
protected array
setTimestampsOnAttach(array $record, bool $exists = false)
Set the creation and update timestamps on an attach record.
int
detach(int|array $ids = array(), bool $touch = true)
Detach models from the relationship.
void
touchIfTouching()
If we're touching the parent model, touch.
protected bool
touchingParent()
Determine if we should touch the parent on sync.
protected string
guessInverseRelation()
Attempt to guess the name of the inverse of the relation.
protected 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 = array(), bool $exists = false)
Create a new pivot model instance.
Pivot
newExistingPivot(array $attributes = array())
Create a new existing pivot model instance.
$this
withPivot(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.
string
getMorphType()
Get the foreign key "type" name.
string
getMorphClass()
Get the class name of the parent model.