HasOneThrough
class HasOneThrough extends HasManyThrough (View source)
Traits
| SupportsDefaultModels | |
| ForwardsCalls | |
| Macroable |
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 array | $morphMap | An array to map class names to their morph names in database. | from Relation |
| protected Model | $throughParent | The "through" parent model instance. | from HasManyThrough |
| protected Model | $farParent | The far parent model instance. | from HasManyThrough |
| protected string | $firstKey | The near key on the relationship. | from HasManyThrough |
| protected string | $secondKey | The far key on the relationship. | from HasManyThrough |
| protected string | $localKey | The local key on the relationship. | from HasManyThrough |
| protected string | $secondLocalKey | The local key on the intermediary model. | from HasManyThrough |
| static protected int | $selfJoinCount | The count of self joins. | from HasManyThrough |
| 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. | from ForwardsCalls |
| static void | throwBadMethodCallException(string $method) Throw a bad method call exception for the given method. | from ForwardsCalls |
| static void | macro(string $name, object|callable $macro) Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true) 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 $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey) Create a new has many through relationship instance. | from HasManyThrough |
| 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. | from HasManyThrough |
| void | addEagerConstraints(array $models) Set the constraints for an eager load of the relation. | from HasManyThrough |
| 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 |
| Collection | get(array $columns = ['*']) Execute the query as a "select" statement. | from HasManyThrough |
| 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 |
| Builder | getRelationExistenceCountQuery(Builder $query, Builder $parentQuery) Add the constraints for a relationship count query. | from Relation |
| Builder | getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query. | from HasManyThrough |
| array | getKeys(array $models, string|null $key = null) Get all of the primary keys for an array of models. | 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 HasManyThrough |
| 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 | whereInMethod(Model $model, string $key) Get the name of the "where in" method for eager loading. | 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 |
| void | performJoin(Builder $query = null) Set the join clause on the query. | from HasManyThrough |
| bool | throughParentSoftDeletes() Determine whether "through" parent of the relation uses Soft Deletes. | from HasManyThrough |
| $this | withTrashedParents() Indicate that trashed "through" parents should be included in the query. | from HasManyThrough |
| array | buildDictionary(Collection $results) Build model dictionary keyed by the relation's foreign key. | from HasManyThrough |
| Model | firstOrNew(array $attributes) Get the first related model record matching the attributes or instantiate it. | from HasManyThrough |
| Model | updateOrCreate(array $attributes, array $values = []) Create or update a related record matching the attributes, and fill it with values. | from HasManyThrough |
| Model|HasManyThrough | firstWhere(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and') Add a basic where clause to the query, and return the first result. | from HasManyThrough |
| mixed | first(array $columns = ['*']) Execute the query and get the first related model. | from HasManyThrough |
| Model|HasManyThrough | firstOrFail(array $columns = ['*']) Execute the query and get the first result or throw an exception. | from HasManyThrough |
| Model|Collection|null | find(mixed $id, array $columns = ['*']) Find a related model by its primary key. | from HasManyThrough |
| Collection | findMany(Arrayable|array $ids, array $columns = ['*']) Find multiple related models by their primary keys. | from HasManyThrough |
| Model|Collection | findOrFail(mixed $id, array $columns = ['*']) Find a related model by its primary key or throw an exception. | from HasManyThrough |
| LengthAwarePaginator | paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int $page = null) Get a paginator for the "select" statement. | from HasManyThrough |
| Paginator | simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null) Paginate the given query into a simple paginator. | from HasManyThrough |
| array | shouldSelect(array $columns = ['*']) Set the select clause for the relation query. | from HasManyThrough |
| bool | chunk(int $count, callable $callback) Chunk the results of the query. | from HasManyThrough |
| bool | chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null) Chunk the results of a query by comparing numeric IDs. | from HasManyThrough |
| Generator | cursor() Get a generator for the given query. | from HasManyThrough |
| bool | each(callable $callback, int $count = 1000) Execute a callback over each item while chunking. | from HasManyThrough |
| Builder | prepareQueryBuilder(array $columns = ['*']) Prepare the query builder for query execution. | from HasManyThrough |
| Builder | getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query on the same table. | from HasManyThrough |
| Builder | getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query on the same table as the through parent. | from HasManyThrough |
| string | getRelationCountHash() Get a relationship join table hash. | from HasManyThrough |
| string | getQualifiedFarKeyName() Get the qualified foreign key on the related model. | from HasManyThrough |
| string | getFirstKeyName() Get the foreign key on the "through" model. | from HasManyThrough |
| string | getQualifiedFirstKeyName() Get the qualified foreign key on the "through" model. | from HasManyThrough |
| string | getForeignKeyName() Get the foreign key on the related model. | from HasManyThrough |
| string | getQualifiedForeignKeyName() Get the qualified foreign key on the related model. | from HasManyThrough |
| string | getLocalKeyName() Get the local key on the far parent model. | from HasManyThrough |
| string | getQualifiedLocalKeyName() Get the qualified local key on the far parent model. | from HasManyThrough |
| string | getSecondLocalKeyName() Get the local key on the intermediary model. | from HasManyThrough |
| Model | newRelatedInstanceFor(Model $parent) Make a new related instance for the given model. | |
| $this | withDefault(Closure|array|bool $callback = true) Return a new model instance in case the relationship does not exist. | from SupportsDefaultModels |
| Model|null | getDefaultFor(Model $parent) Get the default value for this relation. | from SupportsDefaultModels |
Details
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
static protected void throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
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.
void __construct(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Create a new has many through relationship instance.
static mixed noConstraints(Closure $callback)
Run a callback with constraints disabled on the 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.
mixed getResults()
Get the results of the relationship.
Collection getEager()
Get the relationship for eager loading.
Collection get(array $columns = ['*'])
Execute the query as a "select" statement.
void touch()
Touch all of the related models for the relationship.
int rawUpdate(array $attributes = [])
Run a raw update against the base query.
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query.
protected array getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
Builder getQuery()
Get the underlying query for the relation.
Builder getBaseQuery()
Get the base query builder driving the Eloquent builder.
Model getParent()
Get the parent model of the relation.
string getQualifiedParentKeyName()
Get the fully qualified parent key name.
Model getRelated()
Get the related model of the relation.
string createdAt()
Get the name of the "created at" column.
string updatedAt()
Get the name of the "updated at" column.
string relatedUpdatedAt()
Get the name of the related model's "updated at" column.
protected string whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
static array morphMap(array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array $models = null)
Builds a table-keyed array from model class names.
static string|null getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
void __clone()
Force a clone of the underlying query builder when cloning.
protected void performJoin(Builder $query = null)
Set the join clause on the query.
bool throughParentSoftDeletes()
Determine whether "through" parent of the relation uses Soft Deletes.
$this withTrashedParents()
Indicate that trashed "through" parents should be included in the query.
protected array buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
Model firstOrNew(array $attributes)
Get the first related model record matching the attributes or instantiate it.
Model updateOrCreate(array $attributes, array $values = [])
Create or update a related record matching the attributes, and fill it with values.
Model|HasManyThrough firstWhere(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a basic where clause to the query, and return the first result.
mixed first(array $columns = ['*'])
Execute the query and get the first related model.
Model|HasManyThrough firstOrFail(array $columns = ['*'])
Execute the query and get the first result or throw an exception.
Model|Collection|null find(mixed $id, array $columns = ['*'])
Find a related model by its primary key.
Collection findMany(Arrayable|array $ids, array $columns = ['*'])
Find multiple related models by their primary keys.
Model|Collection findOrFail(mixed $id, array $columns = ['*'])
Find a related model by its primary key or throw an exception.
LengthAwarePaginator paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int $page = null)
Get a paginator for the "select" statement.
Paginator simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Paginate the given query into a simple paginator.
protected array shouldSelect(array $columns = ['*'])
Set the select clause for the relation query.
bool chunk(int $count, callable $callback)
Chunk the results of the query.
bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing numeric IDs.
Generator cursor()
Get a generator for the given query.
bool each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking.
protected Builder prepareQueryBuilder(array $columns = ['*'])
Prepare the query builder for query execution.
Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
Builder getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table as the through parent.
string getRelationCountHash()
Get a relationship join table hash.
string getQualifiedFarKeyName()
Get the qualified foreign key on the related model.
string getFirstKeyName()
Get the foreign key on the "through" model.
string getQualifiedFirstKeyName()
Get the qualified foreign key on the "through" model.
string getForeignKeyName()
Get the foreign key on the related model.
string getQualifiedForeignKeyName()
Get the qualified foreign key on the related model.
string getLocalKeyName()
Get the local key on the far parent model.
string getQualifiedLocalKeyName()
Get the qualified local key on the far parent model.
string getSecondLocalKeyName()
Get the local key on the intermediary model.
$this withDefault(Closure|array|bool $callback = true)
Return a new model instance in case the relationship does not exist.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Database/Eloquent/Relations/HasOneThrough.html