DatabaseNotification (Notifications)

newInstance(array $attributes = array(), bool $exists = false)

Create a new instance of the given model.

from Model

newFromBuilder(array $attributes = array(), string|null $connection = null)

Create a new model instance that is existing.

from Model

static Collection

hydrate(array $items, string|null $connection = null)

Create a collection of models from plain arrays.

from Model

static Collection

hydrateRaw(string $query, array $bindings = array(), string|null $connection = null)

Create a collection of models from a raw query.

from Model

static Model

create(array $attributes = array())

Save a new model and return the instance.

from Model

static Model

forceCreate(array $attributes)

Save a new model and return the instance. Allow mass-assignment.

from Model

static Builder

query()

Begin querying the model.

from Model

static Builder

on(string|null $connection = null)

Begin querying the model on a given connection.

from Model

static Builder

onWriteConnection()

Begin querying the model on the write connection.

from Model

static Collection|Model[]

all(array|mixed $columns = array('*'))

Get all of the models from the database.

from Model

Model|null

fresh(array|string $with = array())

Reload a fresh model instance from the database.

from Model

$this

load(array|string $relations)

Eager load relations on the model.

from Model

static Builder|Model

with(array|string $relations)

Begin querying a model with eager loading.

from Model

$this

append(array|string $attributes)

Append attributes to query when building a query.

from Model

HasOne

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

Define a one-to-one relationship.

from Model

MorphOne

morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-one relationship.

from Model

BelongsTo

belongsTo(string $related, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define an inverse one-to-one or many relationship.

from Model

MorphTo

morphTo(string $name = null, string $type = null, string $id = null)

Define a polymorphic, inverse one-to-one or many relationship.

from Model

string

getActualClassNameForMorph(string $class)

Retrieve the fully qualified class name from a slug.

from Model

HasMany

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

Define a one-to-many relationship.

from Model

HasManyThrough

hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null)

Define a has-many-through relationship.

from Model

MorphMany

morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-many relationship.

from Model

BelongsToMany

belongsToMany(string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define a many-to-many relationship.

from Model

morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false)

Define a polymorphic many-to-many relationship.

from Model

morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null)

Define a polymorphic, inverse many-to-many relationship.

from Model

string

joiningTable(string $related)

Get the joining table name for a many-to-many relation.

from Model

static int

destroy(array|int $ids)

Destroy the models for the given IDs.

from Model

bool|null

delete()

Delete the model from the database.

from Model

bool|null

forceDelete()

Force a hard delete on a soft deleted model.

from Model

static void

saving(Closure|string $callback, int $priority)

from Model

static void

saved(Closure|string $callback, int $priority)

from Model

static void

updating(Closure|string $callback, int $priority)

from Model

static void

updated(Closure|string $callback, int $priority)

from Model

static void

creating(Closure|string $callback, int $priority)

from Model

static void

created(Closure|string $callback, int $priority)

from Model

static void

deleting(Closure|string $callback, int $priority)

from Model

static void

deleted(Closure|string $callback, int $priority)

from Model

static void

flushEventListeners()

Remove all of the event listeners for the model.

from Model

array

getObservableEvents()

Get the observable event names.

from Model

$this

setObservableEvents(array $observables)

Set the observable event names.

from Model

void

addObservableEvents(array|mixed $observables)

Add an observable event name.

from Model

void

removeObservableEvents(array|mixed $observables)

Remove an observable event name.

from Model

bool

update(array $attributes = array(), array $options = array())

Update the model in the database.

from Model

bool

push()

Save the model and all of its relationships.

from Model

bool

save(array $options = array())

Save the model to the database.

from Model

bool

saveOrFail(array $options = array())

Save the model to the database using transaction.

from Model

void

touchOwners()

Touch the owning relations of the model.

from Model

bool

touches(string $relation)

Determine if the model touches a given relation.

from Model

bool

touch()

Update the model's update timestamp.

from Model

$this

setCreatedAt(mixed $value)

Set the value of the "created at" attribute.

from Model

$this

setUpdatedAt(mixed $value)

Set the value of the "updated at" attribute.

from Model

string

getCreatedAtColumn()

Get the name of the "created at" column.

from Model

string

getUpdatedAtColumn()

Get the name of the "updated at" column.

from Model

Carbon

freshTimestamp()

Get a fresh timestamp for the model.

from Model

string

freshTimestampString()

Get a fresh timestamp for the model.

from Model

newQuery()

Get a new query builder for the model's table.

from Model

newQueryWithoutScope(Scope|string $scope)

Get a new query instance without a given scope.

from Model

newQueryWithoutScopes()

Get a new query builder that doesn't have any global scopes.

from Model

newEloquentBuilder(Builder $query)

Create a new Eloquent query builder for the model.

from Model

newCollection(array $models = array())

Create a new database notification collection instance.

Pivot

newPivot(Model $parent, array $attributes, string $table, bool $exists)

Create a new pivot model instance.

from Model

string

getTable()

Get the table associated with the model.

from Model

$this

setTable(string $table)

Set the table associated with the model.

from Model

mixed

getKey()

Get the value of the model's primary key.

from Model

mixed

getQueueableId()

Get the queueable identity for the entity.

from Model

string

getKeyName()

Get the primary key for the model.

from Model

$this

setKeyName(string $key)

Set the primary key for the model.

from Model

string

getQualifiedKeyName()

Get the table qualified key name.

from Model

string

getKeyType()

Get the auto incrementing key type.

from Model

mixed

getRouteKey()

Get the value of the model's route key.

from Model

string

getRouteKeyName()

Get the route key for the model.

from Model

bool

usesTimestamps()

Determine if the model uses timestamps.

from Model

string

getMorphClass()

Get the class name for polymorphic relations.

from Model

int

getPerPage()

Get the number of models to return per page.

from Model

$this

setPerPage(int $perPage)

Set the number of models to return per page.

from Model

string

getForeignKey()

Get the default foreign key name for the model.

from Model

array

getHidden()

Get the hidden attributes for the model.

from Model

$this

setHidden(array $hidden)

Set the hidden attributes for the model.

from Model

void

addHidden(array|string|null $attributes = null)

Add hidden attributes for the model.

from Model

$this

makeVisible(array|string $attributes)

Make the given, typically hidden, attributes visible.

from Model

$this

makeHidden(array|string $attributes)

Make the given, typically visible, attributes hidden.

from Model

array

getVisible()

Get the visible attributes for the model.

from Model

$this

setVisible(array $visible)

Set the visible attributes for the model.

from Model

void

addVisible(array|string|null $attributes = null)

Add visible attributes for the model.

from Model

$this

setAppends(array $appends)

Set the accessors to append to model arrays.

from Model

array

getFillable()

Get the fillable attributes for the model.

from Model

$this

fillable(array $fillable)

Set the fillable attributes for the model.

from Model

array

getGuarded()

Get the guarded attributes for the model.

from Model

$this

guard(array $guarded)

Set the guarded attributes for the model.

from Model

static void

unguard(bool $state = true)

Disable all mass assignable restrictions.

from Model

static void

reguard()

Enable the mass assignment restrictions.

from Model

static bool

isUnguarded()

Determine if current state is "unguarded".

from Model

static mixed

unguarded(callable $callback)

Run the given callable while being unguarded.

from Model

bool

isFillable(string $key)

Determine if the given attribute may be mass assigned.

from Model

bool

isGuarded(string $key)

Determine if the given key is guarded.

from Model

bool

totallyGuarded()

Determine if the model is totally guarded.

from Model

array

getTouchedRelations()

Get the relationships that are touched on save.

from Model

$this

setTouchedRelations(array $touches)

Set the relationships that are touched on save.

from Model

bool

getIncrementing()

Get the value indicating whether the IDs are incrementing.

from Model

$this

setIncrementing(bool $value)

Set whether IDs are incrementing.

from Model

string

toJson(int $options)

Convert the model instance to JSON.

from Model

array

jsonSerialize()

Convert the object into something JSON serializable.

from Model

array

toArray()

Convert the model instance to an array.

from Model

array

attributesToArray()

Convert the model's attributes to an array.

from Model

array

relationsToArray()

Get the model's relationships in array form.

from Model

mixed

getAttribute(string $key)

Get an attribute from the model.

from Model

mixed

getAttributeValue(string $key)

Get a plain attribute (not a relationship).

from Model

mixed

getRelationValue(string $key)

Get a relationship.

from Model

bool

hasGetMutator(string $key)

Determine if a get mutator exists for an attribute.

from Model

bool

hasCast(string $key, array|string|null $types = null)

Determine whether an attribute should be cast to a native type.

from Model

array

getCasts()

Get the casts array.

from Model

$this

setAttribute(string $key, mixed $value)

Set a given attribute on the model.

from Model

$this

fillJsonAttribute(string $key, mixed $value)

Set a given JSON attribute on the model.

from Model

bool

hasSetMutator(string $key)

Determine if a set mutator exists for an attribute.

from Model

array

getDates()

Get the attributes that should be converted to dates.

from Model

string

fromDateTime(DateTime|int $value)

Convert a DateTime to a storable string.

from Model

$this

setDateFormat(string $format)

Set the date format used by the model.

from Model

mixed

fromJson(string $value, bool $asObject = false)

Decode the given JSON back into an array or object.

from Model

replicate(array $except = null)

Clone the model into a new, non-existing instance.

from Model

bool

is(Model $model)

Determine if two models have the same ID and belong to the same table.

from Model

array

getAttributes()

Get all of the current attributes on the model.

from Model

$this

setRawAttributes(array $attributes, bool $sync = false)

Set the array of model attributes. No checking is done.

from Model

mixed|array

getOriginal(string|null $key = null, mixed $default = null)

Get the model's original attribute values.

from Model

$this

syncOriginal()

Sync the original attributes with the current.

from Model

$this

syncOriginalAttribute(string $attribute)

Sync a single original attribute with its current value.

from Model

bool

isDirty(array|string|null $attributes = null)

Determine if the model or given attribute(s) have been modified.

from Model

bool

isClean(array|string|null $attributes = null)

Determine if the model or given attribute(s) have remained the same.

from Model

array

getDirty()

Get the attributes that have been changed since last sync.

from Model

array

getRelations()

Get all the loaded relations for the instance.

from Model

mixed

getRelation(string $relation)

Get a specified relationship.

from Model

bool

relationLoaded(string $key)

Determine if the given relation is loaded.

from Model

$this

setRelation(string $relation, mixed $value)

Set the specific relationship in the model.

from Model

$this

setRelations(array $relations)

Set the entire relations array on the model.

from Model

Connection

getConnection()

Get the database connection for the model.

from Model

string

getConnectionName()

Get the current connection name for the model.

from Model

$this

setConnection(string $name)

Set the connection associated with the model.

from Model

static Connection

resolveConnection(string|null $connection = null)

Resolve a connection instance.

from Model

static ConnectionResolverInterface

getConnectionResolver()

Get the connection resolver instance.

from Model

static void

setConnectionResolver(ConnectionResolverInterface $resolver)

Set the connection resolver instance.

from Model

static void

unsetConnectionResolver()

Unset the connection resolver for models.

from Model

static Dispatcher

getEventDispatcher()

Get the event dispatcher instance.

from Model

static void

setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance.

from Model

static void

unsetEventDispatcher()

Unset the event dispatcher for models.

from Model

array

getMutatedAttributes()

Get the mutated attributes for a given instance.

from Model

static void

cacheMutatedAttributes(string $class)

Extract and cache all the mutated attributes of a class.

from Model

mixed

__get(string $key)

Dynamically retrieve attributes on the model.

from Model

void

__set(string $key, mixed $value)

Dynamically set attributes on the model.

from Model

bool

offsetExists(mixed $offset)

Determine if the given attribute exists.

from Model

mixed

offsetGet(mixed $offset)

Get the value for a given offset.

from Model

void

offsetSet(mixed $offset, mixed $value)

Set the value for a given offset.

from Model

void

offsetUnset(mixed $offset)

Unset the value for a given offset.

from Model

bool

__isset(string $key)

Determine if an attribute or relation exists on the model.

from Model

void

__unset(string $key)

Unset an attribute on the model.

from Model

mixed

__call(string $method, array $parameters)

Handle dynamic method calls into the model.

from Model

static mixed

__callStatic(string $method, array $parameters)

Handle dynamic static method calls into the method.

from Model

string

__toString()

Convert the model to its string representation.

from Model

void

__wakeup()

When a model is being unserialized, check if it needs to be booted.

from Model

notifiable()

Get the notifiable entity that the notification belongs to.

void

markAsRead()

Mark the notification as read.

bool

read()

Determine if a notification has been read.

bool

unread()

Determine if a notification has not been read.

Details

void __construct(array $attributes = array())

Create a new Eloquent model instance.

Parameters

array

$attributes

Return Value

void

static void clearBootedModels()

Clear the list of booted models so they will be re-booted.

Return Value

void

static mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)

Parameters

Scope\|Closure\|string	$scope
Closure	$implementation

Return Value

mixed

Exceptions

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

Determine if a model has a global scope.

Parameters

Scope|string

$scope

Return Value

bool

static Scope|Closure|null getGlobalScope(Scope|string $scope)

Get a global scope registered with the model.

Parameters

Scope|string

$scope

Return Value

Scope|Closure|null

array getGlobalScopes()

Get the global scopes for this class instance.

Return Value

array

static void observe(object|string $class, int $priority)

Parameters

object\|string	$class
int	$priority

Return Value

void

$this fill(array $attributes)

Fill the model with an array of attributes.

Parameters

array

$attributes

Return Value

$this

Exceptions

MassAssignmentException

$this forceFill(array $attributes)

Fill the model with an array of attributes. Force mass assignment.

Parameters

array

$attributes

Return Value

$this

Model newInstance(array $attributes = array(), bool $exists = false)

Create a new instance of the given model.

Parameters

array	$attributes
bool	$exists

Return Value

Model newFromBuilder(array $attributes = array(), string|null $connection = null)

Create a new model instance that is existing.

Parameters

array	$attributes
string\|null	$connection

Return Value

static Collection hydrate(array $items, string|null $connection = null)

Create a collection of models from plain arrays.

Parameters

array	$items
string\|null	$connection

Return Value

static Collection hydrateRaw(string $query, array $bindings = array(), string|null $connection = null)

Create a collection of models from a raw query.

Parameters

string	$query
array	$bindings
string\|null	$connection

Return Value

static Model create(array $attributes = array())

Save a new model and return the instance.

Parameters

array

$attributes

Return Value

static Model forceCreate(array $attributes)

Save a new model and return the instance. Allow mass-assignment.

Parameters

array

$attributes

Return Value

static Builder query()

Begin querying the model.

Return Value

static Builder on(string|null $connection = null)

Begin querying the model on a given connection.

Parameters

string|null

$connection

Return Value

static Builder onWriteConnection()

Begin querying the model on the write connection.

Return Value

static Collection|Model[] all(array|mixed $columns = array('*'))

Get all of the models from the database.

Parameters

array|mixed

$columns

Return Value

Collection|Model[]

Model|null fresh(array|string $with = array())

Reload a fresh model instance from the database.

Parameters

array|string

$with

Return Value

Model|null

$this load(array|string $relations)

Eager load relations on the model.

Parameters

array|string

$relations

Return Value

$this

static Builder|Model with(array|string $relations)

Begin querying a model with eager loading.

Parameters

array|string

$relations

Return Value

$this append(array|string $attributes)

Append attributes to query when building a query.

Parameters

array|string

$attributes

Return Value

$this

HasOne hasOne(string $related, string $foreignKey = null, string $localKey = null)

Define a one-to-one relationship.

Parameters

string	$related
string	$foreignKey
string	$localKey

Return Value

HasOne

MorphOne morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-one relationship.

Parameters

string	$related
string	$name
string	$type
string	$id
string	$localKey

Return Value

MorphOne

BelongsTo belongsTo(string $related, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define an inverse one-to-one or many relationship.

Parameters

string	$related
string	$foreignKey
string	$otherKey
string	$relation

Return Value

BelongsTo

MorphTo morphTo(string $name = null, string $type = null, string $id = null)

Define a polymorphic, inverse one-to-one or many relationship.

Parameters

string	$name
string	$type
string	$id

Return Value

MorphTo

string getActualClassNameForMorph(string $class)

Retrieve the fully qualified class name from a slug.

Parameters

string

$class

Return Value

string

HasMany hasMany(string $related, string $foreignKey = null, string $localKey = null)

Define a one-to-many relationship.

Parameters

string	$related
string	$foreignKey
string	$localKey

Return Value

HasMany

HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null)

Define a has-many-through relationship.

Parameters

string	$related
string	$through
string\|null	$firstKey
string\|null	$secondKey
string\|null	$localKey

Return Value

HasManyThrough

MorphMany morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-many relationship.

Parameters

string	$related
string	$name
string	$type
string	$id
string	$localKey

Return Value

MorphMany

BelongsToMany belongsToMany(string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define a many-to-many relationship.

Parameters

string	$related
string	$table
string	$foreignKey
string	$otherKey
string	$relation

Return Value

BelongsToMany

MorphToMany morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false)

Define a polymorphic many-to-many relationship.

Parameters

string	$related
string	$name
string	$table
string	$foreignKey
string	$otherKey
bool	$inverse

Return Value

MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null)

Define a polymorphic, inverse many-to-many relationship.

Parameters

string	$related
string	$name
string	$table
string	$foreignKey
string	$otherKey

Return Value

string joiningTable(string $related)

Get the joining table name for a many-to-many relation.

Parameters

string

$related

Return Value

string

static int destroy(array|int $ids)

Destroy the models for the given IDs.

Parameters

array|int

$ids

Return Value

int

bool|null delete()

Delete the model from the database.

Return Value

bool|null

Exceptions

Exception

bool|null forceDelete()

Force a hard delete on a soft deleted model.

This method protects developers from running forceDelete when trait is missing.

Return Value

bool|null

static void saving(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void saved(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void updating(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void updated(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void creating(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void created(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void deleting(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void deleted(Closure|string $callback, int $priority)

Parameters

Closure\|string	$callback
int	$priority

Return Value

void

static void flushEventListeners()

Remove all of the event listeners for the model.

Return Value

void

array getObservableEvents()

Get the observable event names.

Return Value

array

$this setObservableEvents(array $observables)

Set the observable event names.

Parameters

array

$observables

Return Value

$this

void addObservableEvents(array|mixed $observables)

Add an observable event name.

Parameters

array|mixed

$observables

Return Value

void

void removeObservableEvents(array|mixed $observables)

Remove an observable event name.

Parameters

array|mixed

$observables

Return Value

void

bool update(array $attributes = array(), array $options = array())

Update the model in the database.

Parameters

array	$attributes
array	$options

Return Value

bool

bool push()

Save the model and all of its relationships.

Return Value

bool

bool save(array $options = array())

Save the model to the database.

Parameters

array

$options

Return Value

bool

bool saveOrFail(array $options = array())

Save the model to the database using transaction.

Parameters

array

$options

Return Value

bool

Exceptions

Throwable

void touchOwners()

Touch the owning relations of the model.

Return Value

void

bool touches(string $relation)

Determine if the model touches a given relation.

Parameters

string

$relation

Return Value

bool

bool touch()

Update the model's update timestamp.

Return Value

bool

$this setCreatedAt(mixed $value)

Set the value of the "created at" attribute.

Parameters

mixed

$value

Return Value

$this

$this setUpdatedAt(mixed $value)

Set the value of the "updated at" attribute.

Parameters

mixed

$value

Return Value

$this

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

Carbon freshTimestamp()

Get a fresh timestamp for the model.

Return Value

Carbon

string freshTimestampString()

Get a fresh timestamp for the model.

Return Value

string

Builder newQuery()

Get a new query builder for the model's table.

Return Value

Builder newQueryWithoutScope(Scope|string $scope)

Get a new query instance without a given scope.

Parameters

Scope|string

$scope

Return Value

Builder|Model newQueryWithoutScopes()

Get a new query builder that doesn't have any global scopes.

Return Value

Builder|Model newEloquentBuilder(Builder $query)

Create a new Eloquent query builder for the model.

Parameters

$query

Return Value

Collection newCollection(array $models = array())

Create a new database notification collection instance.

Parameters

array

$models

Return Value

Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists)

Create a new pivot model instance.

Parameters

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

Return Value

Pivot

string getTable()

Get the table associated with the model.

Return Value

string

$this setTable(string $table)

Set the table associated with the model.

Parameters

string

$table

Return Value

$this

mixed getKey()

Get the value of the model's primary key.

Return Value

mixed

mixed getQueueableId()

Get the queueable identity for the entity.

Return Value

mixed

string getKeyName()

Get the primary key for the model.

Return Value

string

$this setKeyName(string $key)

Set the primary key for the model.

Parameters

string

$key

Return Value

$this

string getQualifiedKeyName()

Get the table qualified key name.

Return Value

string

string getKeyType()

Get the auto incrementing key type.

Return Value

string

mixed getRouteKey()

Get the value of the model's route key.

Return Value

mixed

string getRouteKeyName()

Get the route key for the model.

Return Value

string

bool usesTimestamps()

Determine if the model uses timestamps.

Return Value

bool

string getMorphClass()

Get the class name for polymorphic relations.

Return Value

string

int getPerPage()

Get the number of models to return per page.

Return Value

int

$this setPerPage(int $perPage)

Set the number of models to return per page.

Parameters

int

$perPage

Return Value

$this

string getForeignKey()

Get the default foreign key name for the model.

Return Value

string

array getHidden()

Get the hidden attributes for the model.

Return Value

array

$this setHidden(array $hidden)

Set the hidden attributes for the model.

Parameters

array

$hidden

Return Value

$this

void addHidden(array|string|null $attributes = null)

Add hidden attributes for the model.

Parameters

array|string|null

$attributes

Return Value

void

$this makeVisible(array|string $attributes)

Make the given, typically hidden, attributes visible.

Parameters

array|string

$attributes

Return Value

$this

$this makeHidden(array|string $attributes)

Make the given, typically visible, attributes hidden.

Parameters

array|string

$attributes

Return Value

$this

array getVisible()

Get the visible attributes for the model.

Return Value

array

$this setVisible(array $visible)

Set the visible attributes for the model.

Parameters

array

$visible

Return Value

$this

void addVisible(array|string|null $attributes = null)

Add visible attributes for the model.

Parameters

array|string|null

$attributes

Return Value

void

$this setAppends(array $appends)

Set the accessors to append to model arrays.

Parameters

array

$appends

Return Value

$this

array getFillable()

Get the fillable attributes for the model.

Return Value

array

$this fillable(array $fillable)

Set the fillable attributes for the model.

Parameters

array

$fillable

Return Value

$this

array getGuarded()

Get the guarded attributes for the model.

Return Value

array

$this guard(array $guarded)

Set the guarded attributes for the model.

Parameters

array

$guarded

Return Value

$this

static void unguard(bool $state = true)

Disable all mass assignable restrictions.

Parameters

bool

$state

Return Value

void

static void reguard()

Enable the mass assignment restrictions.

Return Value

void

static bool isUnguarded()

Determine if current state is "unguarded".

Return Value

bool

static mixed unguarded(callable $callback)

Run the given callable while being unguarded.

Parameters

callable

$callback

Return Value

mixed

bool isFillable(string $key)

Determine if the given attribute may be mass assigned.

Parameters

string

$key

Return Value

bool

bool isGuarded(string $key)

Determine if the given key is guarded.

Parameters

string

$key

Return Value

bool

bool totallyGuarded()

Determine if the model is totally guarded.

Return Value

bool

array getTouchedRelations()

Get the relationships that are touched on save.

Return Value

array

$this setTouchedRelations(array $touches)

Set the relationships that are touched on save.

Parameters

array

$touches

Return Value

$this

bool getIncrementing()

Get the value indicating whether the IDs are incrementing.

Return Value

bool

$this setIncrementing(bool $value)

Set whether IDs are incrementing.

Parameters

bool

$value

Return Value

$this

string toJson(int $options)

Convert the model instance to JSON.

Parameters

int

$options

Return Value

string

array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

array toArray()

Convert the model instance to an array.

Return Value

array

array attributesToArray()

Convert the model's attributes to an array.

Return Value

array

array relationsToArray()

Get the model's relationships in array form.

Return Value

array

mixed getAttribute(string $key)

Get an attribute from the model.

Parameters

string

$key

Return Value

mixed

mixed getAttributeValue(string $key)

Get a plain attribute (not a relationship).

Parameters

string

$key

Return Value

mixed

mixed getRelationValue(string $key)

Get a relationship.

Parameters

string

$key

Return Value

mixed

bool hasGetMutator(string $key)

Determine if a get mutator exists for an attribute.

Parameters

string

$key

Return Value

bool

bool hasCast(string $key, array|string|null $types = null)

Determine whether an attribute should be cast to a native type.

Parameters

string	$key
array\|string\|null	$types

Return Value

bool

array getCasts()

Get the casts array.

Return Value

array

$this setAttribute(string $key, mixed $value)

Set a given attribute on the model.

Parameters

string	$key
mixed	$value

Return Value

$this

$this fillJsonAttribute(string $key, mixed $value)

Set a given JSON attribute on the model.

Parameters

string	$key
mixed	$value

Return Value

$this

bool hasSetMutator(string $key)

Determine if a set mutator exists for an attribute.

Parameters

string

$key

Return Value

bool

array getDates()

Get the attributes that should be converted to dates.

Return Value

array

string fromDateTime(DateTime|int $value)

Convert a DateTime to a storable string.

Parameters

DateTime|int

$value

Return Value

string

$this setDateFormat(string $format)

Set the date format used by the model.

Parameters

string

$format

Return Value

$this

mixed fromJson(string $value, bool $asObject = false)

Decode the given JSON back into an array or object.

Parameters

string	$value
bool	$asObject

Return Value

mixed

Model replicate(array $except = null)

Clone the model into a new, non-existing instance.

Parameters

array

$except

Return Value

bool is(Model $model)

Determine if two models have the same ID and belong to the same table.

Parameters