1. class
  2. Illuminate
  3. Database
  4. Eloquent
  5. Relations
  6. HasOne

HasOne

class HasOne extends HasOneOrMany (View source)

Methods

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

Create a new has one or 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 HasOneOrMany
static  mixed
noConstraints( Closure $callback)

Run a callback with constraints disabled on the relation.

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
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
getRelationCountQueryForSelfRelation( Builder $query, Builder $parent)

Add the constraints for a relationship count 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
Model
save( Model $model)

Attach a model instance to the parent model.

from HasOneOrMany
Collection|array
saveMany( Collection|array $models)

Attach a collection of models to the parent instance.

from HasOneOrMany
Collection|Model
findOrNew( mixed $id, array $columns = array('*'))

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 = array())

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

Details

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

in HasOneOrMany at line line 48
void addConstraints()

Set the base constraints on the relation query.

Return Value

void

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

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

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

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

at line line 43
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 line 14
mixed getResults()

Get the results of the relationship.

Return Value

mixed

in Relation at line line 111
Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

in Relation at line line 121
void touch()

Touch all of the related models for the relationship.

Return Value

void

in Relation at line line 134
int rawUpdate( array $attributes = array())

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

in HasOneOrMany at line line 64
Builder getRelationCountQuery( Builder $query, Builder $parent)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parent

Return Value

Builder

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

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

in Relation at line line 199
Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

in Relation at line line 209
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

in Relation at line line 219
Model getParent()

Get the parent model of the relation.

Return Value

Model

in HasOneOrMany at line line 401
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

in Relation at line line 239
Model getRelated()

Get the related model of the relation.

Return Value

Model

in Relation at line line 249
string createdAt()

Get the name of the "created at" column.

Return Value

string

in Relation at line line 259
string updatedAt()

Get the name of the "updated at" column.

Return Value

string

in Relation at line line 269
string relatedUpdatedAt()

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

Return Value

string

in Relation at line line 280
string wrap( string $value)

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

Parameters

string $value

Return Value

string

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

in Relation at line line 329
mixed __call( string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

in Relation at line line 345
void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

in HasOneOrMany at line line 80
Builder getRelationCountQueryForSelfRelation( Builder $query, Builder $parent)

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

Parameters

Builder $query
Builder $parent

Return Value

Builder

in HasOneOrMany at line line 98
string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

in HasOneOrMany at line line 122
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 line 135
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 line 212
Model save( Model $model)

Attach a model instance to the parent model.

Parameters

Model $model

Return Value

Model

in HasOneOrMany at line line 225
Collection|array saveMany( Collection|array $models)

Attach a collection of models to the parent instance.

Parameters

Collection|array $models

Return Value

Collection|array

in HasOneOrMany at line line 241
Collection|Model findOrNew( mixed $id, array $columns = array('*'))

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

Parameters

mixed $id
array $columns

Return Value

Collection|Model

in HasOneOrMany at line line 258
Model firstOrNew( array $attributes)

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

Parameters

array $attributes

Return Value

Model

in HasOneOrMany at line line 275
Model firstOrCreate( array $attributes)

Get the first related record matching the attributes or create it.

Parameters

array $attributes

Return Value

Model

in HasOneOrMany at line line 291
Model updateOrCreate( array $attributes, array $values = array())

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

Parameters

array $attributes
array $values

Return Value

Model

in HasOneOrMany at line line 308
Model create( array $attributes)

Create a new instance of the related model.

Parameters

array $attributes

Return Value

Model

in HasOneOrMany at line line 328
array createMany( array $records)

Create an array of new instances of the related model.

Parameters

array $records

Return Value

array

in HasOneOrMany at line line 345
int update( array $attributes)

Perform an update on all the related models.

Parameters

array $attributes

Return Value

int

in HasOneOrMany at line line 359
string getHasCompareKey()

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

Return Value

string

in HasOneOrMany at line line 369
string getForeignKey()

Get the foreign key for the relationship.

Return Value

string

in HasOneOrMany at line line 379
string getPlainForeignKey()

Get the plain foreign key.

Return Value

string

in HasOneOrMany at line line 391
mixed getParentKey()

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

Return Value

mixed