Documentation

User extends User

in package

• Application

Uses SoftDelete

RainLab\User\Models\User

Tags

mixin

\Eloquent

Table of Contents

CREATED_AT  = 'created_at'

The name of the "created at" column.

UPDATED_AT  = 'updated_at'

The name of the "updated at" column.

$activated_at  : Carbon|null

$activation_code  : string|null

$attachMany  : mixed

protected $attachMany = [ 'pictures' => ['October\Rain\Database\Attach\File', 'name'=> 'imageable'] ];

$attachOne  : mixed

$attributeNames  : array<string|int, mixed>

$belongsTo  : mixed

protected $belongsTo = [ 'parent' => ['Category', 'key' => 'parent_id'] ];

$belongsToMany  : array<string|int, mixed>

$city  : string|null

$company  : string|null

$country_id  : int|null

$created_at  : Carbon|null

$created_ip_address  : string|null

$customMessages  : array<string|int, mixed>

$deleted_at  : Carbon|null

$duplicateCache  : bool

$email  : string

$exists  : bool

Indicates if the model exists.

$hasMany  : array<string|int, mixed>

Cleaner declaration of relationships.

$hasManyThrough  : mixed

protected $attachMany = [ 'pictures' => ['Picture', 'name'=> 'imageable'] ];

$hasOne  : mixed

protected $hasOne = [ 'owner' => ['User', 'key' => 'user_id'] ];

$id  : int

$implement  : array<string|int, mixed>

$incrementing  : bool

Indicates if the IDs are auto-incrementing.

$is_activated  : bool

$is_guest  : int

$is_superuser  : int

$iu_about  : string|null

$iu_blog  : string|null

$iu_comment  : string|null

$iu_company  : string|null

$iu_facebook  : string|null

$iu_gender  : string|null

$iu_icq  : string|null

$iu_job  : string|null

$iu_skype  : string|null

$iu_telephone  : string|null

$iu_twitter  : string|null

$iu_webpage  : string|null

$last_ip_address  : string|null

$last_login  : Carbon|null

$last_seen  : Carbon|null

$loginAttribute  : string

$manyMethods  : array<string|int, mixed>

The many to many relationship methods.

$mobile  : string|null

$morphedByMany  : mixed

$morphMany  : mixed

protected $morphMany = [ 'log' => ['History', 'name' => 'user'] ];

$morphOne  : mixed

protected $morphOne = [ 'log' => ['History', 'name' => 'user'] ];

$morphTo  : mixed

protected $morphTo = [ 'pictures' => [] ];

$morphToMany  : mixed

protected $morphToMany = [ 'tag' => ['Tag', 'table' => 'tagables', 'name' => 'tagable'] ];

$name  : string|null

$password  : string

$permissions  : string|null

$persist_code  : string|null

$phone  : string|null

$reset_password_code  : string|null

$rules  : array<string|int, mixed>

Validation rules

$sessionKey  : string

$settings  : string|null

$snakeAttributes  : bool

Indicates whether attributes are snake cased on arrays.

$state_id  : int|null

$street_addr  : string|null

$surname  : string|null

$timestamps  : bool

Indicates if the model should be timestamped.

$timezone_id  : int

$updated_at  : Carbon|null

$username  : string|null

$wasRecentlyCreated  : bool

Indicates if the model was inserted during the current request lifecycle.

$zip  : string|null

$allowedPermissionsValues  : array<string|int, mixed>

Allowed permissions values.

$appends  : array<string|int, mixed>

The accessors to append to the model's array form.

$attributes  : array<string|int, mixed>

The model's attributes.

$booted  : array<string|int, mixed>

The array of booted models.

$casts  : array<string|int, mixed>

The attributes that should be cast to native types.

$changes  : array<string|int, mixed>

The changed model attributes.

$connection  : string

The connection name for the model.

$dateFormat  : string

The storage format of the model's date columns.

$dates  : array<string|int, mixed>

The attributes that should be mutated to dates.

$dispatcher  : Dispatcher

The event dispatcher instance.

$dispatchesEvents  : array<string|int, mixed>

The event map for the model.

$emitterEventCollection  : array<string|int, mixed>

$emitterEventSorted  : array<string|int, mixed>

$emitterSingleEventCollection  : array<string|int, mixed>

$eventsBooted  : array<string|int, mixed>

$extendableCallbacks  : array<string|int, mixed>

$extendableGuardProperties  : bool

$extendableStaticMethods  : array<string|int, mixed>

$extensionData  : array<string|int, mixed>

$fillable  : array<string|int, mixed>

$forceDeleting  : bool

Indicates if the model is currently force deleting.

$globalScopes  : array<string|int, mixed>

The array of global scopes on the model.

$guardableColumns  : array<string|int, mixed>

The actual columns that exist on the database and can be guarded.

$guarded  : array<string|int, mixed>

Reset guarded fields, because we use $fillable instead.

$hashable  : array<string|int, mixed>

$hidden  : array<string|int, mixed>

The attributes that should be hidden for serialization.

$jsonable  : array<string|int, mixed>

$keyType  : string

The "type" of the auto-incrementing ID.

$mergedPermissions  : array<string|int, mixed>

$mutatorCache  : array<string|int, mixed>

The cache of the mutated attributes for each class.

$observables  : array<string|int, mixed>

User exposed observable events.

$original  : array<string|int, mixed>

The model attribute's original state.

$originalHashableValues  : array<string|int, mixed>

$originalPurgeableValues  : array<string|int, mixed>

$perPage  : int

The number of models to return for pagination.

$primaryKey  : string

The primary key for the model.

$purgeable  : array<string|int, mixed>

Purge attributes from data set.

$relations  : array<string|int, mixed>

The loaded relationships for the model.

$relationTypes  : array<string|int, mixed>

$rememberTokenName  : string

$resolver  : ConnectionResolverInterface

The connection resolver instance.

$table  : string

$touches  : array<string|int, mixed>

The relationships that should be touched on save.

$unguarded  : bool

Indicates if all mass assignment is enabled.

$validationDefaultAttrNames  : array<string|int, mixed>

$validationErrors  : MessageBag

$visible  : array<string|int, mixed>

The attributes that should be visible in serialization.

$with  : array<string|int, mixed>

The relations to eager load on every query.

$withCount  : array<string|int, mixed>

The relationship counts that should be eager loaded on every query.

__call()  : mixed

Handle dynamic method calls into the model.

__callStatic()  : mixed

Handle dynamic static method calls into the method.

__construct()  : void

Create a new Eloquent model instance.

__get()  : mixed

Dynamically retrieve attributes on the model.

__isset()  : bool

Determine if an attribute or relation exists on the model.

__set()  : void

Dynamically set attributes on the model.

__toString()  : string

Convert the model to its string representation.

__unset()  : void

Unset an attribute on the model.

__wakeup()  : void

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

addCasts()  : void

Add attribute casts for the model.

addDateAttribute()  : void

Adds a datetime attribute to convert to an instance of Carbon/DateTime object.

addDynamicMethod()  : mixed

Programmatically adds a method to the extendable class

addDynamicProperty()  : mixed

Programmatically adds a property to the extendable class

addFillable()  : void

Add fillable attributes for the model.

addGlobalScope()  : mixed

Register a new global scope on the model.

addGroup()  : bool

Adds the user to the given group.

addHashable()  : $this

Adds an attribute to the hashable attributes list

addHashableAttribute()  : mixed

addHidden()  : void

Add hidden attributes for the model.

addJsonable()  : void

Add jsonable attributes for the model.

addObservableEvents()  : void

Add an observable event name.

addPurgeable()  : $this

Adds an attribute to the purgeable attributes list

addVisible()  : void

Add visible attributes for the model.

afterCreate()  : void

After create event

afterDelete()  : void

After delete event

afterLogin()  : void

After login event

all()  :

all()  : Collection|array<string|int, static>

Get all of the models from the database.

alwaysPush()  : bool

Pushes the first level of relations even if the parent model has no changes.

append()  : $this

Append attributes to query when building a query.

asExtension()  : mixed

Short hand for `getClassExtension()` method, except takes the short extension name, example:

attachMany()  : MorphMany

Define an attachment one-to-many relationship.

attachOne()  : MorphOne

Define an attachment one-to-one relationship.

attemptActivation()  : bool

Sends the confirmation email to a user, after activating.

attemptResetPassword()  : bool

Attempts to reset a user's password by matching the reset code generated with the user's.

attributesToArray()  : array<string|int, mixed>

Convert the model's attributes to an array.

ban()  : void

Ban this user, preventing them from signing in.

beforeLogin()  : void

Before login event

beforeValidate()  : void

Before validation event

belongsTo()  : BelongsTo

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

belongsToMany()  : BelongsToMany

Define a many-to-many relationship.

bindDeferred()  : mixed

Bind a deferred relationship to the supplied record.

bindEvent()  : self

Create a new event binding.

bindEventOnce()  : self

Create a new event binding that fires once only

bootHashable()  : void

Boot the hashable trait for a model.

bootPurgeable()  : void

Boot the purgeable trait for a model.

bootSoftDelete()  : void

Boot the soft deleting trait for a model.

bootValidation()  : void

Boot the validation trait for this model.

cacheMutatedAttributes()  : void

Extract and cache all the mutated attributes of a class.

cancelDeferred()  : mixed

Cancel all deferred bindings to this model.

checkHashValue()  : bool

Checks if the supplied plain value matches the stored hash value.

checkPassword()  : bool

Checks the password passed matches the user's password.

checkPersistCode()  : bool

Checks the given persist code.

checkResetPasswordCode()  : bool

Checks if the provided user reset password code is valid without actually resetting the password.

clearBootedModels()  : void

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

clearExtendedClasses()  : void

Clear the list of extended classes so they will be re-extended.

clearResetPassword()  : void

Wipes out the data associated with resetting a password.

commitDeferred()  : mixed

Commit all deferred bindings to this model.

convertToRegistered()  : void

Converts a guest user to a registered one and sends an invitation notification.

create()  : Model|static

Save a new model and return the instance.

created()  : void

Register a created model event with the dispatcher.

creating()  : void

Register a creating model event with the dispatcher.

delete()  : bool|null

Delete the model from the database.

deleted()  : void

Register a deleted model event with the dispatcher.

deleting()  : void

Register a deleting model event with the dispatcher.

destroy()  : int

Destroy the models for the given IDs.

errors()  : MessageBag

Get validation error message collection for the Model

extend()  : mixed

Extend this object properties upon construction.

extendableCall()  : mixed

Magic method for `__call()`

extendableCallStatic()  : mixed

Magic method for `__callStatic()`

extendableConstruct()  : mixed

This method should be called as part of the constructor.

extendableExtendCallback()  : void

Helper method for `::extend()` static method

extendableGet()  : string

Magic method for `__get()`

extendableSet()  : string

Magic method for `__set()`

extendClassWith()  : void

Dynamically extend a class with a specified behavior

fetched()  : void

Create a new native event for handling afterFetch().

fetching()  : void

Create a new native event for handling beforeFetch().

fill()  : $this

Fill the model with an array of attributes.

fillable()  : $this

Set the fillable attributes for the model.

fillJsonAttribute()  : $this

Set a given JSON attribute on the model.

filterByGroup()  :

findByEmail()  : self

Looks up a user by their email address.

fireEvent()  : array<string|int, mixed>

Fire an event and call the listeners.

flushDuplicateCache()  : void

Flush the memory cache.

flushEventListeners()  : void

Remove all of the event listeners for the model.

forceDelete()  : bool|null

Force a hard delete on a soft deleted model.

forceFill()  : $this

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

forceSave()  : bool

Force save the model even if validation fails.

fresh()  : static|null

Reload a fresh model instance from the database.

freshTimestamp()  : Carbon

Get a fresh timestamp for the model.

freshTimestampString()  : string

Get a fresh timestamp for the model.

fromDateTime()  : string

Convert a DateTime to a storable string.

fromJson()  : mixed

Decode the given JSON back into an array or object.

get()  :

getActivationCode()  : string

Get an activation code for the given user.

getActualClassNameForMorph()  : string

Retrieve the actual class name for a given morph class.

getAttribute()  : mixed

Get an attribute from the model.

getAttributes()  : array<string|int, mixed>

Get all of the current attributes on the model.

getAttributeValue()  : mixed

Get a plain attribute (not a relationship).

getAuthIdentifier()  : mixed

Get the unique identifier for the user.

getAuthIdentifierName()  : string

Get the name of the unique identifier for the user.

getAuthPassword()  : string

Get the password for the user.

getAvatarThumb()  : mixed

Returns the public image file path to this user's avatar.

getCasts()  : array<string|int, mixed>

Get the casts array.

getChanges()  : array<string|int, mixed>

Get the attributes that were changed.

getClassExtension()  : mixed

Returns a behavior object from an extendable class, example:

getClassMethods()  : array<string|int, mixed>

Get a list of class methods, extension equivalent of get_class_methods()

getConnection()  : Connection

Get the database connection for the model.

getConnectionName()  : string

Get the current connection name for the model.

getConnectionResolver()  : ConnectionResolverInterface

Get the connection resolver instance.

getCreatedAtColumn()  : string

Get the name of the "created at" column.

getDates()  : array<string|int, mixed>

Get the attributes that should be converted to dates.

getDeletedAtColumn()  : string

Get the name of the "deleted at" column.

getDirty()  : array<string|int, mixed>

Get the attributes that have been changed since last sync.

getDynamicProperties()  : array<string|int, mixed>

Returns all dynamic properties and their values

getEventDispatcher()  : Dispatcher

Get the event dispatcher instance.

getFillable()  : array<string|int, mixed>

Get the fillable attributes for the model.

getForeignKey()  : string

Get the default foreign key name for the model.

getGlobalScope()  : Scope|Closure|null

Get a global scope registered with the model.

getGlobalScopes()  : array<string|int, mixed>

Get the global scopes for this class instance.

getGroups()  : array<string|int, mixed>

Returns an array of groups which the given user belongs to.

getGuarded()  : array<string|int, mixed>

Get the guarded attributes for the model.

getHashableAttributes()  : array<string|int, mixed>

Returns a collection of fields that will be hashed.

getHidden()  : array<string|int, mixed>

Get the hidden attributes for the model.

getIncrementing()  : bool

Get the value indicating whether the IDs are incrementing.

getIsActivatedAttribute()  : bool

Get mutator for giving the activated property.

getJsonable()  : array<string|int, mixed>

Get the jsonable attributes name

getKey()  : mixed

Get the value of the model's primary key.

getKeyName()  : string

Get the primary key for the model.

getKeyType()  : string

Get the auto-incrementing key type.

getLastSeen()  : Carbon

Returns the date this user was last seen.

getLogin()  : mixed

getLoginName()  : string

Returns the name for the user's login.

getMergedPermissions()  : array<string|int, mixed>

Returns an array of merged permissions for each group the user is in.

getMinPasswordLength()  : int

Returns the minimum length for a new password from settings.

getMorphClass()  : string

Get the class name for polymorphic relations.

getMutatedAttributes()  : array<string|int, mixed>

Get the mutated attributes for a given instance.

getNotificationVars()  : array<string|int, mixed>

Returns the variables available when sending a user notification.

getObservableEvents()  : array<string|int, mixed>

Get the observable event names.

getOriginal()  : mixed|array<string|int, mixed>

Get the model's original attribute values.

getOriginalHashValue()  : mixed

Returns the original values of any hashed attributes.

getOriginalHashValues()  : array<string|int, mixed>

Returns the original values of any hashed attributes.

getOriginalPurgeValue()  : mixed

Returns the original values of any purged attributes.

getOriginalPurgeValues()  : mixed

Returns the original values of any purged attributes.

getPerPage()  : int

Get the number of models to return per page.

getPersistCode()  : string

Gets a code for when the user is persisted to a cookie or session which identifies the user.

getPurgeableAttributes()  : mixed

Returns a collection of fields that will be hashed.

getQualifiedDeletedAtColumn()  : string

Get the fully qualified "deleted at" column.

getQualifiedKeyName()  : string

Get the table qualified key name.

getQueueableConnection()  : mixed

Get the queueable connection for the entity.

getQueueableId()  : mixed

Get the queueable identity for the entity.

getRandomString()  : string

Generate a random string

getRelation()  : mixed

Get a specified relationship.

getRelationDefinition()  : array<string|int, mixed>

Returns relationship details from a supplied name.

getRelationDefinitions()  : array<string|int, mixed>

Returns relationship details for all relations defined on this model.

getRelations()  : array<string|int, mixed>

Get all the loaded relations for the instance.

getRelationType()  : string

Returns a relationship type based on a supplied name.

getRelationValue()  : mixed

Get a relationship.

getRememberToken()  : string

Get the token value for the "remember me" session.

getRememberTokenName()  : string

Get the column name for the "remember me" token.

getReminderEmail()  : string

Get the e-mail address where password reminders are sent.

getResetPasswordCode()  : string

Get a reset password code for the given user.

getRole()  : Role

Returns the role assigned to this user.

getRouteKey()  : mixed

Get the value of the model's route key.

getRouteKeyName()  : string

Get the route key for the model.

getTable()  : string

Get the table associated with the model.

getTouchedRelations()  : array<string|int, mixed>

Get the relationships that are touched on save.

getUpdatedAtColumn()  : string

Get the name of the "updated at" column.

getVisible()  : array<string|int, mixed>

Get the visible attributes for the model.

guard()  : $this

Set the guarded attributes for the model.

hasAccess()  : bool

See if a user has access to the passed permission(s).

hasAnyAccess()  : bool

Returns if the user has access to any of the given permissions.

hasCast()  : bool

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

hasGetMutator()  : bool

Determine if a get mutator exists for an attribute.

hasGlobalScope()  : bool

Determine if a model has a global scope.

hasMany()  : HasMany

Define a one-to-many relationship.

hasManyThrough()  : HasManyThrough

Define a has-many-through relationship.

hasOne()  : HasOne

Define a one-to-one relationship.

hasPermission()  : bool

See if a user has access to the passed permission(s).

hasRelation()  : bool

Checks if model has a relationship by supplied name.

hasSetMutator()  : bool

Determine if a set mutator exists for an attribute.

inGroup()  : bool

See if the user is in the given group.

is()  : bool

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

isActivated()  :

isAttributeRequired()  : bool

Determines if an attribute is required based on the validation rules.

isBanned()  : bool

Check if the user is banned.

isClassExtendedWith()  : bool

Check if extendable class is extended with a behavior object

isClean()  : bool

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

isDeferrable()  : mixed

Returns true if a relation exists and can be deferred.

isDirty()  : bool

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

isFillable()  : bool

Determine if the given attribute may be mass assigned.

isGuarded()  : bool

Determine if the given key is guarded.

isJsonable()  : array<string|int, mixed>

Checks if an attribute is jsonable or not.

isNot()  : bool

Determine if two models are not the same.

isOnline()  : bool

Returns true if the user has been active within the last 5 minutes.

isRegisterThrottled()  : bool

Returns true if IP address is throttled and cannot register again. Maximum 3 registrations every 60 minutes.

isRelationPushable()  : bool

Determines whether the specified relation should be saved when push() is called instead of save() on the model. Default: true.

isSoftDelete()  : bool

Helper method to check if the model is currently being hard or soft deleted, useful in events.

isSuperUser()  : bool

Checks if the user is a super user - has access to everything regardless of permissions.

isSuspended()  : bool

Check if the user is suspended.

isUnguarded()  : bool

Determine if current state is "unguarded".

joiningTable()  : string

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

jsonable()  : $this

Set the jsonable attributes for the model.

jsonSerialize()  : array<string|int, mixed>

Convert the object into something JSON serializable.

load()  : $this

Eager load relations on the model.

loadMissing()  : $this

Eager load relations on the model if they are not already eager loaded.

make()  : Model|static

Create a new model and return the instance.

makeHashValue()  : string

Hashes an attribute value and saves it in the original locker.

makeHidden()  : $this

Make the given, typically visible, attributes hidden.

makeRelation()  : string

Returns a relation class object

makeVisible()  : $this

Make the given, typically hidden, attributes visible.

methodExists()  : bool

Checks if a method exists, extension equivalent of method_exists()

morphedByMany()  : MorphToMany

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

morphMany()  : MorphMany

Define a polymorphic one-to-many relationship.

morphOne()  : MorphOne

Define a polymorphic one-to-one relationship.

morphTo()  : MorphTo

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

morphToMany()  : MorphToMany

Define a polymorphic many-to-many relationship.

newCollection()  : Collection

Create a new Eloquent Collection instance.

newEloquentBuilder()  : Builder|static

Create a new Eloquent query builder for the model.

newFromBuilder()  : static

Create a new model instance that is existing.

newInstance()  : static

Create a new instance of the given model.

newModelQuery()  : Builder|static

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

newModelQuery()  :

newPivot()  : Pivot

Create a new pivot model instance.

newQuery()  :

newQuery()  : Builder

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

newQueryForRestoration()  : Builder

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

newQueryWithoutRelationships()  : Builder

Get a new query builder with no relationships loaded.

newQueryWithoutScope()  : Builder

Get a new query instance without a given scope.

newQueryWithoutScopes()  : Builder|static

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

newRelationPivot()  : Pivot

Create a pivot model instance specific to a relation.

observe()  : void

Register an observer with the Model.

offsetExists()  : bool

Determine if the given attribute exists.

offsetGet()  : mixed

Get the value for a given offset.

offsetSet()  : void

Set the value for a given offset.

offsetUnset()  : void

Unset the value for a given offset.

on()  : Builder

Begin querying the model on a given connection.

only()  : array<string|int, mixed>

Get a subset of the model's attributes.

onlyTrashed()  : Builder|static

Get a new query builder that only includes soft deletes.

onWriteConnection()  : Builder

Begin querying the model on the write connection.

propertyExists()  : bool

Checks if a property exists, extension equivalent of `property_exists()`

purgeAttributes()  : array<string|int, mixed>

Removes purged attributes from the dataset, used before saving.

push()  : bool

Save the model and all of its relationships.

qualifyColumn()  : string

Qualify the given column name by the model's table.

query()  : Builder

Begin querying the model.

query()  :

refresh()  : $this

Reload the current model instance with fresh attributes from the database.

registerGlobalScopes()  : Builder

Register the global scopes for this builder instance.

reguard()  : void

Enable the mass assignment restrictions.

relationLoaded()  : bool

Determine if the given relation is loaded.

relationsToArray()  : array<string|int, mixed>

Get the model's relationships in array form.

reload()  : Model|static

Reloads the model attributes from the database.

reloadRelations()  : void

Reloads the model relationship cache.

removeGroup()  : bool

Removes the user from the given group.

removeObservableEvents()  : void

Remove an observable event name.

replicate()  : Model

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

resolveConnection()  : Connection

Resolve a connection instance.

resolveRouteBinding()  : Model|null

Retrieve the model for a bound value.

restore()  : bool|null

Restore a soft-deleted model instance.

restored()  : void

Register a restored model event with the dispatcher.

restorePurgedValues()  : mixed

Restores the original values of any purged attributes.

restoring()  : void

Register a restoring model event with the dispatcher.

retrieved()  : void

Register a retrieved model event with the dispatcher.

save()  : bool

Save the model to the database.

saved()  : void

Register a saved model event with the dispatcher.

saveOrFail()  : bool

Save the model to the database using transaction.

saving()  : void

Register a saving model event with the dispatcher.

scopeFilterByGroup()  : mixed

scopeIsActivated()  : mixed

setAppends()  : $this

Set the accessors to append to model arrays.

setAttribute()  : $this

Set a given attribute on the model.

setConnection()  : $this

Set the connection associated with the model.

setConnectionResolver()  : void

Set the connection resolver instance.

setCreatedAt()  : $this

Set the value of the "created at" attribute.

setDateFormat()  : $this

Set the date format used by the model.

setEventDispatcher()  : void

Set the event dispatcher instance.

setHidden()  : $this

Set the hidden attributes for the model.

setIncrementing()  : $this

Set whether IDs are incrementing.

setKeyName()  : $this

Set the primary key for the model.

setKeyType()  : $this

Set the data type for the primary key.

setObservableEvents()  : $this

Set the observable event names.

setPasswordAttribute()  : mixed

Protects the password from being reset to null.

setPermissionsAttribute()  : void

Validate any set permissions.

setPerPage()  : $this

Set the number of models to return per page.

setRawAttributes()  : $this

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

setRelation()  : $this

Set the specific relationship in the model.

setRelations()  : $this

Set the entire relations array on the model.

setRememberToken()  : void

Set the token value for the "remember me" session.

setTable()  : $this

Set the table associated with the model.

setTouchedRelations()  : $this

Set the relationships that are touched on save.

setUpdatedAt()  : $this

Set the value of the "updated at" attribute.

setValidationAttributeName()  : void

Programatically sets the validation attribute names, will take lower priority to model defined attribute names found in `$attributeNames`.

setValidationAttributeNames()  : void

Programatically sets multiple validation attribute names.

setVisible()  : $this

Set the visible attributes for the model.

syncChanges()  : $this

Sync the changed attributes.

syncOriginal()  : $this

Sync the original attributes with the current.

syncOriginalAttribute()  : $this

Sync a single original attribute with its current value.

toArray()  : array<string|int, mixed>

Convert the model instance to an array.

toJson()  : string

Convert the model instance to JSON.

totallyGuarded()  : bool

Determine if the model is totally guarded.

touch()  : bool

Update the model's update timestamp.

touches()  : bool

Determine if the model touches a given relation.

touchIpAddress()  : void

Records the last_ip_address to reflect the last known IP for this user.

touchLastSeen()  : void

Checks if the user has been seen in the last 5 minutes, and if not, updates the last_seen timestamp to reflect their online status.

touchOwners()  : void

Touch the owning relations of the model.

trashed()  : bool

Determine if the model instance has been soft-deleted.

unban()  : void

Remove the ban on this user.

unbindDeferred()  : mixed

Unbind a deferred relationship to the supplied record.

unbindEvent()  : self

Destroys an event binding.

unguard()  : void

Disable all mass assignable restrictions.

unguarded()  : mixed

Run the given callable while being unguarded.

unsetConnectionResolver()  : void

Unset the connection resolver for models.

unsetEventDispatcher()  : void

Unset the event dispatcher for models.

unsuspend()  : void

Remove the suspension on this user.

update()  : bool

Update the model in the database.

updated()  : void

Register an updated model event with the dispatcher.

updating()  : void

Register an updating model event with the dispatcher.

usesTimestamps()  : bool

Determine if the model uses timestamps.

validate()  : bool

Validate the model instance

validated()  : void

Create a new native event for handling afterValidate().

validating()  : void

Create a new native event for handling beforeValidate().

wasChanged()  : bool

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

whereActivatedAt()  :

whereActivationCode()  :

whereCity()  :

whereCompany()  :

whereCountryId()  :

whereCreatedAt()  :

whereCreatedIpAddress()  :

whereDeletedAt()  :

whereEmail()  :

whereId()  :

whereIsActivated()  :

whereIsGuest()  :

whereIsSuperuser()  :

whereIuAbout()  :

whereIuBlog()  :

whereIuComment()  :

whereIuCompany()  :

whereIuFacebook()  :

whereIuGender()  :

whereIuIcq()  :

whereIuJob()  :

whereIuSkype()  :

whereIuTelephone()  :

whereIuTwitter()  :

whereIuWebpage()  :

whereLastIpAddress()  :

whereLastLogin()  :

whereLastSeen()  :

whereMobile()  :

whereName()  :

wherePassword()  :

wherePermissions()  :

wherePersistCode()  :

wherePhone()  :

whereResetPasswordCode()  :

whereSettings()  :

whereStateId()  :

whereStreetAddr()  :

whereSurname()  :

whereTimezoneId()  :

whereUpdatedAt()  :

whereUsername()  :

whereZip()  :

with()  : Builder|static

Begin querying a model with eager loading.

withTrashed()  : Builder|static

Get a new query builder that includes soft deletes.

addCastAttributesToArray()  : array<string|int, mixed>

Add the casted attributes to the attributes array.

addDateAttributesToArray()  : array<string|int, mixed>

Add the date attributes to the attributes array.

addMutatedAttributesToArray()  : array<string|int, mixed>

Add the mutated attributes to the attributes array.

afterFetch()  : mixed

Handle the "fetched" model event

afterSave()  : mixed

Handle the "saved" model event

afterUpdate()  : mixed

Handle the "updated" model event

asDate()  : Carbon

Return a timestamp as DateTime object with time set to 00:00:00.

asDateTime()  : Carbon

Return a timestamp as DateTime object.

asJson()  : string

Encode the given value as JSON.

asTimestamp()  : int

Return a timestamp as unix timestamp.

beforeCreate()  : mixed

Handle the "creating" model event

beforeDelete()  : mixed

Handle the "deleting" model event

beforeFetch()  : mixed

Handle the "fetching" model event

beforeSave()  : mixed

Handle the "saving" model event

beforeUpdate()  : mixed

Handle the "updating" model event

boot()  : void

The "booting" method of the model.

bootIfNotBooted()  : void

Check if the model needs to be booted and if so, do it.

bootNicerEvents()  : mixed

Bind some nicer events to this model, in the format of method overrides.

bootTraits()  : void

Boot all of the bootable traits on the model.

castAttribute()  : mixed

Cast an attribute to a native PHP type.

castAttributeAsJson()  : string

Cast the given attribute to JSON.

commitDeferredAfter()  : mixed

Internally used method to commit all deferred bindings after saving.

commitDeferredBefore()  : mixed

Internally used method to commit all deferred bindings before saving.

commitDeferredOfType()  : mixed

Internal method for committing deferred relations.

decrement()  : int

Decrement a column's value by a given amount.

emitterEventSortEvents()  : array<string|int, mixed>

Sort the listeners for a given event by priority.

extendableIsAccessible()  : bool

Checks if a property is accessible, property equivalent of `is_callable()`

extensionExtractMethods()  : void

Extracts the available methods from a behavior and adds it to the list of callable methods.

fillableFromArray()  : array<string|int, mixed>

Get the fillable attributes of a given array.

filterModelEventResults()  : mixed

Filter the model event results.

finishSave()  : void

Perform any actions that are necessary after the model is saved.

fireCustomModelEvent()  : mixed|null

Fire a custom model event for the given event.

fireModelEvent()  : mixed

Fire the given event for the model.

generatePassword()  : void

Assigns this user with a random password.

getArrayableAppends()  : array<string|int, mixed>

Get all of the appendable values that are arrayable.

getArrayableAttributes()  : array<string|int, mixed>

Get an attribute array of all arrayable attributes.

getArrayableItems()  : array<string|int, mixed>

Get an attribute array of all arrayable values.

getArrayableRelations()  : array<string|int, mixed>

Get an attribute array of all arrayable relations.

getArrayAttributeByKey()  : array<string|int, mixed>

Get an array attribute or return an empty array if it is not set.

getArrayAttributeWithValue()  : $this

Get an array attribute with the given key and value set.

getAttributeFromArray()  : mixed

Get an attribute from the $attributes array.

getCastType()  : string

Get the type of cast for a model attribute.

getDateFormat()  : string

Get the format for database stored dates.

getDeferrableRelationTypes()  : array<string|int, mixed>

Returns all possible relation types that can be deferred.

getDeferredBindingRecords()  : Collection

Returns any outstanding binding records for this model.

getKeyForSaveQuery()  : mixed

Get the primary key value for a save query.

getMorphs()  : array<string|int, mixed>

Get the polymorphic relationship columns.

getMutatorMethods()  : array<string|int, mixed>

Get all of the attribute mutator methods.

getRelationCaller()  : mixed

Finds the calling function name from the stack trace.

getRelationDefaults()  : array<string|int, mixed>

Returns default relation arguments for a given type.

getRelationshipFromMethod()  : mixed

Get a relationship value from a method.

getRelationValidationValue()  : mixed

Attachments validate differently to their simple values.

getValidationAttributes()  : array<string|int, mixed>

Returns the model data used for validation.

guessBelongsToManyRelation()  : string

Get the relationship name of the belongs to many.

guessBelongsToRelation()  : string

Guess the "belongs to" relationship name.

handleRelation()  : Relation

Looks for the relation and does the correct magic as Eloquent would require inside relation methods. For more information, read the documentation of the mentioned property.

hasChanges()  : bool

Determine if the given attributes were changed.

increment()  : int

Increment a column's value by a given amount.

incrementOrDecrement()  : int

Run the increment or decrement method on the model.

incrementOrDecrementAttributeValue()  : void

Increment the underlying attribute value and sync with original.

insertAndSetId()  : void

Insert the given attributes and set the ID on the model.

isDateAttribute()  : bool

Determine if the given attribute is a date or date castable.

isDateCastable()  : bool

Determine whether a value is Date / DateTime castable for inbound manipulation.

isGuardableColumn()  : bool

Determine if the given column is a valid, guardable column.

isJsonCastable()  : bool

Determine whether a value is JSON castable for inbound manipulation.

isStandardDateFormat()  : bool

Determine if the given value is a standard date format.

makeValidator()  : Validator

Instantiates the validator used by the validation process, depending if the class is being used inside or outside of Laravel. Optional connection string to make the validator use a different database connection than the default connection.

morphEagerTo()  : MorphTo

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

morphInstanceTo()  : MorphTo

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

mutateAttribute()  : mixed

Get the value of an attribute using its mutator.

mutateAttributeForArray()  : mixed

Get the value of an attribute using its mutator for array conversion.

newBaseQueryBuilder()  : Builder

Get a new query builder instance for the connection.

newBelongsTo()  : BelongsTo

Instantiate a new BelongsTo relationship.

newBelongsToMany()  : BelongsToMany

Instantiate a new BelongsToMany relationship.

newHasMany()  : HasMany

Instantiate a new HasMany relationship.

newHasManyThrough()  : HasManyThrough

Instantiate a new HasManyThrough relationship.

newHasOne()  : HasOne

Instantiate a new HasOne relationship.

newMorphMany()  : MorphMany

Instantiate a new MorphMany relationship.

newMorphOne()  : MorphOne

Instantiate a new MorphOne relationship.

newMorphTo()  : MorphTo

Instantiate a new MorphTo relationship.

newMorphToMany()  : MorphToMany

Instantiate a new HasManyThrough relationship.

newRelatedInstance()  : mixed

Create a new model instance for a related model.

originalIsEquivalent()  : bool

Determine if the new and old values for a given key are equivalent.

performDeleteOnModel()  : void

Perform the actual delete query on this model instance.

performDeleteOnRelations()  : void

Locates relations with delete flag and cascades the delete event.

performInsert()  : bool

Perform a model insert operation.

performRestoreOnRelations()  : void

Locates relations with softDelete flag and cascades the restore event.

performSoftDeleteOnRelations()  : void

Locates relations with softDelete flag and cascades the delete event.

performUpdate()  : bool

Perform a model update operation.

processRuleFieldNames()  : array<string|int, mixed>

Processes field names in a rule array.

processValidationRules()  : mixed

Process rules

processValidationUniqueRule()  : string

Rebuilds the unique validation rule to force for the existing ID

registerModelEvent()  : void

Register a model event with the dispatcher.

removeTableFromKey()  : string

Remove the table name from a given key.

runSoftDelete()  : void

Perform the actual delete query on this model instance.

saveInternal()  : bool

Save the model to the database. Is used by {@link save()} and {@link forceSave()}.

sendInvitation()  : void

Sends an invitation to the user using template "rainlab.user::mail.invite".

serializeDate()  : string

Prepare a date for array / JSON serialization.

setKeysForSaveQuery()  : Builder

Set the keys for a save update query.

setRelationValue()  : mixed

Sets a relation value directly from its attribute.

updateTimestamps()  : void

Update the creation and update timestamps.

validateRelationArgs()  : mixed

Validate relation supplied arguments.