Model  

class Model implements ExtenderInterface

Methods

__construct(string $modelClass)

No description

Model
dateAttribute(string $attribute) deprecated

Add an attribute to be treated as a date.

Model
cast(string $attribute, string $cast)

Add a custom attribute type cast. Should not be applied to non-extension attributes.

Model
default(string $attribute, mixed $value)

Add a default value for a given attribute, which can be an explicit value, a closure, or an instance of an invokable class. Unlike with some other extenders, it CANNOT be the `::class` attribute of an invokable class.

Model
belongsTo(string $name, string $related, string $foreignKey = null, string $ownerKey = null)

Establish a simple belongsTo relationship from this model to another model.

Model
belongsToMany(string $name, string $related, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null)

Establish a simple belongsToMany relationship from this model to another model.

Model
hasOne(string $name, string $related, string $foreignKey = null, string $localKey = null)

Establish a simple hasOne relationship from this model to another model.

Model
hasMany(string $name, string $related, string $foreignKey = null, string $localKey = null)

Establish a simple hasMany relationship from this model to another model.

Model
relationship(string $name, callable|string $callback)

Add a relationship from this model to another model.

extend(Container $container, Extension $extension = null)

No description

Details

at line 28
__construct(string $modelClass)

Parameters

string $modelClass

at line 40
Model dateAttribute(string $attribute) deprecated

deprecated use `cast` instead. Will be removed in v2.

Add an attribute to be treated as a date.

Parameters

string $attribute

Return Value

Model

at line 54
Model cast(string $attribute, string $cast)

Add a custom attribute type cast. Should not be applied to non-extension attributes.

Parameters

string $attribute
string $cast

Return Value

Model

at line 70
Model default(string $attribute, mixed $value)

Add a default value for a given attribute, which can be an explicit value, a closure, or an instance of an invokable class. Unlike with some other extenders, it CANNOT be the `::class` attribute of an invokable class.

Parameters

string $attribute
mixed $value

Return Value

Model

at line 90
Model belongsTo(string $name, string $related, string $foreignKey = null, string $ownerKey = null)

Establish a simple belongsTo relationship from this model to another model.

This represents an inverse one-to-one or inverse one-to-many relationship. For more complex relationships, use the ->relationship method.

Parameters

string $name
string $related
string $foreignKey
string $ownerKey

Return Value

Model

at line 113
Model belongsToMany(string $name, string $related, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null)

Establish a simple belongsToMany relationship from this model to another model.

This represents a many-to-many relationship. For more complex relationships, use the ->relationship method.

Parameters

string $name
string $related
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey

Return Value

Model

at line 140
Model hasOne(string $name, string $related, string $foreignKey = null, string $localKey = null)

Establish a simple hasOne relationship from this model to another model.

This represents a one-to-one relationship. For more complex relationships, use the ->relationship method.

Parameters

string $name
string $related
string $foreignKey
string $localKey

Return Value

Model

at line 160
Model hasMany(string $name, string $related, string $foreignKey = null, string $localKey = null)

Establish a simple hasMany relationship from this model to another model.

This represents a one-to-many relationship. For more complex relationships, use the ->relationship method.

Parameters

string $name
string $related
string $foreignKey
string $localKey

Return Value

Model

at line 184
Model relationship(string $name, callable|string $callback)

Add a relationship from this model to another model.

Parameters

string $name
callable|string $callback The callable can be a closure or invokable class, and should accept: - $instance: An instance of this model. The callable should return: - $relationship: A Laravel Relationship object. See relevant methods of models like \Flarum\User\User for examples of how relationships should be returned.

Return Value

Model

at line 191
extend(Container $container, Extension $extension = null)

Parameters

Container $container
Extension $extension