MorphOne
class MorphOne extends MorphOneOrMany implements SupportsPartialRelations (View source)
Traits
| CanBeOneOfMany | |
| ComparesRelatedModels | |
| SupportsDefaultModels | |
| InteractsWithDictionary | |
| ForwardsCalls | |
| Macroable |
Properties
| 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 |
| 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 | $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 Builder|null | $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
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object. |
from ForwardsCalls |
| mixed | forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object, returning $this if the forwarded call returned itself. |
from ForwardsCalls |
| static void | throwBadMethodCallException(string $method) Throw a bad method call exception for the given method. |
from ForwardsCalls |
| static void | macro(string $name, object|callable $macro) Register a custom macro. |
from Macroable |
| static void | mixin(object $mixin, bool $replace = true) Mix another object into the class. |
from Macroable |
| static bool | hasMacro(string $name) Checks if macro is registered. |
from Macroable |
| static void | flushMacros() Flush the existing macros. |
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 $type, string $id, string $localKey) Create a new morph one or many relationship instance. |
from MorphOneOrMany |
| 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 MorphOneOrMany |
| void | addEagerConstraints(array $models) Set the constraints for an eager load of the relation. |
from MorphOneOrMany |
| 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 |
| Model | sole(array|string $columns = ['*']) Execute the query and get the first result if it's the sole matching record. |
from Relation |
| Collection | get(array $columns = ['*']) Execute the query as a "select" statement. |
from Relation |
| void | touch() Touch all of the related models for the relationship. |
from Relation |
| 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 = ['*']) Get the relationship query. |
|
| string | getRelationCountHash(bool $incrementJoinCount = true) Get a relationship join table hash. |
from Relation |
| array | getKeys(array $models, string|null $key = null) Get all of the primary keys for an array of models. |
from Relation |
| Builder | getRelationQuery() Get the query builder that will contain the relationship constraints. |
from CanBeOneOfMany |
| Builder | getQuery() Get the underlying query for the relation. |
from Relation |
| Builder | getBaseQuery() Get the base query builder driving the Eloquent builder. |
from Relation |
| Builder | toBase() Get a base query builder instance. |
from Relation |
| Model | getParent() Get the parent model of the relation. |
from Relation |
| string | getQualifiedParentKeyName() Get the fully qualified parent key name. |
from HasOneOrMany |
| Model | getRelated() Get the related model of the relation. |
from Relation |
| string | createdAt() Get the name of the "created at" column. |
from Relation |
| string | updatedAt() Get the name of the "updated at" column. |
from Relation |
| string | relatedUpdatedAt() Get the name of the related model's "updated at" column. |
from Relation |
| void | whereInEager(string $whereIn, string $key, array $modelKeys, Builder $query = null) Add a whereIn eager constraint for the given set of model keys to be loaded. |
from Relation |
| string | whereInMethod(Model $model, string $key) Get the name of the "where in" method for eager loading. |
from Relation |
| static void | requireMorphMap(bool $requireMorphMap = true) Prevent polymorphic relationships from being used without model mappings. |
from Relation |
| static bool | requiresMorphMap() Determine if polymorphic relationships require explicit model mapping. |
from Relation |
| static array | enforceMorphMap(array $map, bool $merge = true) Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped. |
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 |
| mixed | getDictionaryKey(mixed $attribute) Get a dictionary key attribute - casting it to a string if necessary. |
from InteractsWithDictionary |
| Model | make(array $attributes = []) Create and return an un-saved instance of the related model. |
from HasOneOrMany |
| Collection | makeMany(iterable $records) Create and return an un-saved instance of the related models. |
from HasOneOrMany |
| array | matchOne(array $models, Collection $results, string $relation) Match the eagerly loaded results to their single parents. |
from HasOneOrMany |
| array | matchMany(array $models, Collection $results, string $relation) Match the eagerly loaded results to their many parents. |
from HasOneOrMany |
| array | matchOneOrMany(array $models, Collection $results, string $relation, string $type) Match the eagerly loaded results to their many parents. |
from HasOneOrMany |
| mixed | getRelationValue(array $dictionary, string $key, string $type) Get the value of a relationship by one or many type. |
from HasOneOrMany |
| array | buildDictionary(Collection $results) Build model dictionary keyed by the relation's foreign key. |
from HasOneOrMany |
| Collection|Model | findOrNew(mixed $id, array $columns = ['*']) Find a model by its primary key or return a new instance of the related model. |
from HasOneOrMany |
| Model | firstOrNew(array $attributes = [], array $values = []) Get the first related model record matching the attributes or instantiate it. |
from HasOneOrMany |
| Model | firstOrCreate(array $attributes = [], array $values = []) Get the first related record matching the attributes or create it. |
from HasOneOrMany |
| Model | updateOrCreate(array $attributes, array $values = []) Create or update a related record matching the attributes, and fill it with values. |
from HasOneOrMany |
| Model|false | save(Model $model) Attach a model instance to the parent model. |
from HasOneOrMany |
| Model|false | saveQuietly(Model $model) Attach a model instance without raising any events to the parent model. |
from HasOneOrMany |
| iterable | saveMany(iterable $models) Attach a collection of models to the parent instance. |
from HasOneOrMany |
| iterable | saveManyQuietly(iterable $models) Attach a collection of models to the parent instance without raising any events to the parent model. |
from HasOneOrMany |
| Model | create(array $attributes = []) Create a new instance of the related model. |
from HasOneOrMany |
| Model | createQuietly(array $attributes = []) Create a new instance of the related model without raising any events to the parent model. |
from HasOneOrMany |
| Model | forceCreate(array $attributes = []) Create a new instance of the related model. Allow mass-assignment. |
from HasOneOrMany |
| Model | forceCreateQuietly(array $attributes = []) Create a new instance of the related model with mass assignment without raising model events. |
from HasOneOrMany |
| Collection | createMany(iterable $records) Create a Collection of new instances of the related model. |
from HasOneOrMany |
| Collection | createManyQuietly(iterable $records) Create a Collection of new instances of the related model without raising any events to the parent model. |
from HasOneOrMany |
| void | setForeignAttributesForCreate(Model $model) Set the foreign ID and type for creating a related model. |
from MorphOneOrMany |
| Builder | getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query on the same table. |
from HasOneOrMany |
| string | getExistenceCompareKey() Get the key for comparing against the parent key in "has" query. |
from HasOneOrMany |
| mixed | getParentKey() Get the value of the parent model's key. |
from ComparesRelatedModels |
| string | getForeignKeyName() Get the plain foreign key. |
from HasOneOrMany |
| string | getQualifiedForeignKeyName() Get the foreign key for the relationship. |
from HasOneOrMany |
| string | getLocalKeyName() Get the local key for the relationship. |
from HasOneOrMany |
| string | getQualifiedMorphType() Get the foreign key "type" name. |
from MorphOneOrMany |
| string | getMorphType() Get the plain morph type name without the table. |
from MorphOneOrMany |
| string | getMorphClass() Get the class name of the parent model. |
from MorphOneOrMany |
| 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. |
from CanBeOneOfMany |
| $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. |
from CanBeOneOfMany |
| $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. |
from CanBeOneOfMany |
| string | getDefaultOneOfManyJoinAlias(string $relation) Get the default alias for the one of many inner join clause. |
from CanBeOneOfMany |
| Builder | newOneOfManySubQuery(string|array $groupBy, string|null $column = 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. |
from CanBeOneOfMany |
| 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. |
from CanBeOneOfMany |
| void | mergeOneOfManyJoinsTo(Builder $query) Merge the relationship query joins to the given query builder. |
from CanBeOneOfMany |
| Builder|void | getOneOfManySubQuery() Get the one of many inner join subselect builder instance. |
from CanBeOneOfMany |
| string | qualifySubSelectColumn(string $column) Get the qualified column name for the one-of-many relationship using the subselect join query's alias. |
from CanBeOneOfMany |
| string | qualifyRelatedColumn(string $column) Qualify related column using the related table name if it is not already qualified. |
from CanBeOneOfMany |
| string | guessRelationship() Guess the "hasOne" relationship's name via backtrace. |
from CanBeOneOfMany |
| bool | isOneOfMany() Determine whether the relationship is a one-of-many relationship. |
from CanBeOneOfMany |
| string | getRelationName() Get the name of the relationship. |
from CanBeOneOfMany |
| bool | is(Model|null $model) Determine if the model is the related instance of the relationship. |
from ComparesRelatedModels |
| bool | isNot(Model|null $model) Determine if the model is not the related instance of the relationship. |
from ComparesRelatedModels |
| mixed | getRelatedKeyFrom(Model $model) Get the value of the model's foreign key. |
|
| bool | compareKeys(mixed $parentKey, mixed $relatedKey) Compare the parent key with the related key. |
from ComparesRelatedModels |
| Model | 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. |
from SupportsDefaultModels |
| Model|null | getDefaultFor(Model $parent) Get the default value for this relation. |
from SupportsDefaultModels |
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 void 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)
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.
Model sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
Collection 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.
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Get the relationship query.
string getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
protected array getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
protected Builder getRelationQuery()
Get the query builder that will contain the relationship constraints.
Builder 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.
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.
protected void whereInEager(string $whereIn, string $key, array $modelKeys, Builder $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 $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array $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.
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.
Model make(array $attributes = [])
Create and return an un-saved instance of the related model.
Collection makeMany(iterable $records)
Create and return an un-saved instance of the related models.
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.
Collection|Model findOrNew(mixed $id, array $columns = ['*'])
Find a model by its primary key or return a new instance of the related model.
Model firstOrNew(array $attributes = [], array $values = [])
Get the first related model record matching the attributes or instantiate it.
Model firstOrCreate(array $attributes = [], array $values = [])
Get the first related record matching the attributes or create it.
Model updateOrCreate(array $attributes, array $values = [])
Create or update a related record matching the attributes, and fill it with values.
Model|false saveQuietly(Model $model)
Attach a model instance without raising any events to the parent model.
iterable saveMany(iterable $models)
Attach a collection of models to the parent instance.
iterable saveManyQuietly(iterable $models)
Attach a collection of models to the parent instance without raising any events to the parent model.
Model create(array $attributes = [])
Create a new instance of the related model.
Model createQuietly(array $attributes = [])
Create a new instance of the related model without raising any events to the parent model.
Model forceCreate(array $attributes = [])
Create a new instance of the related model. Allow mass-assignment.
Model forceCreateQuietly(array $attributes = [])
Create a new instance of the related model with mass assignment without raising model events.
Collection createMany(iterable $records)
Create a Collection of new instances of the related model.
Collection 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.
Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
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.
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 Builder newOneOfManySubQuery(string|array $groupBy, string|null $column = 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.
Builder|void 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 mixed 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.
$this withDefault(Closure|array|bool $callback = true)
Return a new model instance in case the relationship does not exist.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Eloquent/Relations/MorphOne.html