abstract class HasOneOrMany extends Relation (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
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 database. from Relation
protected string $foreignKey The foreign key of the parent model.
protected string $localKey The local key of the parent model.
static protected int $selfJoinCount The count of self joins.

Methods

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

Register a custom macro.

from Macroable
static void
mixin(object $mixin)

Mix another object into the class.

from Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

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

Dynamically handle calls to the class.

from Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
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.

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
getEager()

Get the relationship for eager loading.

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 a relationship query.

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

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

from Relation
getQuery()

Get the underlying query for the relation.

from Relation
getBaseQuery()

Get the base query builder driving the Eloquent builder.

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
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
make(array $attributes = [])

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

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 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 related record matching the attributes or create it.

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.

Traversable|array
saveMany(Traversable|array $models)

Attach a collection of models to the parent instance.

create(array $attributes = [])

Create a new instance of the related model.

createMany(array $records)

Create a Collection of new instances of the related model.

void
setForeignAttributesForCreate(Model $model)

Set the foreign ID for creating a related model.

int
update(array $attributes)

Perform an update on all the related models.

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

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

string
getRelationCountHash()

Get a relationship join table hash.

string
getExistenceCompareKey()

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

mixed
getParentKey()

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

string
getForeignKeyName()

Get the plain foreign key.

string
getQualifiedForeignKeyName()

Get the foreign key for the relationship.

Details

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)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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

abstract array initRelation(array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

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

abstract mixed getResults()

Get the results of the relationship.

Return Value

mixed

Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

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 a relationship query.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

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

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

Model make(array $attributes = [])

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

Parameters

array $attributes

Return Value

Model

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 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 related record matching the attributes or create it.

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

Traversable|array saveMany(Traversable|array $models)

Attach a collection of models to the parent instance.

Parameters

Traversable|array $models

Return Value

Traversable|array

Model create(array $attributes = [])

Create a new instance of the related model.

Parameters

array $attributes

Return Value

Model

Collection createMany(array $records)

Create a Collection of new instances of the related model.

Parameters

array $records

Return Value

Collection

protected void setForeignAttributesForCreate(Model $model)

Set the foreign ID for creating a related model.

Parameters

Model $model

Return Value

void

int update(array $attributes)

Perform an update on all the related models.

Parameters

array $attributes

Return Value

int

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 getRelationCountHash()

Get a relationship join table hash.

Return Value

string

string getExistenceCompareKey()

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

Return Value

string

mixed getParentKey()

Get the key value of the parent's local 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