AsPivot

trait AsPivot (View source)

Properties

Model $pivotParent The parent model of the relationship.
protected string $foreignKey The name of the foreign key column.
protected string $relatedKey The name of the "other key" column.

Methods

static AsPivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model instance.
static AsPivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model from raw values returned from a query.
Builder setKeysForSaveQuery(Builder $query)

Set the keys for a save update query.
int delete()

Delete the pivot model record from the database.
Builder getDeleteQuery()

Get the query builder for a delete operation on the pivot.
string getTable()

Get the table associated with the model.
string getForeignKey()

Get the foreign key column name.
string getRelatedKey()

Get the "related key" column name.
string getOtherKey()

Get the "related key" column name.
$this setPivotKeys(string $foreignKey, string $relatedKey)

Set the key names for the pivot model instance.
bool hasTimestampAttributes()

Determine if the pivot model has timestamp attributes.
string getCreatedAtColumn()

Get the name of the "created at" column.
string getUpdatedAtColumn()

Get the name of the "updated at" column.
mixed getQueueableId()

Get the queueable identity for the entity.
Builder newQueryForRestoration(array|int $ids)

Get a new query to restore one or more models by their queueable IDs.
Builder newQueryForCollectionRestoration(array $ids)

Get a new query to restore multiple models by their queueable IDs.

Details

static AsPivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model instance.

Parameters

Model $parent
array $attributes
string $table
bool $exists

Return Value

AsPivot

static AsPivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model from raw values returned from a query.

Parameters

Model $parent
array $attributes
string $table
bool $exists

Return Value

AsPivot

protected Builder setKeysForSaveQuery(Builder $query)

Set the keys for a save update query.

Parameters

Builder $query

Return Value

Builder

int delete()

Delete the pivot model record from the database.

Return Value

int

protected Builder getDeleteQuery()

Get the query builder for a delete operation on the pivot.

Return Value

Builder

string getTable()

Get the table associated with the model.

Return Value

string

string getForeignKey()

Get the foreign key column name.

Return Value

string

string getRelatedKey()

Get the "related key" column name.

Return Value

string

string getOtherKey()

Get the "related key" column name.

Return Value

string

$this setPivotKeys(string $foreignKey, string $relatedKey)

Set the key names for the pivot model instance.

Parameters

string $foreignKey
string $relatedKey

Return Value

$this

bool hasTimestampAttributes()

Determine if the pivot model has timestamp attributes.

Return Value

bool

string getCreatedAtColumn()

Get the name of the "created at" column.

Return Value

string

string getUpdatedAtColumn()

Get the name of the "updated at" column.

Return Value

string

mixed getQueueableId()

Get the queueable identity for the entity.

Return Value

mixed

Builder newQueryForRestoration(array|int $ids)

Get a new query to restore one or more models by their queueable IDs.

Parameters

array|int $ids

Return Value

Builder

protected Builder newQueryForCollectionRestoration(array $ids)

Get a new query to restore multiple models by their queueable IDs.

Parameters

array $ids

Return Value

Builder

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Database/Eloquent/Relations/Concerns/AsPivot.html