class HasOne extends HasOneOrMany implements SupportsPartialRelations

Traits

Constants

protected CONSTRAINTS_CONTEXT_KEY

The context key for storing whether constraints are enabled.

Properties

static protected array $macros

The registered string macros.

from  Macroable
protected TRelatedModel> $query

The Eloquent query builder instance.

from  Relation
protected TDeclaringModel $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 Model>> $morphMap

An array to map morph names to their class 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|null $inverseRelationship

The name of the inverse relationship.

from  SupportsInverseRelations
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<mixed>|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 never
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

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

Register a custom macro.

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

Mix another object into the class.

static bool
hasMacro(string $name)

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

__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
static bool
shouldAddConstraints()

Determine if constraints should be added to the relation query.

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.

TResult
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, 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|null $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|null $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

from  Relation
static array|null
buildMorphMapFromModels(array|null $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
static int|string
getMorphAlias(string $className)

Get the alias associated with a custom polymorphic class.

from  Relation
static void
flushState()

Flush all static state.

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.

inverse(string|null $relation = null)

Instruct Eloquent to link the related models back to the parent after the relationship query has run.

chaperone(string|null $relation = null)

Instruct Eloquent to link the related models back to the parent after the relationship query has run.

string|null
guessInverseRelation()

Guess the name of the inverse relationship.

array
getPossibleInverseRelations()

Get the possible inverse relations for the parent model.

mixed
applyInverseRelationToCollection(mixed $models, Model|null $parent = null)

Set the inverse relation on all models in a collection.

applyInverseRelationToModel(Model $model, Model|null $parent = null)

Set the inverse relation on a model.

string|null
getInverseRelationship()

Get the name of the inverse relationship.

withoutInverse()

Remove the chaperone / inverse relationship for this query.

withoutChaperone()

Remove the chaperone / inverse relationship for this query.

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, int|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 = [], Closure|array $values = [])

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

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

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

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

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

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

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

int
upsert(array $values, array|string $uniqueBy, array|null $update = null)

Insert new records or update the existing ones.

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.

forceCreateMany(iterable $records)

Create a Collection of new instances of the related model, allowing mass-assignment.

forceCreateManyQuietly(iterable $records)

Create a Collection of new instances of the related model, allowing mass-assignment and 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, mixed $columns = ['*'])

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

take(int $value)

Alias to set the "limit" value of the query.

limit(int $value)

Set the "limit" value of the query.

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.

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.

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.

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, array|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, array $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|null
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.

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

in ForwardsCalls at line 22
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

in ForwardsCalls at line 52
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

in ForwardsCalls at line 66
static protected never throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

never

Exceptions

BadMethodCallException

in Macroable at line 28
static void macro(string $name, callable|object $macro)

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 41
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 57
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 68
static void flushMacros()

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 78
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 103
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in HasOneOrMany at line 44
__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

in Relation at line 105
static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

in Relation at line 124
static bool shouldAddConstraints()

Determine if constraints should be added to the relation query.

Return Value

bool

in HasOneOrMany at line 84
void addConstraints()

Set the base constraints on the relation query.

Return Value

void

in HasOneOrMany at line 95
void addEagerConstraints(array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

at line 37
array initRelation(array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

at line 46
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

at line 28
TResult getResults()

Get the results of the relationship.

Return Value

TResult

in Relation at line 170
Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

in Relation at line 185
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

TRelatedModel>
MultipleRecordsFoundException

in Relation at line 208
Collection get(array $columns = ['*'])

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

in Relation at line 216
void touch()

Touch all of the related models for the relationship.

Return Value

void

in Relation at line 230
int rawUpdate(array $attributes = [])

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

in Relation at line 242
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parentQuery

Return Value

Builder

at line 51
Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, 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
mixed $columns

Return Value

Builder

in Relation at line 272
string getRelationCountHash(bool $incrementJoinCount = true)

Get a relationship join table hash.

Parameters

bool $incrementJoinCount

Return Value

string

in Relation at line 283
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

in CanBeOneOfMany at line 240
protected Builder getRelationQuery()

Get the query builder that will contain the relationship constraints.

Return Value

Builder

in Relation at line 305
Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

in Relation at line 313
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

in Relation at line 321
Builder toBase()

Get a base query builder instance.

Return Value

Builder

in Relation at line 331
Model getParent()

Get the parent model of the relation.

Return Value

Model

in HasOneOrMany at line 540
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

in Relation at line 349
Model getRelated()

Get the related model of the relation.

Return Value

Model

in Relation at line 357
string createdAt()

Get the name of the "created at" column.

Return Value

string

in Relation at line 365
string updatedAt()

Get the name of the "updated at" column.

Return Value

string

in Relation at line 373
string relatedUpdatedAt()

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

Return Value

string

in Relation at line 383
protected void whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $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|null $query

Return Value

void

in Relation at line 395
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

in Relation at line 409
static void requireMorphMap(bool $requireMorphMap = true)

Prevent polymorphic relationships from being used without model mappings.

Boot-only. The flag persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.

Parameters

bool $requireMorphMap

Return Value

void

in Relation at line 417
static bool requiresMorphMap()

Determine if polymorphic relationships require explicit model mapping.

Return Value

bool

in Relation at line 430
static array enforceMorphMap(array $map, bool $merge = true)

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

Boot-only. Sets both worker-wide morph state (requireMorphMap + morphMap) shared by every coroutine.

Parameters

array $map
bool $merge

Return Value

array

in Relation at line 447
static array morphMap(array|null $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

Boot-only when setting. The map persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.

Parameters

array|null $map
bool $merge

Return Value

array

in Relation at line 466
static protected array|null buildMorphMapFromModels(array|null $models = null)

Builds a table-keyed array from model class names.

Parameters

array|null $models

Return Value

array|null

in Relation at line 483
static string|null getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

Parameters

string $alias

Return Value

string|null

in Relation at line 493
static int|string getMorphAlias(string $className)

Get the alias associated with a custom polymorphic class.

Parameters

string $className

Return Value

int|string

in Relation at line 501
static void flushState()

Flush all static state.

Return Value

void

in Relation at line 524
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

SupportsInverseRelations inverse(string|null $relation = null)

Instruct Eloquent to link the related models back to the parent after the relationship query has run.

Alias of "chaperone".

Parameters

string|null $relation

Return Value

SupportsInverseRelations

SupportsInverseRelations chaperone(string|null $relation = null)

Instruct Eloquent to link the related models back to the parent after the relationship query has run.

Parameters

string|null $relation

Return Value

SupportsInverseRelations

protected string|null guessInverseRelation()

Guess the name of the inverse relationship.

Return Value

string|null

protected array getPossibleInverseRelations()

Get the possible inverse relations for the parent model.

Return Value

array

protected mixed applyInverseRelationToCollection(mixed $models, Model|null $parent = null)

Set the inverse relation on all models in a collection.

Parameters

mixed $models
Model|null $parent

Return Value

mixed

protected Model applyInverseRelationToModel(Model $model, Model|null $parent = null)

Set the inverse relation on a model.

Parameters

Model $model
Model|null $parent

Return Value

Model

string|null getInverseRelationship()

Get the name of the inverse relationship.

Return Value

string|null

SupportsInverseRelations withoutInverse()

Remove the chaperone / inverse relationship for this query.

Alias of "withoutChaperone".

SupportsInverseRelations withoutChaperone()

Remove the chaperone / inverse relationship for this query.

in HasOneOrMany at line 57
Model make(array $attributes = [])

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

Parameters

array $attributes

Return Value

Model

in HasOneOrMany at line 70
Collection makeMany(iterable $records)

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

Parameters

iterable $records

Return Value

Collection

in HasOneOrMany at line 114
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

in HasOneOrMany at line 126
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

in HasOneOrMany at line 138
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

in HasOneOrMany at line 166
protected mixed getRelationValue(array $dictionary, int|string $key, string $type)

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

Parameters

array $dictionary
int|string $key
string $type

Return Value

mixed

in HasOneOrMany at line 179
protected array buildDictionary(Collection $results)

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

Parameters

Collection $results

Return Value

array

in HasOneOrMany at line 205
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

in HasOneOrMany at line 221
Model firstOrNew(array $attributes = [], Closure|array $values = [])

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

Parameters

array $attributes
Closure|array $values

Return Value

Model

in HasOneOrMany at line 237
Model firstOrCreate(array $attributes = [], Closure|array $values = [])

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

Parameters

array $attributes
Closure|array $values

Return Value

Model

in HasOneOrMany at line 251
Model createOrFirst(array $attributes = [], Closure|array $values = [])

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

Parameters

array $attributes
Closure|array $values

Return Value

Model

in HasOneOrMany at line 267
Model updateOrCreate(array $attributes, Closure|array $values = [])

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

Parameters

array $attributes
Closure|array $values

Return Value

Model

in HasOneOrMany at line 279
int upsert(array $values, array|string $uniqueBy, array|null $update = null)

Insert new records or update the existing ones.

Parameters

array $values
array|string $uniqueBy
array|null $update

Return Value

int

in HasOneOrMany at line 298
Model|false save(Model $model)

Attach a model instance to the parent model.

Parameters

Model $model

Return Value

Model|false

in HasOneOrMany at line 311
Model|false saveQuietly(Model $model)

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

Parameters

Model $model

Return Value

Model|false

in HasOneOrMany at line 324
iterable saveMany(iterable $models)

Attach a collection of models to the parent instance.

Parameters

iterable $models

Return Value

iterable

in HasOneOrMany at line 339
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

in HasOneOrMany at line 351
Model create(array $attributes = [])

Create a new instance of the related model.

Parameters

array $attributes

Return Value

Model

in HasOneOrMany at line 367
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

in HasOneOrMany at line 377
Model forceCreate(array $attributes = [])

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

Parameters

array $attributes

Return Value

Model

in HasOneOrMany at line 389
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

in HasOneOrMany at line 399
Collection createMany(iterable $records)

Create a Collection of new instances of the related model.

Parameters

iterable $records

Return Value

Collection

in HasOneOrMany at line 415
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

in HasOneOrMany at line 425
Collection forceCreateMany(iterable $records)

Create a Collection of new instances of the related model, allowing mass-assignment.

Parameters

iterable $records

Return Value

Collection

in HasOneOrMany at line 441
Collection forceCreateManyQuietly(iterable $records)

Create a Collection of new instances of the related model, allowing mass-assignment and without raising any events to the parent model.

Parameters

iterable $records

Return Value

Collection

in HasOneOrMany at line 451
protected void setForeignAttributesForCreate(Model $model)

Set the foreign ID for creating a related model.

Parameters

Model $model

Return Value

void

in HasOneOrMany at line 482
Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, mixed $columns = ['*'])

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

Parameters

Builder $query
Builder $parentQuery
mixed $columns

Return Value

Builder

in HasOneOrMany at line 500
HasOneOrMany take(int $value)

Alias to set the "limit" value of the query.

Parameters

int $value

Return Value

HasOneOrMany

in HasOneOrMany at line 510
HasOneOrMany limit(int $value)

Set the "limit" value of the query.

Parameters

int $value

Return Value

HasOneOrMany

in HasOneOrMany at line 524
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

in HasOneOrMany at line 548
string getForeignKeyName()

Get the plain foreign key.

Return Value

string

in HasOneOrMany at line 558
string getQualifiedForeignKeyName()

Get the foreign key for the relationship.

Return Value

string

in HasOneOrMany at line 566
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

at line 105
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

at line 65
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

at line 73
array|string getOneOfManySubQuerySelectColumns()

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

Return Value

array|string

at line 81
void addOneOfManyJoinSubQueryConstraints(JoinClause $join)

Add join query constraints for one of many relationships.

Parameters

JoinClause $join

Return Value

void

in CanBeOneOfMany at line 57
CanBeOneOfMany 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

CanBeOneOfMany

Exceptions

InvalidArgumentException

in CanBeOneOfMany at line 137
CanBeOneOfMany 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

CanBeOneOfMany

in CanBeOneOfMany at line 149
CanBeOneOfMany 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

CanBeOneOfMany

in CanBeOneOfMany at line 159
protected string getDefaultOneOfManyJoinAlias(string $relation)

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

Parameters

string $relation

Return Value

string

in CanBeOneOfMany at line 172
protected Builder newOneOfManySubQuery(string|array $groupBy, array|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
array|null $columns
string|null $aggregate

Return Value

Builder

in CanBeOneOfMany at line 208
protected void addOneOfManyJoinSubQuery(Builder $parent, Builder $subQuery, array $on)

Add the join subquery to the given query on the given column and the relationship's foreign key.

Parameters

Builder $parent
Builder $subQuery
array $on

Return Value

void

in CanBeOneOfMany at line 228
protected void mergeOneOfManyJoinsTo(Builder $query)

Merge the relationship query joins to the given query builder.

Parameters

Builder $query

Return Value

void

in CanBeOneOfMany at line 252
Builder|null getOneOfManySubQuery()

Get the one of many inner join subselect builder instance.

Return Value

Builder|null

in CanBeOneOfMany at line 260
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

in CanBeOneOfMany at line 268
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

in CanBeOneOfMany at line 276
protected string guessRelationship()

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

Return Value

string

in CanBeOneOfMany at line 284
bool isOneOfMany()

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

Return Value

bool

in CanBeOneOfMany at line 292
string getRelationName()

Get the name of the relationship.

Return Value

string

at line 92
Model newRelatedInstanceFor(Model $parent)

Make a new related instance for the given model.

Parameters

Model $parent

Return Value

Model

SupportsDefaultModels 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

SupportsDefaultModels

protected Model|null getDefaultFor(Model $parent)

Get the default value for this relation.

Parameters

Model $parent

Return Value

Model|null