October\Rain\Database\Relations\MorphOne

Extends

• Illuminate\Database\Eloquent\Relations\MorphOne
• Illuminate\Database\Eloquent\Relations\MorphOneOrMany
• Illuminate\Database\Eloquent\Relations\HasOneOrMany
• Illuminate\Database\Eloquent\Relations\Relation

Implements

• Illuminate\Contracts\Database\Eloquent\SupportsPartialRelations
• Illuminate\Contracts\Database\Query\Builder
• Illuminate\Contracts\Database\Eloquent\Builder

---

Public Properties

There are no public properties in the class.

Show inherited public properties

Protected Properties

protected bool $pivotSiteScope

pivotSiteScope indicates if pivot queries should be scoped by site_id. This is used for dual-multisite scenarios where both parent and related models use multisite.

Show inherited protected properties

---

Public Methods

public __construct()

public __construct(
    $query,
    $parent,
    $type,
    $id,
    $localKey,
    $relationName = null
): void

__construct a new has many relationship instance.

public add()

public add($model, $sessionKey = null): 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 create()

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

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

public createMany()

public createMany($records, $sessionKey = null): void

createMany creates multiple related models with deferred binding support.

public createManyQuietly()

public createManyQuietly($records, $sessionKey = null): void

createManyQuietly creates multiple models without raising any events, with deferred binding support.

public createOrFirst()

public createOrFirst($attributes = [], $values = [], $sessionKey = null): void

createOrFirst attempts to create the record, or if a unique constraint violation occurs, finds the existing record.

public createQuietly()

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

createQuietly creates a new instance without raising any events, with deferred binding support.

public forceCreateQuietly()

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

forceCreateQuietly creates a new instance bypassing mass assignment without raising any events, with deferred binding support.

public getRelatedKeyName()

public getRelatedKeyName(): string 

public getSimpleValue()

public getSimpleValue(): void

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

public isPivotSiteScoped()

public isPivotSiteScoped(): bool 

isPivotSiteScoped returns true if pivot queries should be scoped by site_id.

public remove()

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

remove a model from this relationship type.

public save()

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

save the supplied related model with deferred binding support.

public saveMany()

public saveMany($models, $sessionKey = null): void

saveMany saves multiple models with deferred binding support.

public saveManyQuietly()

public saveManyQuietly($models, $sessionKey = null): void

saveManyQuietly saves multiple models without raising any events, with deferred binding support.

public saveQuietly()

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

saveQuietly saves the supplied related model without raising any events, 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 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

Protected Methods

protected addPivotSiteScopeConstraints()

protected addPivotSiteScopeConstraints(): void 

addPivotSiteScopeConstraints adds site_id constraint to pivot queries if enabled.

protected ensureRelationIsEmpty()

protected ensureRelationIsEmpty(): void

ensureRelationIsEmpty ensures the relation is empty, either deleted or nulled.

protected getPivotSiteScopeValue()

protected getPivotSiteScopeValue(): int|null 

getPivotSiteScopeValue returns the current site_id value for pivot records. Returns null if pivotSiteScope is disabled, otherwise returns the site ID.

protected getRelationDefinitionForDefinedConstraints()

protected getRelationDefinitionForDefinedConstraints(): void

getRelationDefinitionForDefinedConstraints returns the relation definition for the relationship context.

protected getWithDeferredQualifiedKeyName()

protected getWithDeferredQualifiedKeyName(

): Illuminate\Database\Query\Expression 

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

protected isModelRemovable()

protected isModelRemovable($model): bool 

isModelRemovable returns true if an existing model is already associated

Show inherited protected methods