Skip to content

User

Type
Class
Namespace
craft\records
Inherits
craft\records\User » craft\db\ActiveRecord » yii\db\ActiveRecord » yii\db\BaseActiveRecord » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface, yii\db\ActiveRecordInterface
Uses traits
yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0.0

Class User record.

View source

Public Properties

PropertyDescription
activeboolean – Active
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
adminboolean – Admin
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
dateCreatedDateTime, string, null – Date created
dateUpdatedDateTime, string, null – Date updated
dirtyAttributesarray – The changed attribute values (name-value pairs).
elementcraft\records\Element – Element
emailstring, null – Email
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
firstNamestring, null – First name
fullNamestring, null
groupscraft\records\UserGroup[] – User groups
hasDashboardboolean – Whether the user has a dashboard
idinteger – ID
invalidLoginCountinteger, null – Invalid login count
invalidLoginWindowStartstring, null – Invalid login window start
isNewRecordboolean – Whether the record is new and should be inserted when calling save().
iteratorArrayIterator – An iterator for traversing the items in the list.
lastInvalidLoginDatestring, null – Last invalid login date
lastLoginAttemptIpstring, null – Last login attempt IP
lastLoginDatestring, null – Last login date
lastNamestring, null – Last name
lastPasswordChangeDatestring, null – Last password change date
lockedboolean – Locked
lockoutDatestring, null – Lockout date
oldAttributesarray – The old attribute values (name-value pairs).
oldPrimaryKeymixed – The old primary key value.
passwordstring, null – Password
passwordResetRequiredboolean – Password reset required
pendingboolean – Pending
photoIdinteger – Photo ID
primaryKeymixed – The primary key value.
relatedRecordsarray – An array of related records indexed by relation names.
scenariostring – The scenario that this model is in.
sessionscraft\records\Session[] – Sessions
suspendedboolean – Suspended
uidstring – UUID
unverifiedEmailstring, null – Unverified email
usernamestring, null – Username
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
verificationCodestring, null – Verification code
verificationCodeIssuedDatestring, null – Verification code issued date

active

Type
boolean
Default value
null

Active

View source

admin

Type
boolean
Default value
null

Admin

View source

element

Type
craft\records\Element
Default value
null

Element

View source

email

Type
string, null
Default value
null

Email

View source

firstName

Type
string, null
Default value
null

First name

View source

fullName

Type
string, null
Default value
null

View source

groups

Type
craft\records\UserGroup[]
Default value
null

User groups

View source

hasDashboard

Type
boolean
Default value
null

Whether the user has a dashboard

View source

id

Type
integer
Default value
null

ID

View source

invalidLoginCount

Type
integer, null
Default value
null

Invalid login count

View source

invalidLoginWindowStart

Type
string, null
Default value
null

Invalid login window start

View source

lastInvalidLoginDate

Type
string, null
Default value
null

Last invalid login date

View source

lastLoginAttemptIp

Type
string, null
Default value
null

Last login attempt IP

View source

lastLoginDate

Type
string, null
Default value
null

Last login date

View source

lastName

Type
string, null
Default value
null

Last name

View source

lastPasswordChangeDate

Type
string, null
Default value
null

Last password change date

View source

locked

Type
boolean
Default value
null

Locked

View source

lockoutDate

Type
string, null
Default value
null

Lockout date

View source

password

Type
string, null
Default value
null

Password

View source

passwordResetRequired

Type
boolean
Default value
null

Password reset required

View source

pending

Type
boolean
Default value
null

Pending

View source

photoId

Type
integer
Default value
null

Photo ID

View source

sessions

Type
craft\records\Session[]
Default value
null

Sessions

View source

suspended

Type
boolean
Default value
null

Suspended

View source

unverifiedEmail

Type
string, null
Default value
null

Unverified email

View source

username

Type
string, null
Default value
null

Username

View source

verificationCode

Type
string, null
Default value
null

Verification code

View source

verificationCodeIssuedDate

Type
string, null
Default value
null

Verification code issued date

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()PHP getter magic method.
__isset()Checks if a property value is null.
__set()PHP setter magic method.
__unset()Sets a component property to be null.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
afterDelete()This method is invoked after deleting a record.
afterFind()This method is called when the AR object is created and populated with the query result.
afterRefresh()This method is called when the AR object is refreshed.
afterSave()This method is called at the end of inserting or updating a record.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of all attribute names of the model.
beforeDelete()This method is invoked before deleting a record.
beforeSave()This method is called at the beginning of inserting or updating a record.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetOldAttribute()Returns if the old named attribute can be set.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
delete()Deletes the table row corresponding to this active record.
deleteAll()Deletes rows in the table using the provided conditions.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
equals()Returns a value indicating whether the given active record is the same as the current one.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
find()
findAll()Returns a list of active record models that match the specified primary key value(s) or a set of column values.
findBySql()See yii\db\ActiveRecord::findBySql() for more info.
findOne()Returns a single active record model instance by a primary key or an array of column values.
findTrashed()
findWithTrashed()
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAttribute()Returns the named attribute value.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getDb()Returns the database connection used by this AR class.
getDirtyAttributes()Returns the attribute values that have been modified since they are loaded or saved most recently.
getElement()Returns the user’s element.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getGroups()Returns the user’s groups.
getIsNewRecord()Returns a value indicating whether the current record is new.
getIterator()Returns an iterator for traversing the attributes in the model.
getOldAttribute()Returns the old value of the named attribute.
getOldAttributes()Returns the old attribute values.
getOldPrimaryKey()Returns the old primary key value(s).
getPrimaryKey()Returns the primary key value(s).
getRelatedRecords()Returns all populated related records.
getRelation()Returns the relation object with the specified name.
getScenario()Returns the scenario that this model is used in.
getSessions()Returns the user’s sessions.
getTableSchema()Returns the schema information of the DB table associated with this AR class.
getValidators()Returns all the validators declared in rules().
hasAttribute()Returns a value indicating whether the model has an attribute with the specified name.
hasErrors()Returns a value indicating whether there is any validation error.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMany()See yii\db\BaseActiveRecord::hasMany() for more info.
hasMethod()Returns a value indicating whether a method is defined.
hasOne()See yii\db\BaseActiveRecord::hasOne() for more info.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
insert()Inserts a row into the associated database table using the attribute values of this record.
instance()Returns static class instance, which can be used to obtain meta information.
instantiate()Creates an active record instance.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeChanged()Returns a value indicating whether the named attribute has been changed.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isPrimaryKey()Returns a value indicating whether the given set of attributes represents the primary key for this model.
isRelationPopulated()Check whether the named relation has been populated with records.
isTransactional()Returns a value indicating whether the specified operation is transactional in the current scenario.
link()Establishes the relationship between two models.
load()Populates the model with input data.
loadDefaultValues()Loads default values from database table schema.
loadMultiple()Populates a set of models with the data from end user.
loadRelations()Eager loads related models for the already loaded primary model.
loadRelationsFor()Eager loads related models for the already loaded primary models.
markAttributeDirty()Marks an attribute dirty.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
optimisticLock()Returns the name of the column that stores the lock version for implementing optimistic locking.
populateRecord()Populates an active record object using a row of data from the database/storage.
populateRelation()Populates the named relation with the related records.
primaryKey()Returns the primary key name(s) for this AR class.
refresh()Repopulates this active record with the latest data.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
save()Saves the current record.
scenarios()Returns a list of scenarios and the corresponding active attributes.
setAttribute()Sets the named attribute value.
setAttributes()Sets the attribute values in a massive way.
setIsNewRecord()Sets the value indicating whether the record is new.
setOldAttribute()Sets the old value of the named attribute.
setOldAttributes()Sets the old attribute values.
setScenario()Sets the scenario for the model.
tableName()Declares the name of the database table associated with this AR class.
toArray()Converts the model into an array.
transactions()Declares which DB operations should be performed within a transaction in different scenarios.
trigger()Triggers an event.
unlink()Destroys the relationship between two models.
unlinkAll()Destroys the relationship in current model.
update()Saves the changes to this active record into the associated database table.
updateAll()Updates the whole table using the provided attribute values and conditions.
updateAllCounters()Updates the whole table using the provided counter changes and conditions.
updateAttributes()Updates the specified attributes.
updateCounters()Updates one or several counter columns for the current AR object.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

find()

View source

Returns

craft\db\ActiveQuery

findTrashed()

View source

Returns

craft\db\ActiveQuery

findWithTrashed()

View source

Returns

craft\db\ActiveQuery

getElement()

Returns the user’s element.

View source

Returns

yii\db\ActiveQueryInterface – The relational query object.

getGroups()

Returns the user’s groups.

View source

Returns

yii\db\ActiveQueryInterface

getSessions()

Returns the user’s sessions.

View source

Returns

yii\db\ActiveQueryInterface – The relational query object.

tableName()

Declares the name of the database table associated with this AR class.

By default this method returns the class name as the table name by calling yii\helpers\Inflector::camel2id() with prefix yii\db\Connection::$tablePrefix. For example if yii\db\Connection::$tablePrefix is tbl_, Customer becomes tbl_customer, and OrderItem becomes tbl_order_item. You may override this method if the table is not named after this convention.

View source

Returns

string – The table name

Protected Methods

MethodDescription
createRelationQuery()Creates a query instance for has-one or has-many relation.
deleteInternal()Deletes an ActiveRecord without considering transaction.
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
insertInternal()Inserts an ActiveRecord into DB without considering transaction.
prepareForDb()Sets the dateCreated, dateUpdated, and uid attributes on the record.
refreshInternal()Repopulates this active record with the latest data from a newly fetched instance.
resolveFields()Determines which fields can be returned by toArray().
updateInternal()

Constants

ConstantDescription
OP_ALLAll three operations: insert, update, delete.
OP_DELETEThe delete operation. This is mainly used when overriding transactions() to specify which operations are transactional.
OP_INSERTThe insert operation. This is mainly used when overriding transactions() to specify which operations are transactional.
OP_UPDATEThe update operation. This is mainly used when overriding transactions() to specify which operations are transactional.
SCENARIO_DEFAULTThe name of the default scenario.