Contents

October\Rain\Database\Relations\BelongsTo

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

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

  • $morphMap - An array to map morph names to their class names in the database. (defined in Illuminate\Database\Eloquent\Relations\Relation)

Protected Properties

protected string $relationName

relationName is the "name" of the relationship

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

Inherited Protected Properties

  • $child - The child model instance of the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • $foreignKey - The foreign key of the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • $ownerKey - The associated key on the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • $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)
  • $eagerKeysWereEmpty - Indicates whether the eagerly loaded relation should implicitly return an empty collection. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $constraints - Indicates if the relation is adding constraints. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • $constraintsForNestedRelations - Indicates whether constraints should be enabled for nested relation attributes. (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)
  • $withDefault - Indicates if a default model instance should be used. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)

Public Methods

public __construct()

public __construct($query, $child, $foreignKey, $ownerKey, $relationName): void

__construct a new belongs to 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 associate()

public associate($model): void

associate the model instance to the given parent.

public create()

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

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

public dissociate()

public dissociate(): void

dissociate previously dissociated model from the given parent.

public getOtherKey()

public getOtherKey(): void

public getSimpleValue()

public getSimpleValue(): string|null

getSimpleValue is a 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 setSimpleValue()

public setSimpleValue(mixed $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

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\BelongsTo)
  • addEagerConstraints() - (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • createdAt() - Get the name of the "created at" column. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • disassociate() - Alias of "dissociate" method. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • enforceMorphMap() - Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • 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\Relation)
  • getBaseQuery() - Get the base query builder driving the Eloquent builder. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getChild() - Get the child of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getEager() - Get the relationship for eager loading. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getForeignKeyName() - Get the foreign key of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getMorphAlias() - Get the alias associated with a custom polymorphic class. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getMorphedModel() - Get the model associated with a custom polymorphic type. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getOwnerKeyName() - Get the associated key of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getParent() - Get the parent model of the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getParentKey() - Get the key value of the child's foreign key. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getQualifiedForeignKeyName() - Get the fully-qualified foreign key of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getQualifiedOwnerKeyName() - Get the fully-qualified associated key of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getQualifiedParentKeyName() - Get the fully-qualified parent key name. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • 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)
  • getRelatedClass() - Get the class name of the related model. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • 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() - (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getRelationExistenceQueryForSelfRelation() - Add the constraints for a relationship query on the same table. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getRelationName() - Get the name of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getResults() - (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • hasMacro() - Checks if macro is registered. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • initRelation() - (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • is() - Determine if the model is the related instance of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • isNot() - Determine if the model is not the related instance of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • 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() - (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • 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)
  • noConstraints() - Run a callback with constraints disabled on the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • noConstraintsForRelation() - Run a callback without constraints while preserving them for nested relation attributes. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • 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)
  • sole() - Execute the query and get the first result if it's the sole matching record. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • toBase() - Get a base query builder instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • touch() - Touch all of the related models for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • updatedAt() - Get the name of the "updated at" column. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • withConstraints() - Run a callback with constraints enabled on the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • withConstraintsForNestedRelation() - Run a callback with constraints when resolving a nested relation attribute. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • withDefault() - Return a new model instance in case the relationship does not exist. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)

Protected Methods

protected addPivotSiteScopeConstraints()

protected addPivotSiteScopeConstraints(): void

addPivotSiteScopeConstraints adds site_id constraint to pivot queries if enabled.

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.

Show inherited protected methods

Inherited Protected Methods

  • buildMorphMapFromModels() - Builds a table-keyed array from model class names. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • compareKeys() - Compare the parent key with the related key. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • 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)
  • getDefaultFor() - Get the default value for this relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getDictionaryKey() - Get a dictionary key attribute - casting it to a string if necessary. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getEagerModelKeys() - Gather the keys from an array of related models. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getForeignKeyFrom() - Get the value of the model's foreign key. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getKeys() - Get all of the primary keys for an array of models. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • getRelatedKeyFrom() - Get the value of the model's foreign key. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • getRelationQuery() - Get the query builder that will contain the relationship constraints. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • newRelatedInstanceFor() - Make a new related instance for the given model. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • relationHasIncrementingId() - Determine if the related model has an auto-incrementing ID. (defined in Illuminate\Database\Eloquent\Relations\BelongsTo)
  • throwBadMethodCallException() - Throw a bad method call exception for the given method. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • whereInEager() - Add a whereIn eager constraint for the given set of model keys to be loaded. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • whereInMethod() - Get the name of the "where in" method for eager loading. (defined in Illuminate\Database\Eloquent\Relations\Relation)
  • withoutConstraints() - Run a callback with the configured relation constraints. (defined in Illuminate\Database\Eloquent\Relations\Relation)