BelongsToMany
class Winter\Storm\Database\Relations\BelongsToMany
extends Illuminate\Database\Eloquent\Relations\BelongsToManyExtends
| Class | Description |
|---|---|
Illuminate\Database\Eloquent\Relations\BelongsToMany
|
Traits
| Trait | Description |
|---|---|
BelongsOrMorphsToMany
|
|
DeferOneOrMany
|
|
DefinedConstraints
|
Properties
inherited
public
$countMode
:
bool
= false
Inherited from
BelongsOrMorphsToMany
This relation object is a 'count' helper.
inherited
public
$orphanMode
:
bool
= false
Inherited from
BelongsOrMorphsToMany
When a join is not used, don't select aliased columns.
Methods
inherited
public
__construct (Winter\Storm\Database\Builder $query, Winter\Storm\Database\Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, $parentKey, $relatedKey, string $relationName = null)
: void
Inherited from
BelongsOrMorphsToMany
Create a new belongs to many relationship instance.
Parameters
| Property | Type | Description |
|---|---|---|
| $query | Winter\Storm\Database\Builder |
Winter\Storm\Database\Builder
|
| $parent | Winter\Storm\Database\Model |
Winter\Storm\Database\Model
|
| $table | string |
string
|
| $foreignPivotKey | string |
string
|
| $relatedPivotKey | string |
string
|
| $parentKey | mixed |
mixed
|
| $relatedKey | mixed |
mixed
|
| $relationName | string |
string
|
Returns
void
inherited
public
add (Illuminate\Database\Eloquent\Model $model, $sessionKey = null, array $pivotData = [])
Inherited from
BelongsOrMorphsToMany
Adds a model to this relationship type.
Parameters
| Property | Type | Description |
|---|---|---|
| $model | Illuminate\Database\Eloquent\Model |
Illuminate\Database\Eloquent\Model
|
| $sessionKey | mixed |
mixed
|
| $pivotData | array |
array
|
Returns
mixed
inherited public addDefinedConstraints () : void
Inherited from
DefinedConstraints
Set the defined constraints on the relation query.
Returns
void
inherited
public
addDefinedConstraintsToQuery (Illuminate\Database\Eloquent\Relations\Relation | Winter\Storm\Database\QueryBuilder $query, array | null $args = null)
Inherited from
DefinedConstraints
Add query based constraints.
Parameters
| Property | Type | Description |
|---|---|---|
| $query | Illuminate\Database\Eloquent\Relations\Relation | Winter\Storm\Database\QueryBuilder |
Illuminate\Database\Eloquent\Relations\Relation | Winter\Storm\Database\QueryBuilder
|
| $args | array | null |
array | null
|
Returns
mixed
inherited
public
addDefinedConstraintsToRelation (Illuminate\Database\Eloquent\Relations\Relation $relation, array | null $args = null)
Inherited from
DefinedConstraints
Add relation based constraints.
Parameters
| Property | Type | Description |
|---|---|---|
| $relation | Illuminate\Database\Eloquent\Relations\Relation |
Illuminate\Database\Eloquent\Relations\Relation
|
| $args | array | null |
array | null
|
Returns
mixed
inherited
public
allRelatedIds (string $sessionKey = null)
: Illuminate\Support\Collection
Inherited from
BelongsOrMorphsToMany
Get all of the IDs for the related models, with deferred binding support
Parameters
| Property | Type | Description |
|---|---|---|
| $sessionKey | string |
string
|
Returns
Illuminate\Support\Collection
inherited
public
attach (mixed $id, array $attributes = [], boolean $touch = true)
Inherited from
BelongsOrMorphsToMany
Override attach() method of BelongToMany relation.
This is necessary in order to fire 'model.relation.beforeAttach', 'model.relation.afterAttach' events
Parameters
| Property | Type | Description |
|---|---|---|
| $id | mixed |
mixed
|
| $attributes | array |
array
|
| $touch | boolean |
boolean
|
Returns
mixed
inherited
public
create (array $attributes = [], array $pivotData = [], $sessionKey = null)
Inherited from
BelongsOrMorphsToMany
Create a new instance of this related model with deferred binding support.
Parameters
| Property | Type | Description |
|---|---|---|
| $attributes | array |
array
|
| $pivotData | array |
array
|
| $sessionKey | mixed |
mixed
|
Returns
mixed
inherited
public
detach (Collection | Model | array | null $ids = null, boolean $touch = true)
: int | void
Inherited from
BelongsOrMorphsToMany
Override detach() method of BelongToMany relation.
This is necessary in order to fire 'model.relation.beforeDetach', 'model.relation.afterDetach' events
Parameters
| Property | Type | Description |
|---|---|---|
| $ids | Collection | Model | array | null |
Collection | Model | array | null
|
| $touch | boolean |
boolean
|
Returns
int | void
inherited public getForeignKey () : string
Inherited from
BelongsOrMorphsToMany
Get the fully qualified foreign key for the relation.
Returns
string
inherited public getOtherKey () : string
Inherited from
BelongsOrMorphsToMany
Get the fully qualified "other key" for the relation.
Returns
string
inherited
public
getRelatedIds ($sessionKey = null)
Inherited from
BelongsOrMorphsToMany
Parameters
| Property | Type | Description |
|---|---|---|
| $sessionKey | mixed |
mixed
|
Returns
mixed
inherited public getSimpleValue ()
Inherited from
BelongsOrMorphsToMany
Helper for getting this relationship simple value, generally useful with form values.
Returns
mixed
inherited
public
newPivot (array $attributes = [], boolean $exists = false)
: Illuminate\Database\Eloquent\Relations\Pivot
Inherited from
BelongsOrMorphsToMany
Create a new pivot model instance.
Parameters
| Property | Type | Description |
|---|---|---|
| $attributes | array |
array
|
| $exists | boolean |
boolean
|
Returns
Illuminate\Database\Eloquent\Relations\Pivot
inherited
public
paginate (integer $perPage = 15, int $currentPage = null, array $columns = ["*"], string $pageName = "page")
: Illuminate\Contracts\Pagination\LengthAwarePaginator
Inherited from
BelongsOrMorphsToMany
Get a paginator for the "select" statement. Complies with Winter Storm.
Parameters
| Property | Type | Description |
|---|---|---|
| $perPage | integer |
integer
|
| $currentPage | int |
int
|
| $columns | array |
array
|
| $pageName | string |
string
|
Returns
Illuminate\Contracts\Pagination\LengthAwarePaginator
inherited
public
remove (Illuminate\Database\Eloquent\Model $model, $sessionKey = null)
Inherited from
BelongsOrMorphsToMany
Removes a model from this relationship type.
Parameters
| Property | Type | Description |
|---|---|---|
| $model | Illuminate\Database\Eloquent\Model |
Illuminate\Database\Eloquent\Model
|
| $sessionKey | mixed |
mixed
|
Returns
mixed
inherited
public
save (Illuminate\Database\Eloquent\Model $model, array $pivotData = [], $sessionKey = null)
Inherited from
BelongsOrMorphsToMany
Save the supplied related model with deferred binding support.
Parameters
| Property | Type | Description |
|---|---|---|
| $model | Illuminate\Database\Eloquent\Model |
Illuminate\Database\Eloquent\Model
|
| $pivotData | array |
array
|
| $sessionKey | mixed |
mixed
|
Returns
mixed
inherited public setSimpleValue ($value)
Inherited from
BelongsOrMorphsToMany
Helper for setting this relationship using various expected values. For example, $model->relation = $value;
Parameters
| Property | Type | Description |
|---|---|---|
| $value | mixed |
mixed
|
Returns
mixed
inherited
public
simplePaginate (int | null $perPage = null, int | null $currentPage = null, array $columns = ["*"], string $pageName = "page")
: Illuminate\Contracts\Pagination\Paginator
Inherited from
BelongsOrMorphsToMany
Paginate the given query into a simple paginator.
Parameters
| Property | Type | Description |
|---|---|---|
| $perPage | int | null |
int | null
|
| $currentPage | int | null |
int | null
|
| $columns | array |
array
|
| $pageName | string |
string
|
Returns
Illuminate\Contracts\Pagination\Paginator
inherited
public
sync (array $ids, boolean $detaching = true)
: array
Inherited from
BelongsOrMorphsToMany
Override sync() method of BelongToMany relation in order to flush the query cache.
Parameters
| Property | Type | Description |
|---|---|---|
| $ids | array |
array
|
| $detaching | boolean |
boolean
|
Returns
array
inherited public withDeferred ($sessionKey) : Illuminate\Database\Eloquent\Builder
Inherited from
DeferOneOrMany
Returns the model query with deferred bindings added
Parameters
| Property | Type | Description |
|---|---|---|
| $sessionKey | mixed |
mixed
|
Returns
Illuminate\Database\Eloquent\Builder
inherited protected getWithDeferredQualifiedKeyName () : Illuminate\Database\Query\Expression
Inherited from
DeferOneOrMany
Returns the related "slave id" key in a database friendly format.
Returns
Illuminate\Database\Query\Expression
inherited
protected
shouldSelect (array $columns = ["*"])
: array | string
Inherited from
BelongsOrMorphsToMany
Get the select columns for the relation query.
Parameters
| Property | Type | Description |
|---|---|---|
| $columns | array |
array
|
Returns
array | string
← Previous page
Winter\Storm\Database\Relations\BelongsTo
Next page →
Winter\Storm\Database\Relations\Concerns\AttachOneOrMany
Copyright © 2025 Winter CMS