MorphOne
class MorphOne extends MorphOneOrMany (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 | $foreignKey | The foreign key of the parent model. |
from HasOneOrMany |
| protected string | $localKey | The local key of the parent model. |
from HasOneOrMany |
| protected string | $morphType | The foreign key type for the relationship. |
from MorphOneOrMany |
| protected string | $morphClass | The class name of the parent model. |
from MorphOneOrMany |
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.
Get the results of the relationship.
Get all of the primary keys for an array of models.
Handle dynamic method calls to the relationship.
Match the eagerly loaded results to their single parents.
Match the eagerly loaded results to their many parents.
Match the eagerly loaded results to their many parents.
Get the value of a relationship by one or many type.
Create an array of new instances of the related model.
Get the key for comparing against the parent key in "has" query.
Set the foreign ID and type for creating a related model.
Details
void
__construct(Builder $query, Model $parent, string $type, string $id, string $localKey)
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.
int
rawUpdate(array $attributes = array())
Run a raw update against the base 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.
array
matchOne(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their single parents.
array
matchMany(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their many parents.
protected array
matchOneOrMany(array $models, Collection $results, string $relation, string $type)
Match the eagerly loaded results to their many parents.
protected mixed
getRelationValue(array $dictionary, string $key, string $type)
Get the value of a relationship by one or many type.
protected array
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
array
saveMany(array $models)
Attach an array of models to the parent instance.
Model
create(array $attributes)
Create a new instance of the related model.
array
createMany(array $records)
Create an array of new instances of the related model.
int
update(array $attributes)
Perform an update on all the related models.
string
getHasCompareKey()
Get the key for comparing against the parent key in "has" query.
string
getForeignKey()
Get the foreign key for the relationship.
string
getPlainForeignKey()
Get the plain foreign key.
mixed
getParentKey()
Get the key value of the parent's local key.
protected void
setForeignAttributesForCreate(Model $model)
Set the foreign ID and type for creating a related model.
string
getMorphType()
Get the foreign key "type" name.
string
getPlainMorphType()
Get the plain morph type name without the table.
string
getMorphClass()
Get the class name of the parent model.