| Methods |
public
|
toggle(mixed $ids, bool $touch = true): array
Toggles a model (or models) from the parent.
Toggles a model (or models) from the parent.
Each existing model is detached, and non existing ones are attached.
|
#
|
public
|
syncWithoutDetaching(Collection|Model|array $ids): array{attached: array, detached: array, updated: array}
Sync the intermediate tables with a list of IDs without detaching.
Sync the intermediate tables with a list of IDs without detaching.
|
#
|
public
|
sync(Collection|Model|array $ids, bool $detaching = true): array{attached: array, detached: array, updated: array}
Sync the intermediate tables with a list of IDs or collection of models.
Sync the intermediate tables with a list of IDs or collection of models.
|
#
|
public
|
syncWithPivotValues(
Collection|Model|array $ids,
array $values,
bool $detaching = true,
): array{attached: array, detached: array, updated: array}
Sync the intermediate tables with a list of IDs or collection of models with the given pivot values.
Sync the intermediate tables with a list of IDs or collection of models with the given pivot values.
|
#
|
protected
|
formatRecordsList(array $records): array
Format the sync / toggle record list so that it is keyed by ID.
Format the sync / toggle record list so that it is keyed by ID.
|
#
|
protected
|
attachNew(array $records, array $current, bool $touch = true): array
Attach all of the records that aren't in the given current records.
Attach all of the records that aren't in the given current records.
|
#
|
public
|
updateExistingPivot(mixed $id, array $attributes, bool $touch = true): int
Update an existing pivot record on the table.
Update an existing pivot record on the table.
|
#
|
protected
|
updateExistingPivotUsingCustomClass(mixed $id, array $attributes, bool $touch): int
Update an existing pivot record on the table via a custom class.
Update an existing pivot record on the table via a custom class.
|
#
|
public
|
attach(mixed $ids, array $attributes = [], bool $touch = true): void
Attach a model to the parent.
Attach a model to the parent.
|
#
|
protected
|
attachUsingCustomClass(mixed $ids, array $attributes): void
Attach a model to the parent using a custom class.
Attach a model to the parent using a custom class.
|
#
|
protected
|
formatAttachRecords(array $ids, array $attributes): array
Create an array of records to insert into the pivot table.
Create an array of records to insert into the pivot table.
|
#
|
protected
|
formatAttachRecord(int $key, mixed $value, array $attributes, bool $hasTimestamps): array
Create a full attachment record payload.
Create a full attachment record payload.
|
#
|
protected
|
extractAttachIdAndAttributes(mixed $key, mixed $value, array $attributes): array
Get the attach record ID and extra attributes.
Get the attach record ID and extra attributes.
|
#
|
protected
|
baseAttachRecord(int $id, bool $timed): array
Create a new pivot attachment record.
Create a new pivot attachment record.
|
#
|
protected
|
addTimestampsToAttachment(array $record, bool $exists = false): array
Set the creation and update timestamps on an attach record.
Set the creation and update timestamps on an attach record.
|
#
|
public
|
hasPivotColumn(string $column): bool
Determine whether the given column is defined as a pivot column.
Determine whether the given column is defined as a pivot column.
|
#
|
public
|
detach(mixed $ids = null, bool $touch = true): int
Detach models from the relationship.
Detach models from the relationship.
|
#
|
protected
|
detachUsingCustomClass(mixed $ids): int
Detach models from the relationship using a custom class.
Detach models from the relationship using a custom class.
|
#
|
protected
|
getCurrentlyAttachedPivots(): Collection
Get the pivot models that are currently attached.
Get the pivot models that are currently attached.
|
#
|
public
|
newPivot(array $attributes = [], bool $exists = false): Pivot
Create a new pivot model instance.
Create a new pivot model instance.
|
#
|
public
|
newExistingPivot(array $attributes = []): Pivot
Create a new existing pivot model instance.
Create a new existing pivot model instance.
|
#
|
public
|
newPivotStatement(): Builder
Get a new plain query builder for the pivot table.
Get a new plain query builder for the pivot table.
|
#
|
public
|
newPivotStatementForId(mixed $id): Builder
Get a new pivot statement for a given "other" ID.
Get a new pivot statement for a given "other" ID.
|
#
|
public
|
newPivotQuery(): Builder
Create a new query builder for the pivot table.
Create a new query builder for the pivot table.
|
#
|
public
|
withPivot(array|mixed $columns): $this
Set the columns on the pivot table to retrieve.
Set the columns on the pivot table to retrieve.
|
#
|
protected
|
parseIds(mixed $value): array
Get all of the IDs from the given mixed value.
Get all of the IDs from the given mixed value.
|
#
|
protected
|
parseId(mixed $value): mixed
Get the ID from the given mixed value.
Get the ID from the given mixed value.
|
#
|
protected
|
castKeys(array $keys): array
Cast the given keys to integers if they are numeric and string otherwise.
Cast the given keys to integers if they are numeric and string otherwise.
|
#
|
protected
|
castKey(mixed $key): mixed
Cast the given key to convert to primary key type.
Cast the given key to convert to primary key type.
|
#
|
protected
|
castAttributes(array $attributes): array
Cast the given pivot attributes.
Cast the given pivot attributes.
|
#
|
protected
|
getTypeSwapValue(string $type, mixed $value): mixed
Converts a given value to a given type value.
Converts a given value to a given type value.
|
#
|