HasOneOrMany
class HasOneOrMany extends Relation (View source)
Properties
| 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 |
| protected string | $foreignKey | The foreign key of the parent model. | |
| protected string | $localKey | The local key of the parent model. |
Methods
| void | __construct(Builder $query, Model $parent, string $foreignKey, string $localKey) Create a new has 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 |
| static mixed | noConstraints(Closure $callback) Run a callback with constraints disabled on the relation. | from Relation |
| array | getKeys(array $models, string $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. | |
| 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 |
| mixed | __call(string $method, array $parameters) Handle dynamic method calls to the relationship. | from Relation |
| 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. | |
| Model | save(Model $model) Attach a model instance to the parent model. | |
| array | saveMany(array $models) Attach an array of models to the parent instance. | |
| 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
void __construct(Builder $query, Model $parent, string $foreignKey, string $localKey)
Create a new has 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.
abstract array initRelation(array $models, string $relation)
Initialize the relation on a set of models.
abstract array match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
abstract mixed getResults()
Get the results of the relationship.
Collection getEager()
Get the relationship for eager loading.
void touch()
Touch all of the related models for the relationship.
int rawUpdate(array $attributes = array())
Run a raw update against the base query.
Builder getRelationCountQuery(Builder $query, Builder $parent)
Add the constraints for a relationship count query.
static mixed noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
protected array getKeys(array $models, string $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.
string wrap(string $value)
Wrap the given value with the parent query's grammar.
mixed __call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
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.
protected array matchOneOrMany(array $models, Collection $results, string $relation, string $type)
Match the eagerly loaded results to their many parents.
protected mixed getRelationValue(array $dictionary, string $key, string $type)
Get the value of a relationship by one or many type.
protected array buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
array saveMany(array $models)
Attach an array of models to the parent instance.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Database/Eloquent/Relations/HasOneOrMany.html