class HasOne extends HasOneOrMany implements SupportsPartialRelations (View source)

Traits

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

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 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 $foreignKey, string $localKey)

Create a new has one or many relationship instance.

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.

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.

getEager()

Get the relationship for eager loading.

from  Relation
sole(array|string $columns = ['*'])

Execute the query and get the first result if it's the sole matching record.

from  Relation
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
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

from  Relation
getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for an internal relationship existence 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
getRelationQuery()

Get the query builder that will contain the relationship constraints.

getQuery()

Get the underlying query for the relation.

from  Relation
getBaseQuery()

Get the base query builder driving the Eloquent builder.

from  Relation
toBase()

Get a base query builder instance.

from  Relation
getParent()

Get the parent model of the relation.

from  Relation
string
getQualifiedParentKeyName()

Get the fully qualified parent key name.

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.

make(array $attributes = [])

Create and return an un-saved instance of the related model.

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.

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

Match the eagerly loaded results to their many parents.

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

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

array
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.

firstOrNew(array $attributes = [], array $values = [])

Get the first related model record matching the attributes or instantiate it.

firstOrCreate(array $attributes = [], array $values = [])

Get the first record matching the attributes. If the record is not found, create it.

createOrFirst(array $attributes = [], array $values = [])

Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.

updateOrCreate(array $attributes, array $values = [])

Create or update a related record matching the attributes, and fill it with values.

Model|false
save(Model $model)

Attach a model instance to the parent model.

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.

create(array $attributes = [])

Create a new instance of the related model.

createQuietly(array $attributes = [])

Create a new instance of the related model without raising any events to the parent model.

forceCreate(array $attributes = [])

Create a new instance of the related model. Allow mass-assignment.

forceCreateQuietly(array $attributes = [])

Create a new instance of the related model with mass assignment without raising model events.

createMany(iterable $records)

Create a Collection of new instances of the related model.

createManyQuietly(iterable $records)

Create a Collection of new instances of the related model without raising any events to the parent model.

void
setForeignAttributesForCreate(Model $model)

Set the foreign ID for creating a related model.

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.

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.

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.

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.

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.

string
getDefaultOneOfManyJoinAlias(string $relation)

Get the default alias for the one of many inner join clause.

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.

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.

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.

string
qualifyRelatedColumn(string $column)

Qualify related column using the related table name if it is not already qualified.

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.

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.

Model|null
getDefaultFor(Model $parent)

Get the default value for this relation.

Details

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new has one or many relationship instance.

Parameters

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

Return Value

void

static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

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

Model sole(array|string $columns = ['*'])

Execute the query and get the first result if it's the sole matching record.

Parameters

array|string $columns

Return Value

Model

Exceptions

Model>
MultipleRecordsFoundException

Collection get(array $columns = ['*'])

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

void touch()

Touch all of the related models for the relationship.

Return Value

void

int rawUpdate(array $attributes = [])

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parentQuery

Return Value

Builder

Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for an internal relationship existence query.

Essentially, these queries compare on column names like "whereColumn".

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

string getRelationCountHash(bool $incrementJoinCount = true)

Get a relationship join table hash.

Parameters

bool $incrementJoinCount

Return Value

string

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

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

Parameters

array $models
string|null $key

Return Value

array

protected Builder getRelationQuery()

Get the query builder that will contain the relationship constraints.

Return Value

Builder

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

Builder toBase()

Get a base query builder instance.

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

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.

Parameters

string $whereIn
string $key
array $modelKeys
Builder $query

Return Value

void

protected string whereInMethod(Model $model, string $key)

Get the name of the "where in" method for eager loading.

Parameters

Model $model
string $key

Return Value

string

static void requireMorphMap(bool $requireMorphMap = true)

Prevent polymorphic relationships from being used without model mappings.

Parameters

bool $requireMorphMap

Return Value

void

static bool requiresMorphMap()

Determine if polymorphic relationships require explicit model mapping.

Return Value

bool

static array enforceMorphMap(array $map, bool $merge = true)

Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.

Parameters

array $map
bool $merge

Return Value

array

static array morphMap(array $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

Parameters

array $map
bool $merge

Return Value

array

static protected array|null buildMorphMapFromModels(array $models = null)

Builds a table-keyed array from model class names.

Parameters

array $models

Return Value

array|null

static string|null getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

Parameters

string $alias

Return Value

string|null

void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

protected mixed getDictionaryKey(mixed $attribute)

Get a dictionary key attribute - casting it to a string if necessary.

Parameters

mixed $attribute

Return Value

mixed

Exceptions

InvalidArgumentException

Model make(array $attributes = [])

Create and return an un-saved instance of the related model.

Parameters

array $attributes

Return Value

Model

Collection makeMany(iterable $records)

Create and return an un-saved instance of the related models.

Parameters

iterable $records

Return Value

Collection

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

Collection|Model findOrNew(mixed $id, array $columns = ['*'])

Find a model by its primary key or return a new instance of the related model.

Parameters

mixed $id
array $columns

Return Value

Collection|Model

Model firstOrNew(array $attributes = [], array $values = [])

Get the first related model record matching the attributes or instantiate it.

Parameters

array $attributes
array $values

Return Value

Model

Model firstOrCreate(array $attributes = [], array $values = [])

Get the first record matching the attributes. If the record is not found, create it.

Parameters

array $attributes
array $values

Return Value

Model

Model createOrFirst(array $attributes = [], array $values = [])

Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.

Parameters

array $attributes
array $values

Return Value

Model

Model updateOrCreate(array $attributes, array $values = [])

Create or update a related record matching the attributes, and fill it with values.

Parameters

array $attributes
array $values

Return Value

Model

Model|false save(Model $model)

Attach a model instance to the parent model.

Parameters

Model $model

Return Value

Model|false

Model|false saveQuietly(Model $model)

Attach a model instance without raising any events to the parent model.

Parameters

Model $model

Return Value

Model|false

iterable saveMany(iterable $models)

Attach a collection of models to the parent instance.

Parameters

iterable $models

Return Value

iterable

iterable saveManyQuietly(iterable $models)

Attach a collection of models to the parent instance without raising any events to the parent model.

Parameters

iterable $models

Return Value

iterable

Model create(array $attributes = [])

Create a new instance of the related model.

Parameters

array $attributes

Return Value

Model

Model createQuietly(array $attributes = [])

Create a new instance of the related model without raising any events to the parent model.

Parameters

array $attributes

Return Value

Model

Model forceCreate(array $attributes = [])

Create a new instance of the related model. Allow mass-assignment.

Parameters

array $attributes

Return Value

Model

Model forceCreateQuietly(array $attributes = [])

Create a new instance of the related model with mass assignment without raising model events.

Parameters

array $attributes

Return Value

Model

Collection createMany(iterable $records)

Create a Collection of new instances of the related model.

Parameters

iterable $records

Return Value

Collection

Collection createManyQuietly(iterable $records)

Create a Collection of new instances of the related model without raising any events to the parent model.

Parameters

iterable $records

Return Value

Collection

protected void setForeignAttributesForCreate(Model $model)

Set the foreign ID for creating a related model.

Parameters

Model $model

Return Value

void

Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

string getExistenceCompareKey()

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

Return Value

string

abstract mixed getParentKey()

Get the value of the parent model's key.

Return Value

mixed

string getForeignKeyName()

Get the plain foreign key.

Return Value

string

string getQualifiedForeignKeyName()

Get the foreign key for the relationship.

Return Value

string

string getLocalKeyName()

Get the local key for the relationship.

Return Value

string

bool is(Model|null $model)

Determine if the model is the related instance of the relationship.

Parameters

Model|null $model

Return Value

bool

bool isNot(Model|null $model)

Determine if the model is not the related instance of the relationship.

Parameters

Model|null $model

Return Value

bool

protected mixed getRelatedKeyFrom(Model $model)

Get the value of the model's foreign key.

Parameters

Model $model

Return Value

mixed

protected bool compareKeys(mixed $parentKey, mixed $relatedKey)

Compare the parent key with the related key.

Parameters

mixed $parentKey
mixed $relatedKey

Return Value

bool

void addOneOfManySubQueryConstraints(Builder $query, string|null $column = null, string|null $aggregate = null)

Add constraints for inner join subselect for one of many relationships.

Parameters

Builder $query
string|null $column
string|null $aggregate

Return Value

void

array|string getOneOfManySubQuerySelectColumns()

Get the columns that should be selected by the one of many subquery.

Return Value

array|string

void addOneOfManyJoinSubQueryConstraints(JoinClause $join)

Add join query constraints for one of many relationships.

Parameters

JoinClause $join

Return Value

void

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

Parameters

string|array|null $column
string|Closure|null $aggregate
string|null $relation

Return Value

$this

Exceptions

InvalidArgumentException

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

Parameters

string|array|null $column
string|null $relation

Return Value

$this

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

Parameters

string|array|null $column
string|null $relation

Return Value

$this

protected string getDefaultOneOfManyJoinAlias(string $relation)

Get the default alias for the one of many inner join clause.

Parameters

string $relation

Return Value

string

protected Builder 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.

Parameters

string|array $groupBy
string[]|null $columns
string|null $aggregate

Return Value

Builder

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.

Parameters

Builder $parent
Builder $subQuery
string[] $on

Return Value

void

protected void mergeOneOfManyJoinsTo(Builder $query)

Merge the relationship query joins to the given query builder.

Parameters

Builder $query

Return Value

void

Builder|void getOneOfManySubQuery()

Get the one of many inner join subselect builder instance.

Return Value

Builder|void

string qualifySubSelectColumn(string $column)

Get the qualified column name for the one-of-many relationship using the subselect join query's alias.

Parameters

string $column

Return Value

string

protected string qualifyRelatedColumn(string $column)

Qualify related column using the related table name if it is not already qualified.

Parameters

string $column

Return Value

string

protected string guessRelationship()

Guess the "hasOne" relationship's name via backtrace.

Return Value

string

bool isOneOfMany()

Determine whether the relationship is a one-of-many relationship.

Return Value

bool

string getRelationName()

Get the name of the relationship.

Return Value

string

Model newRelatedInstanceFor(Model $parent)

Make a new related instance for the given model.

Parameters

Model $parent

Return Value

Model

$this withDefault(Closure|array|bool $callback = true)

Return a new model instance in case the relationship does not exist.

Parameters

Closure|array|bool $callback

Return Value

$this

protected Model|null getDefaultFor(Model $parent)

Get the default value for this relation.

Parameters

Model $parent

Return Value

Model|null