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
$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

Methods

void __construct(Builder $query, Model $parent, string $foreignKey, string $localKey)

Create a new has many relationship 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 = array())

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
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
mixed __call(string $method, array $parameters)

Handle dynamic method calls to the relationship.

 from Relation
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
array saveMany(array $models)

Attach an array of models to the parent instance.

 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

Details

void __construct(Builder $query, Model $parent, string $foreignKey, string $localKey)

Create a new has many relationship instance.

Parameters

Builder $query
Model $parent
string $foreignKey
string $localKey

Return Value

void

void addConstraints()

Set the base constraints on the relation query.

Return Value

void

void addEagerConstraints(array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

array initRelation(array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

array match(array $models, Collection $results, string $relation)

Match the eagerly loaded results to their parents.

Parameters

array $models
Collection $results
string $relation

Return Value

array

mixed getResults()

Get the results of the relationship.

Return Value

mixed

Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

void touch()

Touch all of the related models for the relationship.

Return Value

void

int rawUpdate(array $attributes = array())

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

Builder getRelationCountQuery(Builder $query, Builder $parent)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parent

Return Value

Builder

static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

protected array getKeys(array $models, string $key = null)

Get all of the primary keys for an array of models.

Parameters

array $models
string $key

Return Value

array

Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

Model getParent()

Get the parent model of the relation.

Return Value

Model

string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

Model getRelated()

Get the related model of the relation.

Return Value

Model

string createdAt()

Get the name of the "created at" column.

Return Value

string

string updatedAt()

Get the name of the "updated at" column.

Return Value

string

string relatedUpdatedAt()

Get the name of the related model's "updated at" column.

Return Value

string

string wrap(string $value)

Wrap the given value with the parent query's grammar.

Parameters

string $value

Return Value

string

mixed __call(string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

array matchOne(array $models, Collection $results, string $relation)

Match the eagerly loaded results to their single parents.

Parameters

array $models
Collection $results
string $relation

Return Value

array

array matchMany(array $models, Collection $results, string $relation)

Match the eagerly loaded results to their many parents.

Parameters

array $models
Collection $results
string $relation

Return Value

array

protected array matchOneOrMany(array $models, Collection $results, string $relation, string $type)

Match the eagerly loaded results to their many parents.

Parameters

array $models
Collection $results
string $relation
string $type

Return Value

array

protected mixed getRelationValue(array $dictionary, string $key, string $type)

Get the value of a relationship by one or many type.

Parameters

array $dictionary
string $key
string $type

Return Value

mixed

protected array buildDictionary(Collection $results)

Build model dictionary keyed by the relation's foreign key.

Parameters

Collection $results

Return Value

array

Model save(Model $model)

Attach a model instance to the parent model.

Parameters

Model $model

Return Value

Model

array saveMany(array $models)

Attach an array of models to the parent instance.

Parameters

array $models

Return Value

array

Model create(array $attributes)

Create a new instance of the related model.

Parameters

array $attributes

Return Value

Model

array createMany(array $records)

Create an array of new instances of the related model.

Parameters

array $records

Return Value

array

int update(array $attributes)

Perform an update on all the related models.

Parameters

array $attributes

Return Value

int

string getHasCompareKey()

Get the key for comparing against the parent key in "has" query.

Return Value

string

string getForeignKey()

Get the foreign key for the relationship.

Return Value

string

string getPlainForeignKey()

Get the plain foreign key.

Return Value

string

mixed getParentKey()

Get the key value of the parent's local key.

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Database/Eloquent/Relations/HasOne.html