1. Documentation
  2. API
  3. Library
  4. Database
  5. Relations
  6. BelongsToMany

October\Rain\Database\Relations\BelongsToMany

Extends
  • Illuminate\Database\Eloquent\Relations\BelongsToMany
  • Illuminate\Database\Eloquent\Relations\Relation
Implements
  • Illuminate\Contracts\Database\Eloquent\Builder
  • Illuminate\Contracts\Database\Query\Builder

Public Properties

public bool $countMode

countMode sets this relation object is a 'count' helper

Show inherited public properties

Inherited Public Properties

  • $withTimestamps - Indicates if timestamps are available on the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $morphMap - An array to map class names to their morph names in the database. (defined in Illuminate\Database\Eloquent\Relations\Relation)

Protected Properties

There are no protected properties in the class.

Show inherited protected properties

Inherited Protected Properties

  • $table - The intermediate table for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $foreignPivotKey - The foreign key of the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $relatedPivotKey - The associated key of the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $parentKey - The key name of the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $relatedKey - The key name of the related model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $relationName - The "name" of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $pivotColumns - The pivot table columns to retrieve. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $pivotWheres - Any pivot table restrictions for where clauses. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $pivotWhereIns - Any pivot table restrictions for whereIn clauses. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $pivotWhereNulls - Any pivot table restrictions for whereNull clauses. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $pivotValues - The default values for the pivot columns. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $pivotCreatedAt - The custom pivot table column for the created_at timestamp. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $pivotUpdatedAt - The custom pivot table column for the updated_at timestamp. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $using - The class name of the custom pivot model to use for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $accessor - The name of the accessor to use for the "pivot" relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • $query - The Eloquent query builder instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $parent - The parent model instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $related - The related model instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $constraints - Indicates if the relation is adding constraints. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $requireMorphMap - Prevents morph relationships without a morph map. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $selfJoinCount - The count of self joins. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $macros - The registered string macros. (defined in Illuminate\Database\Eloquent\Relations\Relation)

Public Methods

public __construct()

public __construct(
    string $table,
    string $foreignPivotKey,
    string $relatedPivotKey,
    string $relationName,
    $relatedPivotKey,
    $parentKey,
    $relatedKey,
    $relationName = null
): void

__construct a new belongs to many relationship instance.

public add()

public add($model, $sessionKey = null, $pivotData = []): void

add a model to this relationship type.

public addDefinedConstraints()

public addDefinedConstraints(): void

addDefinedConstraints to the relation query

public addDefinedConstraintsToQuery()

public addDefinedConstraintsToQuery($query, $args = null): void

public addDefinedConstraintsToRelation()

public addDefinedConstraintsToRelation($relation, $args = null): void

public allRelatedIds()

public allRelatedIds(
    string $sessionKey = null
): October\Rain\Support\Collection

allRelatedIds for the related models, with deferred binding support

public attach()

public attach(
    mixed $ids,
    array $attributes = [],
    bool $touch = true
): void

attach overrides attach() method of BelongToMany relation This is necessary in order to fire 'model.relation.beforeAttach', 'model.relation.attach' events

public create()

public create($attributes = [], $pivotData = [], $sessionKey = null): void

create a new instance of this related model with deferred binding support.

public detach()

public detach(mixed $ids = null, bool $touch = true): int|void

detach overrides detach() method of BelongToMany relation. This is necessary in order to fire 'model.relation.beforeDetach', 'model.relation.detach' events

public getForeignKey()

public getForeignKey(): void

public getOtherKey()

public getOtherKey(): void

public getSimpleValue()

public getSimpleValue(): void

getSimpleValue is a helper for getting this relationship simple value, generally useful with form values

public newPivot()

public newPivot(
    array $attributes = [],
    bool $exists = false
): Illuminate\Database\Eloquent\Relations\Pivot

newPivot creates a new pivot model instance

public paginate()

public paginate(
    int $perPage = null,
    int $currentPage = [ 0 => '*'],
    array $columns = 'page',
    string $pageName = null
): Illuminate\Contracts\Pagination\LengthAwarePaginator

paginate gets a paginator for the "select" statement that complies with October Rain

public paginateAtPage()

public paginateAtPage(
    int $perPage,
    int $currentPage
): Illuminate\Contracts\Pagination\LengthAwarePaginator

paginateAtPage paginates by passing the page number directly

public paginateCustom()

public paginateCustom(
    int $perPage,
    string $pageName
): Illuminate\Contracts\Pagination\LengthAwarePaginator

paginateCustom paginates using a custom page name.

public remove()

public remove($model, $sessionKey = null): void

remove a model from this relationship type.

public save()

public save($model, $pivotData = [], $sessionKey = null): void

save the supplied related model with deferred binding support.

public setSimpleValue()

public setSimpleValue($value): void

setSimpleValue helper for setting this relationship using various expected values. For example, $model->relation = $value;

public simplePaginate()

public simplePaginate(
    int|null $perPage = null,
    array $columns = [ 0 => '*'],
    string $pageName = 'page',
    int|null $page = null
): Illuminate\Contracts\Pagination\Paginator

simplePaginate using a simple paginator.

public simplePaginateAtPage()

public simplePaginateAtPage(
    int $perPage,
    int $currentPage
): Illuminate\Contracts\Pagination\Paginator

simplePaginateAtPage simply paginates by passing the page number directly

public simplePaginateCustom()

public simplePaginateCustom(
    int $perPage,
    string $pageName
): Illuminate\Contracts\Pagination\Paginator

simplePaginateCustom simply paginates using a custom page name.

public withDeferred()

public withDeferred(
    string|null $sessionKey = null
): Illuminate\Database\Query\Builder

withDeferred returns a new model query with deferred bindings added, this will reset any constraints that come before it

public withDeferredQuery()

public withDeferredQuery(
    Illuminate\Database\Query\Builder|null $newQuery = null,
    string|null $sessionKey = null
): Illuminate\Database\Query\Builder

withDeferredQuery returns the supplied model query, or current model query, with deferred bindings added, this will preserve any constraints that came before it

Show inherited public methods

Inherited Public Methods

  • __call() - Handle dynamic method calls to the relationship. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • __callStatic() - Dynamically handle calls to the class. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • __clone() - Force a clone of the underlying query builder when cloning. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • addConstraints() - Set the base constraints on the relation query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • addEagerConstraints() - Set the constraints for an eager load of the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • as() - Specify the custom pivot accessor to use for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • chunk() - Chunk the results of the query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • chunkById() - Chunk the results of a query by comparing numeric IDs. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • createMany() - Create an array of new instances of the related models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • createdAt() - Get the name of the "created at" column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • cursor() - Get a lazy collection for the given query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • cursorPaginate() - Paginate the given query into a cursor paginator. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • each() - Execute a callback over each item while chunking. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • enforceMorphMap() - Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • find() - Find a related model by its primary key. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • findMany() - Find multiple related models by their primary keys. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • findOr() - Find a related model by its primary key or call a callback. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • findOrFail() - Find a related model by its primary key or throw an exception. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • findOrNew() - Find a related model by its primary key or return a new instance of the related model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • first() - Execute the query and get the first result. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • firstOr() - Execute the query and get the first result or call a callback. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • firstOrCreate() - Get the first related record matching the attributes or create it. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • firstOrFail() - Execute the query and get the first result or throw an exception. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • firstOrNew() - Get the first related model record matching the attributes or instantiate it. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • firstWhere() - Add a basic where clause to the query, and return the first result. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • flushMacros() - Flush the existing macros. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • get() - Execute the query as a "select" statement. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getBaseQuery() - Get the base query builder driving the Eloquent builder. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getEager() - Get the relationship for eager loading. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getExistenceCompareKey() - Get the key for comparing against the parent key in "has" query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getForeignPivotKeyName() - Get the foreign key for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getMorphedModel() - Get the model associated with a custom polymorphic type. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getParent() - Get the parent model of the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getParentKeyName() - Get the parent key for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getPivotAccessor() - Get the name of the pivot accessor for this relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getPivotClass() - Get the class being used for pivot models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getPivotColumns() - Get the pivot columns for this relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getQualifiedForeignPivotKeyName() - Get the fully qualified foreign key for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getQualifiedParentKeyName() - Get the fully qualified parent key name for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getQualifiedRelatedKeyName() - Get the fully qualified related key name for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getQualifiedRelatedPivotKeyName() - Get the fully qualified "related key" for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getQuery() - Get the underlying query for the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getRelated() - Get the related model of the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getRelatedKeyName() - Get the related key for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getRelatedPivotKeyName() - Get the "related key" for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getRelationCountHash() - Get a relationship join table hash. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getRelationExistenceCountQuery() - Add the constraints for a relationship count query. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getRelationExistenceQuery() - Add the constraints for a relationship query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getRelationExistenceQueryForSelfJoin() - Add the constraints for a relationship query on the same table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getRelationName() - Get the relationship name for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getResults() - Get the results of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getTable() - Get the intermediate table for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • hasMacro() - Checks if macro is registered. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • hasPivotColumn() - Determine whether the given column is defined as a pivot column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • initRelation() - Initialize the relation on a set of models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • lazy() - Query lazily, by chunks of the given size. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • lazyById() - Query lazily, by chunking the results of a query by comparing IDs. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • macro() - Register a custom macro. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • macroCall() - Dynamically handle calls to the class. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • match() - Match the eagerly loaded results to their parents. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • mixin() - Mix another object into the class. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • morphMap() - Set or get the morph map for polymorphic relations. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • newExistingPivot() - Create a new existing pivot model instance. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • newPivotQuery() - Create a new query builder for the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • newPivotStatement() - Get a new plain query builder for the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • newPivotStatementForId() - Get a new pivot statement for a given "other" ID. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • noConstraints() - Run a callback with constraints disabled on the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • orWherePivot() - Set an "or where" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • orWherePivotBetween() - Set a "or where between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • orWherePivotIn() - Set an "or where in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • orWherePivotNotBetween() - Set a "or where not between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • orWherePivotNotIn() - Set an "or where not in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • orWherePivotNotNull() - Set a "or where not null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • orWherePivotNull() - Set a "or where null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • orderByPivot() - Add an "order by" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • qualifyPivotColumn() - Qualify the given column name by the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • rawUpdate() - Run a raw update against the base query. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • relatedUpdatedAt() - Get the name of the related model's "updated at" column. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • requireMorphMap() - Prevent polymorphic relationships from being used without model mappings. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • requiresMorphMap() - Determine if polymorphic relationships require explicit model mapping. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • saveMany() - Save an array of new models and attach them to the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • saveManyQuietly() - Save an array of new models without raising any events and attach them to the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • saveQuietly() - Save a new model without raising any events and attach it to the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • sole() - Execute the query and get the first result if it's the sole matching record. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • sync() - Sync the intermediate tables with a list of IDs or collection of models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • syncWithPivotValues() - Sync the intermediate tables with a list of IDs or collection of models with the given pivot values. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • syncWithoutDetaching() - Sync the intermediate tables with a list of IDs without detaching. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • toBase() - Get a base query builder instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • toggle() - Toggles a model (or models) from the parent. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • touch() - Touch all of the related models for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • touchIfTouching() - If we're touching the parent model, touch. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • updateExistingPivot() - Update an existing pivot record on the table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • updateOrCreate() - Create or update a related record matching the attributes, and fill it with values. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • updatedAt() - Get the name of the "updated at" column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • using() - Specify the custom pivot model to use for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • wherePivot() - Set a where clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • wherePivotBetween() - Set a "where between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • wherePivotIn() - Set a "where in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • wherePivotNotBetween() - Set a "where pivot not between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • wherePivotNotIn() - Set a "where not in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • wherePivotNotNull() - Set a "where not null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • wherePivotNull() - Set a "where null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • withPivot() - Set the columns on the pivot table to retrieve. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • withPivotValue() - Set a where clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • withTimestamps() - Specify that the pivot table has creation and update timestamps. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)

Protected Methods

protected getWithDeferredQualifiedKeyName()

protected getWithDeferredQualifiedKeyName(

): Illuminate\Database\Query\Expression

getWithDeferredQualifiedKeyName returns the related "slave id" key in a database friendly format.

protected newSimpleRelationQuery()

protected newSimpleRelationQuery($ids): void

newSimpleRelationQuery for the related instance based on an array of IDs.

protected performDeferredLeftJoin()

protected performDeferredLeftJoin($query = null, $sessionKey = null): void

performDeferredLeftJoin left joins the deferred bindings table

protected performLeftJoin()

protected performLeftJoin(
    Illuminate\Database\Eloquent\Builder|null $query = null
): $this

performJoin will join the pivot table opportunistically instead of mandatorily to support deferred bindings that exist in another table.

This method is based on performJoin method logic except it uses a left join.

protected performSortableColumnJoin()

protected performSortableColumnJoin($query = null, $sessionKey = null): void

performSortableColumnJoin includes custom logic to replace the sort order column with a unified column

protected shouldSelect()

protected shouldSelect(
    $columns = [ 0 => '*']
): Illuminate\Database\Eloquent\Relations\BelongsToMany

shouldSelect gets the select columns for the relation query

Show inherited protected methods

Inherited Protected Methods

  • addTimestampsToAttachment() - Set the creation and update timestamps on an attach record. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • addWhereConstraints() - Set the where clause for the relation query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • aliasedPivotColumns() - Get the pivot columns for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • attachNew() - Attach all of the records that aren't in the given current records. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • attachUsingCustomClass() - Attach a model to the parent using a custom class. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • baseAttachRecord() - Create a new pivot attachment record. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • buildDictionary() - Build model dictionary keyed by the relation's foreign key. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • buildMorphMapFromModels() - Builds a table-keyed array from model class names. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • castAttributes() - Cast the given pivot attributes. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • castKey() - Cast the given key to convert to primary key type. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • castKeys() - Cast the given keys to integers if they are numeric and string otherwise. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • detachUsingCustomClass() - Detach models from the relationship using a custom class. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • extractAttachIdAndAttributes() - Get the attach record ID and extra attributes. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • formatAttachRecord() - Create a full attachment record payload. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • formatAttachRecords() - Create an array of records to insert into the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • formatRecordsList() - Format the sync / toggle record list so that it is keyed by ID. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • forwardCallTo() - Forward a method call to the given object. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • forwardDecoratedCallTo() - Forward a method call to the given object, returning $this if the forwarded call returned itself. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getCurrentlyAttachedPivots() - Get the pivot models that are currently attached. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getDictionaryKey() - Get a dictionary key attribute - casting it to a string if necessary. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • getKeys() - Get all of the primary keys for an array of models. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getRelationQuery() - Get the query builder that will contain the relationship constraints. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getTypeSwapValue() - Converts a given value to a given type value. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • guessInverseRelation() - Attempt to guess the name of the inverse of the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • hydratePivotRelation() - Hydrate the pivot table relationship on the models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • migratePivotAttributes() - Get the pivot attributes from a model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • parseId() - Get the ID from the given mixed value. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • parseIds() - Get all of the IDs from the given mixed value. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • performJoin() - Set the join clause for the relation query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • prepareQueryBuilder() - Prepare the query builder for query execution. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • resolveTableName() - Attempt to resolve the intermediate table name from the given string. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • throwBadMethodCallException() - Throw a bad method call exception for the given method. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • touchingParent() - Determine if we should touch the parent on sync. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • updateExistingPivotUsingCustomClass() - Update an existing pivot record on the table via a custom class. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
  • whereInMethod() - Get the name of the "where in" method for eager loading. (defined in Illuminate\Database\Eloquent\Relations\Relation)