class MorphOne extends MorphOneOrMany (View source)
| ComparesRelatedModels | |
| SupportsDefaultModels | |
| ForwardsCalls | |
| 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 array | $morphMap | An array to map class names to their morph names in database. | 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 |
| static protected int | $selfJoinCount | The count of self joins. | 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 Closure|array|bool | $withDefault | Indicates if a default model instance should be used. | from SupportsDefaultModels |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object. | 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 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 |
| 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. | from MorphOneOrMany |
| array | getKeys(array $models, string|null $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. | 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 |
| string | whereInMethod(Model $model, string $key) Get the name of the "where in" method for eager loading. | 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 |
| 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 instances 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 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 |
| iterable | saveMany(iterable $models) Attach a collection of models to the parent instance. | from HasOneOrMany |
| Model | create(array $attributes = []) Create a new instance of the related model. | from HasOneOrMany |
| Collection | createMany(iterable $records) Create a Collection of new instances of the related 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 | getRelationCountHash() Get a relationship join table hash. | 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 |
| 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 |
Forward a method call to the given object.
Throw a bad method call exception for the given method.
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 one or 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.
Run a raw update against the base query.
Add the constraints for a relationship count query.
Get the relationship 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.
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.
Get the name of the "where in" method for eager loading.
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.
Create and return an un-saved instance of the related model.
Create and return an un-saved instances 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.
Build model dictionary keyed by the relation's foreign key.
Find a 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.
Attach a collection of models to the parent instance.
Create a new instance of the related model.
Create a Collection of new instances of the related model.
Set the foreign ID and type for creating a related model.
Add the constraints for a relationship query on the same table.
Get a relationship join table hash.
Get the key for comparing against the parent key in "has" query.
Get the value of the parent model's key.
Get the plain foreign key.
Get the foreign key for the relationship.
Get the local key for the relationship.
Get the foreign key "type" name.
Get the plain morph type name without the table.
Get the class name of the parent model.
Determine if the model is the related instance of the relationship.
Determine if the model is not the related instance of the relationship.
Get the value of the model's foreign key.
Compare the parent key with the related key.
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/8.x/Illuminate/Database/Eloquent/Relations/MorphOne.html