HasOneOrMany
abstract class HasOneOrMany extends Relation
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 |
| protected Model | $related | The related model instance. |
from Relation |
| static protected bool | $constraints | Indicates if the relation is adding constraints. |
from Relation |
| static protected 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
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new has one or many relationship instance.
Set the base constraints on the relation query.
Set the constraints for an eager load of the relation.
Initialize the relation on a set of models.
Match the eagerly loaded results to their parents.
Add the constraints for a relationship count query.
Add the constraints for a relationship query.
Get all of the primary keys for an array of models.
Get the fully qualified parent key name.
Set or get the morph map for polymorphic relations.
Builds a table-keyed array from model class names.
Get the model associated with a custom polymorphic type.
Match the eagerly loaded results to their single parents.
Match the eagerly loaded results to their many parents.
Match the eagerly loaded results to their many parents.
Get the value of a relationship by one or many type.
Find a model by its primary key or return new instance of the related model.
Get the first related model record matching the attributes or instantiate it.
Get the first related record matching the attributes or create it.
Create or update a related record matching the attributes, and fill it with values.
Create a Collection of new instances of the related model.
Perform an update on all the related models.
Add the constraints for a relationship query on the same table.
Get a relationship join table hash.
Get the key for comparing against the parent key in "has" query.
Get the key value of the parent's local key.
Get the plain foreign key.
Get the foreign key for the relationship.
Details
in
Macroable at line 24
static void
macro(string $name, callable $macro)
Register a custom macro.
in
Macroable at line 35
static bool
hasMacro(string $name)
Checks if macro is registered.
in
Macroable at line 49
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 71
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 41
void
__construct(Builder $query, Model $parent, string $foreignKey, string $localKey)
Create a new has one or many relationship instance.
in
Relation at line 79
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
at line 67
void
addConstraints()
Set the base constraints on the relation query.
at line 82
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
in
Relation at line 117
abstract array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
in
Relation at line 127
abstract array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
in
Relation at line 134
abstract mixed
getResults()
Get the results of the relationship.
in
Relation at line 141
Collection
getEager()
Get the relationship for eager loading.
in
Relation at line 151
void
touch()
Touch all of the related models for the relationship.
in
Relation at line 164
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
in
Relation at line 176
Builder
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
at line 328
Builder
getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query.
in
Relation at line 207
protected array
getKeys(array $models, string $key = null)
Get all of the primary keys for an array of models.
in
Relation at line 229
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
at line 391
string
getQualifiedParentKeyName()
Get the fully qualified parent key name.
in
Relation at line 269
string
createdAt()
Get the name of the "created at" column.
in
Relation at line 279
string
updatedAt()
Get the name of the "updated at" column.
in
Relation at line 289
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
in
Relation at line 301
static array
morphMap(array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
in
Relation at line 319
static protected array|null
buildMorphMapFromModels(array $models = null)
Builds a table-keyed array from model class names.
in
Relation at line 336
static string|null
getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
in
Relation at line 370
void
__clone()
Force a clone of the underlying query builder when cloning.
at line 55
Model
make(array $attributes = [])
Create and return an un-saved instance of the related model.
at line 97
array
matchOne(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their single parents.
at line 110
array
matchMany(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their many parents.
at line 124
protected array
matchOneOrMany(array $models, Collection $results, string $relation, string $type)
Match the eagerly loaded results to their many parents.
at line 150
protected mixed
getRelationValue(array $dictionary, string $key, string $type)
Get the value of a relationship by one or many type.
at line 163
protected array
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
at line 186
Collection|Model
findOrNew(mixed $id, array $columns = ['*'])
Find a model by its primary key or return new instance of the related model.
at line 203
Model
firstOrNew(array $attributes)
Get the first related model record matching the attributes or instantiate it.
at line 220
Model
firstOrCreate(array $attributes)
Get the first related record matching the attributes or create it.
at line 236
Model
updateOrCreate(array $attributes, array $values = [])
Create or update a related record matching the attributes, and fill it with values.
at line 264
Traversable|array
saveMany(Traversable|array $models)
Attach a collection of models to the parent instance.
at line 279
Model
create(array $attributes)
Create a new instance of the related model.
at line 294
Collection
createMany(array $records)
Create a Collection of new instances of the related model.
at line 311
int
update(array $attributes)
Perform an update on all the related models.
at line 345
Builder
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
at line 361
string
getRelationCountHash()
Get a relationship join table hash.
at line 371
string
getExistenceCompareKey()
Get the key for comparing against the parent key in "has" query.
at line 381
mixed
getParentKey()
Get the key value of the parent's local key.
at line 401
string
getForeignKeyName()
Get the plain foreign key.
at line 413
string
getQualifiedForeignKeyName()
Get the foreign key for the relationship.