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

HasOneOrMany

class HasOneOrMany extends Relation (View source)

Methods

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

Create a new has one or many relationship 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.

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

Match the eagerly loaded results to their parents.

from Relation
mixed
getResults()

Get the results of the relationship.

from Relation
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
Builder
getRelationQuery( Builder $query, Builder $parent, array|mixed $columns = array('*'))

Add the constraints for a relationship query.

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.

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
getRelationQueryForSelfRelation( Builder $query, Builder $parent, array|mixed $columns = array('*'))

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.

Model
save( Model $model)

Attach a model instance to the parent model.

Traversable|array
saveMany( Traversable|array $models)

Attach a collection of models to the parent instance.

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

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

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.

Details

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

at line line 48
void addConstraints()

Set the base constraints on the relation query.

Return Value

void

at line line 111
void addEagerConstraints( array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

in Relation at line line 87
abstract array initRelation( array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

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

in Relation at line line 104
abstract 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 Relation at line line 146
Builder getRelationCountQuery( Builder $query, Builder $parent)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parent

Return Value

Builder

at line line 65
Builder getRelationQuery( Builder $query, Builder $parent, array|mixed $columns = array('*'))

Add the constraints for a relationship query.

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

in Relation at line line 174
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 212
Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

in Relation at line line 222
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

in Relation at line line 232
Model getParent()

Get the parent model of the relation.

Return Value

Model

at line line 403
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

in Relation at line line 252
Model getRelated()

Get the related model of the relation.

Return Value

Model

in Relation at line line 262
string createdAt()

Get the name of the "created at" column.

Return Value

string

in Relation at line line 272
string updatedAt()

Get the name of the "updated at" column.

Return Value

string

in Relation at line line 282
string relatedUpdatedAt()

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

Return Value

string

in Relation at line line 293
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 305
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 342
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 358
void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

at line line 82
Builder getRelationQueryForSelfRelation( Builder $query, Builder $parent, array|mixed $columns = array('*'))

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

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

at line line 100
string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

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

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

at line line 214
Model save( Model $model)

Attach a model instance to the parent model.

Parameters

Model $model

Return Value

Model

at line line 227
Traversable|array saveMany( Traversable|array $models)

Attach a collection of models to the parent instance.

Parameters

Traversable|array $models

Return Value

Traversable|array

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

at line line 260
Model firstOrNew( array $attributes)

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

Parameters

array $attributes

Return Value

Model

at line line 277
Model firstOrCreate( array $attributes)

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

Parameters

array $attributes

Return Value

Model

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

at line line 310
Model create( array $attributes)

Create a new instance of the related model.

Parameters

array $attributes

Return Value

Model

at line line 330
array createMany( array $records)

Create an array of new instances of the related model.

Parameters

array $records

Return Value

array

at line line 347
int update( array $attributes)

Perform an update on all the related models.

Parameters

array $attributes

Return Value

int

at line line 361
string getHasCompareKey()

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

Return Value

string

at line line 371
string getForeignKey()

Get the foreign key for the relationship.

Return Value

string

at line line 381
string getPlainForeignKey()

Get the plain foreign key.

Return Value

string

at line line 393
mixed getParentKey()

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

Return Value

mixed