HasOne
class HasOne extends HasOneOrMany (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 |
| static protected 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 Closure|bool | $withDefault | Indicates if a default model instance should be used. |
Methods
| void | __construct(Builder $query, Model $parent, string $foreignKey, string $localKey) Create a new relation instance. | from HasOneOrMany |
| void | addConstraints() Set the base constraints on the relation query. | from HasOneOrMany |
| void | addEagerConstraints(array $models) Set the constraints for an eager load of the relation. | from HasOneOrMany |
| 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 |
| 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 | getRelationCountQuery(Builder $query, Builder $parent) Add the constraints for a relationship count query. | from Relation |
| Builder | getRelationQuery(Builder $query, Builder $parent, array|mixed $columns = ['*']) Add the constraints for a relationship query. | from HasOneOrMany |
| static mixed | noConstraints(Closure $callback) Run a callback with constraints disabled on the relation. | from Relation |
| array | getKeys(array $models, string $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 | wrap(string $value) Wrap the given value with the parent query's grammar. | 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 |
| mixed | __call(string $method, array $parameters) Handle dynamic method calls to the relationship. | from Relation |
| void | __clone() Force a clone of the underlying query builder when cloning. | from Relation |
| Builder | getRelationQueryForSelfRelation(Builder $query, Builder $parent, 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 |
| 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 |
| Model | save(Model $model) Attach a model instance to the parent model. | from HasOneOrMany |
| Traversable|array | saveMany(Traversable|array $models) Attach a collection of models to the parent instance. | 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) Get the first related model record matching the attributes or instantiate it. | from HasOneOrMany |
| Model | firstOrCreate(array $attributes) 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 | create(array $attributes) Create a new instance of the related model. | from HasOneOrMany |
| array | createMany(array $records) Create an array of new instances of the related model. | from HasOneOrMany |
| int | update(array $attributes) Perform an update on all the related models. | from HasOneOrMany |
| string | getHasCompareKey() Get the key for comparing against the parent key in "has" query. | from HasOneOrMany |
| string | getForeignKey() Get the foreign key for the relationship. | from HasOneOrMany |
| string | getPlainForeignKey() Get the plain foreign key. | from HasOneOrMany |
| mixed | getParentKey() Get the key value of the parent's local key. | from HasOneOrMany |
| $this | withDefault(Closure|bool $callback = true) Return a new model instance in case the relationship does not exist. | |
| Model|null | getDefaultFor(Model $model) Get the default value for this relation. |
Details
void __construct(Builder $query, Model $parent, string $foreignKey, string $localKey)
Create a new relation 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 = [])
Run a raw update against the base query.
Builder getRelationCountQuery(Builder $query, Builder $parent)
Add the constraints for a relationship count query.
Builder getRelationQuery(Builder $query, Builder $parent, array|mixed $columns = ['*'])
Add the constraints for a relationship 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.
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.
mixed __call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
void __clone()
Force a clone of the underlying query builder when cloning.
Builder getRelationQueryForSelfRelation(Builder $query, Builder $parent, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
string getRelationCountHash()
Get a relationship join table hash.
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.
Traversable|array saveMany(Traversable|array $models)
Attach a collection of models to the parent instance.
Collection|Model findOrNew(mixed $id, array $columns = ['*'])
Find a model by its primary key or return new instance of the related model.
Model firstOrNew(array $attributes)
Get the first related model record matching the attributes or instantiate it.
Model firstOrCreate(array $attributes)
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 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.
$this withDefault(Closure|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/5.3/Illuminate/Database/Eloquent/Relations/HasOne.html