MorphOne
class MorphOne extends MorphOneOrMany implements SupportsPartialRelations (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected TRelatedModel> | $query | The Eloquent query builder instance. |
from Relation |
| protected TDeclaringModel | $parent | The parent model instance. |
from Relation |
| protected TRelatedModel | $related | The related model instance. |
from Relation |
| protected bool | $eagerKeysWereEmpty | Indicates whether the eagerly loaded relation should implicitly return an empty collection. |
from Relation |
| static protected bool | $constraints | Indicates if the relation is adding constraints. |
from Relation |
| static array | $morphMap | An array to map class names to their morph names in the database. |
from Relation |
| static protected bool | $requireMorphMap | Prevents morph relationships without a morph map. |
from Relation |
| static protected int | $selfJoinCount | The count of self joins. |
from Relation |
| protected string|null | $inverseRelationship | The name of the inverse relationship. |
from SupportsInverseRelations |
| 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 |
| protected bool | $isOneOfMany | Determines whether the relationship is one-of-many. |
from CanBeOneOfMany |
| protected string | $relationName | The name of the relationship. |
from CanBeOneOfMany |
| protected | $oneOfManySubQuery | The one of many inner join subselect query builder instance. |
from CanBeOneOfMany |
| protected Closure|array|bool | $withDefault | Indicates if a default model instance should be used. |
from SupportsDefaultModels |
Methods
Forward a method call to the given object.
Forward a method call to the given object, returning $this if the forwarded call returned itself.
Throw a bad method call exception for the given method.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new morph one or many relationship instance.
No description
No description
Execute the query and get the first result if it's the sole matching record.
Add the constraints for a relationship count query.
No description
Get a relationship join table hash.
Get all of the primary keys for an array of models.
Get the query builder that will contain the relationship constraints.
Add a whereIn eager constraint for the given set of model keys to be loaded.
Prevent polymorphic relationships from being used without model mappings.
Determine if polymorphic relationships require explicit model mapping.
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
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.
Get the alias associated with a custom polymorphic class.
Get a dictionary key attribute - casting it to a string if necessary.
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
Guess the name of the inverse relationship.
Get the possible inverse relations for the parent model.
Set the inverse relation on all models in a collection.
Set the inverse relation on a model.
Get the name of the inverse relationship.
Remove the chaperone / inverse relationship for this query.
Remove the chaperone / inverse relationship for this query.
Create and return an un-saved instance of the related model.
Create and return an un-saved instance of the related models.
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.
Find a model by its primary key or return a new instance of the related model.
Get the first related model record matching the attributes or instantiate it.
Get the first record matching the attributes. If the record is not found, create it.
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
Create or update a related record matching the attributes, and fill it with values.
Insert new records or update the existing ones.
Attach a collection of models to the parent instance.
Attach a collection of models to the parent instance without raising any events to the parent model.
Create a new instance of the related model.
Create a new instance of the related model without raising any events to the parent model.
Create a new instance of the related model. Allow mass-assignment.
Create a new instance of the related model with mass assignment without raising model events.
Create a Collection of new instances of the related model.
Create a Collection of new instances of the related model without raising any events to the parent model.
Set the foreign ID and type for creating a related model.
Add the constraints for a relationship query on the same table.
Get the key for comparing against the parent key in "has" query.
Add constraints for inner join subselect for one of many relationships.
Get the columns that should be selected by the one of many subquery.
Add join query constraints for one of many relationships.
Indicate that the relation is a single result of a larger one-to-many relationship.
Indicate that the relation is the latest single result of a larger one-to-many relationship.
Indicate that the relation is the oldest single result of a larger one-to-many relationship.
Get the default alias for the one of many inner join clause.
Get a new query for the related model, grouping the query by the given column, often the foreign key of the relationship.
Add the join subquery to the given query on the given column and the relationship's foreign key.
Merge the relationship query joins to the given query builder.
Get the one of many inner join subselect builder instance.
Get the qualified column name for the one-of-many relationship using the subselect join query's alias.
Qualify related column using the related table name if it is not already qualified.
Guess the "hasOne" relationship's name via backtrace.
Determine whether the relationship is a one-of-many relationship.
Compare the parent key with the related key.
Return a new model instance in case the relationship does not exist.
Details
protected mixed
forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
protected mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object, returning $this if the forwarded call returned itself.
static protected never
throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
void
__construct(Builder $query, Model $parent, string $type, string $id, string $localKey)
Create a new morph one or many relationship instance.
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
void
addConstraints()
Set the base constraints on the relation query.
void
addEagerConstraints(array $models)
No description
TDeclaringModel>
initRelation(array $models, string $relation)
No description
TDeclaringModel>
match(array $models, Collection $results, string $relation)
No description
TResult
getResults()
No description
TRelatedModel>
getEager()
Get the relationship for eager loading.
TRelatedModel
sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
TRelatedModel>
get(array $columns = ['*'])
Execute the query as a "select" statement.
void
touch()
Touch all of the related models for the relationship.
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
TRelatedModel>
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
TRelatedModel>
getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
No description
string
getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
protected array<int,int|string|null>
getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
protected
getRelationQuery()
Get the query builder that will contain the relationship constraints.
TRelatedModel>
getQuery()
Get the underlying query for the relation.
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
Builder
toBase()
Get a base query builder instance.
TDeclaringModel
getParent()
Get the parent model of the relation.
string
getQualifiedParentKeyName()
Get the fully qualified parent key name.
TRelatedModel
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.
protected void
whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)
Add a whereIn eager constraint for the given set of model keys to be loaded.
protected string
whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
static void
requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings.
static bool
requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
static array
enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
static array
morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null
buildMorphMapFromModels(array|null $models = null)
Builds a table-keyed array from model class names.
static string|null
getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
static int|string
getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
void
__clone()
Force a clone of the underlying query builder when cloning.
protected mixed
getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary.
$this
inverse(string|null $relation = null)
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
Alias of "chaperone".
$this
chaperone(string|null $relation = null)
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
protected string|null
guessInverseRelation()
Guess the name of the inverse relationship.
protected array
getPossibleInverseRelations()
Get the possible inverse relations for the parent model.
protected Collection
applyInverseRelationToCollection(Collection $models, Model|null $parent = null)
Set the inverse relation on all models in a collection.
protected Model
applyInverseRelationToModel(Model $model, Model|null $parent = null)
Set the inverse relation on a model.
string|null
getInverseRelationship()
Get the name of the inverse relationship.
$this
withoutInverse()
Remove the chaperone / inverse relationship for this query.
Alias of "withoutChaperone".
$this
withoutChaperone()
Remove the chaperone / inverse relationship for this query.
TRelatedModel
make(array $attributes = [])
Create and return an un-saved instance of the related model.
TRelatedModel>
makeMany(iterable $records)
Create and return an un-saved instance of the related models.
TDeclaringModel>
matchOne(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their single parents.
TDeclaringModel>
matchMany(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their many parents.
protected TDeclaringModel>
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 TRelatedModel>[]
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
findOrNew(mixed $id, array $columns = ['*'])
Find a model by its primary key or return a new instance of the related model.
TRelatedModel
firstOrNew(array $attributes = [], array $values = [])
Get the first related model record matching the attributes or instantiate it.
TRelatedModel
firstOrCreate(array $attributes = [], array $values = [])
Get the first record matching the attributes. If the record is not found, create it.
TRelatedModel
createOrFirst(array $attributes = [], array $values = [])
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
TRelatedModel
updateOrCreate(array $attributes, array $values = [])
Create or update a related record matching the attributes, and fill it with values.
int
upsert(array $values, array|string $uniqueBy, array|null $update = null)
Insert new records or update the existing ones.
TRelatedModel|false
save(Model $model)
Attach a model instance to the parent model.
TRelatedModel|false
saveQuietly(Model $model)
Attach a model instance without raising any events to the parent model.
TRelatedModel>
saveMany(TRelatedModel> $models)
Attach a collection of models to the parent instance.
TRelatedModel>
saveManyQuietly(TRelatedModel> $models)
Attach a collection of models to the parent instance without raising any events to the parent model.
TRelatedModel
create(array $attributes = [])
Create a new instance of the related model.
TRelatedModel
createQuietly(array $attributes = [])
Create a new instance of the related model without raising any events to the parent model.
TRelatedModel
forceCreate(array $attributes = [])
Create a new instance of the related model. Allow mass-assignment.
TRelatedModel
forceCreateQuietly(array $attributes = [])
Create a new instance of the related model with mass assignment without raising model events.
TRelatedModel>
createMany(iterable $records)
Create a Collection of new instances of the related model.
TRelatedModel>
createManyQuietly(iterable $records)
Create a Collection of new instances of the related model without raising any events to the parent model.
protected void
setForeignAttributesForCreate(Model $model)
Set the foreign ID and type for creating a related model.
TRelatedModel>
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
$this
take(int $value)
Alias to set the "limit" value of the query.
$this
limit(int $value)
Set the "limit" value of the query.
string
getExistenceCompareKey()
Get the key for comparing against the parent key in "has" query.
abstract mixed
getParentKey()
Get the value of the parent model's key.
string
getForeignKeyName()
Get the plain foreign key.
string
getQualifiedForeignKeyName()
Get the foreign key for the relationship.
string
getLocalKeyName()
Get the local key for the relationship.
string
getQualifiedMorphType()
Get the foreign key "type" name.
string
getMorphType()
Get the plain morph type name without the table.
string
getMorphClass()
Get the class name of the parent model.
void
addOneOfManySubQueryConstraints(Builder $query, string|null $column = null, string|null $aggregate = null)
Add constraints for inner join subselect for one of many relationships.
array|string
getOneOfManySubQuerySelectColumns()
Get the columns that should be selected by the one of many subquery.
void
addOneOfManyJoinSubQueryConstraints(JoinClause $join)
Add join query constraints for one of many relationships.
$this
ofMany(string|array|null $column = 'id', string|Closure|null $aggregate = 'MAX', string|null $relation = null)
Indicate that the relation is a single result of a larger one-to-many relationship.
$this
latestOfMany(string|array|null $column = 'id', string|null $relation = null)
Indicate that the relation is the latest single result of a larger one-to-many relationship.
$this
oldestOfMany(string|array|null $column = 'id', string|null $relation = null)
Indicate that the relation is the oldest single result of a larger one-to-many relationship.
protected string
getDefaultOneOfManyJoinAlias(string $relation)
Get the default alias for the one of many inner join clause.
protected
newOneOfManySubQuery(string|array $groupBy, string[]|null $columns = null, string|null $aggregate = null)
Get a new query for the related model, grouping the query by the given column, often the foreign key of the relationship.
protected void
addOneOfManyJoinSubQuery(Builder $parent, Builder $subQuery, string[] $on)
Add the join subquery to the given query on the given column and the relationship's foreign key.
protected void
mergeOneOfManyJoinsTo(Builder $query)
Merge the relationship query joins to the given query builder.
getOneOfManySubQuery()
Get the one of many inner join subselect builder instance.
string
qualifySubSelectColumn(string $column)
Get the qualified column name for the one-of-many relationship using the subselect join query's alias.
protected string
qualifyRelatedColumn(string $column)
Qualify related column using the related table name if it is not already qualified.
protected string
guessRelationship()
Guess the "hasOne" relationship's name via backtrace.
bool
isOneOfMany()
Determine whether the relationship is a one-of-many relationship.
string
getRelationName()
Get the name of the relationship.
bool
is(Model|null $model)
Determine if the model is the related instance of the relationship.
bool
isNot(Model|null $model)
Determine if the model is not the related instance of the relationship.
protected int|string
getRelatedKeyFrom(Model $model)
Get the value of the model's foreign key.
protected bool
compareKeys(mixed $parentKey, mixed $relatedKey)
Compare the parent key with the related key.
TRelatedModel
newRelatedInstanceFor(Model $parent)
Make a new related instance for the given model.
$this
withDefault(Closure|array|bool $callback = true)
Return a new model instance in case the relationship does not exist.