User

Type
Class
Namespace
craft\elements
Inherits
craft\elements\User » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface, yii\web\IdentityInterface
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0

User represents a user element.

View source

Public Properties

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$adminboolean – Admin
$ancestorscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
$archivedboolean – Whether the element is archived
$attributesarray – Attribute values (name => value).
$authErrorstring, null – Auth error
$authKeystring – A key that is used to check the validity of a given identity ID.
$awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$childrencraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
$contentIdinteger, null – The element’s content row ID
$contentTablestring
$cooldownEndTimeDateTime, null
$cpEditUrlstring, null
$currentPasswordstring, null – Current password
$dateCreatedDateTime, null – The date that the element was created
$dateUpdatedDateTime, null – The date that the element was last updated
$descendantscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
$editorHtmlstring – The HTML for the editor HUD
$emailstring, null – Email
$enabledboolean – Whether the element is enabled
$enabledForSiteboolean – Whether the element is enabled for this site.
$errorsarray – Errors for all attributes or the specified attribute.
$fieldColumnPrefixstring
$fieldContextstring
$fieldLayoutcraft\models\FieldLayout, null
$fieldLayoutIdinteger, null – The element’s field layout ID
$fieldParamNamespacestring, null – The field param namespace
$fieldValuesarray – The field values (handle => value)
$firstErrorsarray – The first errors.
$firstNamestring, null – First name
$friendlyNamestring, null
$fullNamestring, null
$groupscraft\models\UserGroup[]
$hasDashboardboolean – Whether the user has a dashboard
$hasDescendantsboolean
$hasFreshContentboolean – Whether the element’s content is fresh
$idinteger, null – The element’s ID
$inheritorOnDeleteself, null – The user who should take over the user’s content if the user is deleted.
$invalidLoginCountinteger, null – Invalid login count
$isCurrentboolean
$isEditableboolean
$iteratorArrayIterator – An iterator for traversing the items in the list.
$lastInvalidLoginDateDateTime, null – Last invalid login date
$lastLoginAttemptIpstring, null – Last login attempt IP address.
$lastLoginDateDateTime, null – Last login date
$lastNamestring, null – Last name
$lastPasswordChangeDateDateTime, null – Last password change date
$levelinteger, null – The element’s level within its structure
$lftinteger, null – The element’s left position within its structure
$linkTwig_Markup, null
$lockedboolean – Locked
$lockoutDateDateTime, null – Lockout date
$namestring
$newPasswordstring, null – New password
$nextcraft\base\ElementInterface, null
$nextSiblingcraft\base\ElementInterface, null
$parentcraft\base\ElementInterface, null
$passwordstring, null – Password
$passwordResetRequiredboolean – Password reset required
$pendingboolean – Pending
$photocraft\elements\Asset, null
$photoIdinteger, null – Photo asset id
$photoUrlstring, null
$preferencesarray – The user’s preferences.
$preferredLanguagestring, null – The preferred language
$prevcraft\base\ElementInterface, null
$prevSiblingcraft\base\ElementInterface, null
$propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
$refstring, null
$remainingCooldownTimeDateInterval, null
$rgtinteger, null – The element’s right position within its structure
$rootinteger, null – The element’s structure’s root ID
$routemixed – The route that the request should use, or null if no special action should be taken
$scenariostring – The scenario that this model is in.
$searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
$serializedFieldValuesarray
$siblingscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
$sitecraft\models\Site
$siteIdinteger, null – The site ID the element is associated with
$slugstring, null – The element’s slug
$statusstring, null
$structureIdinteger, null – The element’s structure ID
$supportedSitesinteger[], array
$suspendedboolean – Suspended
$tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
$titlestring, null – The element’s title
$totalDescendantsinteger
$uidstring, null – The element’s UID
$unverifiedEmailstring, null – Unverified email
$uristring, null – The element’s URI
$uriFormatstring, null
$urlstring, null
$usernamestring, null – Username
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
$verificationCodestring, null – Verification code
$verificationCodeIssuedDateDateTime, null – Verification code issued date

$admin

Signature

public boolean $admin = false

$authError

Type
string, null

Auth error

View source

Signature

public string, null $authError = null

$authKey

Type
string
Access
Read-only

A key that is used to check the validity of a given identity ID.

View source

Signature

public string getAuthKey ( )

$cooldownEndTime

Type
DateTime, null
Access
Read-only

View source

Signature

public DateTime, null getCooldownEndTime ( )

$cpEditUrl

Type
string, null
Access
Read-only

View source

Signature

public string, null getCpEditUrl ( )

$currentPassword

Type
string, null

Current password

View source

Signature

public string, null $currentPassword = null

$editorHtml

Type
string
Access
Read-only

The HTML for the editor HUD

View source

Signature

public string getEditorHtml ( )

$email

Signature

public string, null $email = null

$fieldLayout

Signature

public craft\models\FieldLayout, null getFieldLayout ( )

$firstName

Type
string, null

First name

View source

Signature

public string, null $firstName = null

$friendlyName

Type
string, null
Access
Read-only

View source

Signature

public string, null getFriendlyName ( )

$fullName

Type
string, null
Access
Read-only

View source

Signature

public string, null getFullName ( )

$groups

Signature

public craft\models\UserGroup[] getGroups ( )
public void setGroups ( array $groups )

$hasDashboard

Type
boolean

Whether the user has a dashboard

View source

Signature

public boolean $hasDashboard = false

$inheritorOnDelete

Type
self, null

The user who should take over the user’s content if the user is deleted.

View source

Signature

public self, null $inheritorOnDelete = null

$invalidLoginCount

Type
integer, null

Invalid login count

View source

Signature

public integer, null $invalidLoginCount = null

$isCurrent

Type
boolean
Access
Read-only

View source

Signature

public boolean getIsCurrent ( )

$isEditable

Type
boolean
Access
Read-only

View source

Signature

public boolean getIsEditable ( )

$lastInvalidLoginDate

Type
DateTime, null

Last invalid login date

View source

Signature

public DateTime, null $lastInvalidLoginDate = null

$lastLoginAttemptIp

Type
string, null

Last login attempt IP address.

View source

Signature

public string, null $lastLoginAttemptIp = null

$lastLoginDate

Type
DateTime, null

Last login date

View source

Signature

public DateTime, null $lastLoginDate = null

$lastName

Type
string, null

Last name

View source

Signature

public string, null $lastName = null

$lastPasswordChangeDate

Type
DateTime, null

Last password change date

View source

Signature

public DateTime, null $lastPasswordChangeDate = null

$locked

Signature

public boolean $locked = false

$lockoutDate

Type
DateTime, null

Lockout date

View source

Signature

public DateTime, null $lockoutDate = null

$name

Type
string
Access
Read-only

View source

Signature

public string getName ( )

$newPassword

Type
string, null

New password

View source

Signature

public string, null $newPassword = null

$password

Type
string, null

Password

View source

Signature

public string, null $password = null

$passwordResetRequired

Type
boolean

Password reset required

View source

Signature

public boolean $passwordResetRequired = false

$pending

Signature

public boolean $pending = false

$photo

Signature

public craft\elements\Asset, null getPhoto ( )

$photoId

Type
integer, null

Photo asset id

View source

Signature

public integer, null $photoId = null

$photoUrl

Type
string, null
Access
Read-only

View source

Signature

public string, null getPhotoUrl ( \craft\elements\int $size = 100 )

$preferences

Type
array
Access
Read-only

The user’s preferences.

View source

Signature

public array getPreferences ( )

$preferredLanguage

Type
string, null
Access
Read-only

The preferred language

View source

Signature

public string, null getPreferredLanguage ( )

$ref

Type
string, null
Access
Read-only

View source

Signature

public string, null getRef ( )

$remainingCooldownTime

Type
DateInterval, null
Access
Read-only

View source

Signature

public DateInterval, null getRemainingCooldownTime ( )

$status

Type
string, null
Access
Read-only

View source

Signature

public string, null getStatus ( )

$suspended

Type
boolean

Suspended

View source

Signature

public boolean $suspended = false

$unverifiedEmail

Type
string, null

Unverified email

View source

Signature

public string, null $unverifiedEmail = null

$username

Type
string, null

Username

View source

Signature

public string, null $username = null

$verificationCode

Type
string, null

Verification code

View source

Signature

public string, null $verificationCode = null

$verificationCodeIssuedDate

Type
DateTime, null

Verification code issued date

View source

Signature

public DateTime, null $verificationCodeIssuedDate = null

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set.
__set()Sets the value of a component property.
__toString()Use the full name or username as the string representation.
__unset()Sets an object property to null.
actions()Returns the available element actions for a given source (if one is provided).
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.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterDelete()Performs actions after an element is deleted.
afterMoveInStructure()Performs actions after an element is moved within a structure.
afterSave()Performs actions after an element is saved.
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 attribute names.
authData()Returns the authentication data from a given auth key.
authenticate()Determines whether the user is allowed to be logged in with a given password.
beforeDelete()Performs actions before an element is deleted.
beforeMoveInStructure()Performs actions before an element is moved within a structure.
beforeSave()Performs actions before an element is saved.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
can()Returns whether the user has permission to perform a given action.
canGetProperty()Returns a value indicating whether a property can be read.
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().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
defaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
eagerLoadingMap()Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
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()Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll()Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findIdentity()Finds an identity by the given ID.
findIdentityByAccessToken()Finds an identity by the given token.
findOne()Returns a single element instance by a primary key or a set of element criteria parameters.
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.
getAncestors()Returns the element’s ancestors.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getAuthKey()Returns a key that can be used to check the validity of a given identity ID.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getChildren()Returns the element’s children.
getContentTable()Returns the name of the table this element’s content is stored in.
getCooldownEndTime()Returns the time when the user will be over their cooldown period.
getCpEditUrl()Returns the element’s CP edit URL.
getDescendants()Returns the element’s descendants.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEditorHtml()Returns the HTML for the element’s editor HUD.
getError()Returns the first error of the specified attribute.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFieldColumnPrefix()Returns the field column prefix this element’s content uses.
getFieldContext()Returns the field context this element’s content uses.
getFieldLayout()Returns the field layout used by this element.
getFieldParamNamespace()Returns the namespace used by custom field params on the request.
getFieldValue()Returns the value for a given field.
getFieldValues()Returns the element’s normalized custom field values, indexed by their handles.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getFriendlyName()Gets the user's first name or username.
getFullName()Returns the user's full name.
getGroups()Returns the user's groups.
getHasDescendants()Returns whether the element has descendants.
getHasFreshContent()Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHtmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the Control Panel.
getId()Returns the element’s ID.
getIsCurrent()Returns whether this is the current logged-in user.
getIsEditable()Returns whether the current user can edit the element.
getIterator()Returns an iterator for traversing the attributes in the model.
getLink()Returns an anchor pre-filled with this element’s URL and title.
getName()Returns the user's full name or username.
getNext()Returns the next element relative to this one, from a given set of criteria.
getNextSibling()Returns the element’s next sibling.
getParent()Returns the element’s parent.
getPhoto()Returns the user's photo.
getPhotoUrl()Returns the URL to the user's photo.
getPreference()Returns one of the user’s preferences by its key.
getPreferences()Returns the user’s preferences.
getPreferredLanguage()Returns the user’s preferred language, if they have one.
getPrev()Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()Returns the element’s previous sibling.
getRef()Returns the reference string to this element.
getRemainingCooldownTime()Returns the remaining cooldown time for this user, if they've entered their password incorrectly too many times.
getRoute()Returns the route that should be used when the element’s URI is requested.
getScenario()Returns the scenario that this model is used in.
getSearchKeywords()Returns the search keywords for a given search attribute.
getSerializedFieldValues()Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings()Returns all of the element’s siblings.
getSite()Returns the site the element is associated with.
getStatus()Returns the element’s status.
getSupportedSites()Returns the sites this element is associated with.
getTableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl()Returns the URL to the element’s thumbnail, if there is one.
getTotalDescendants()Returns the total number of descendants that the element has.
getUriFormat()Returns the URI format used to generate this element’s URI.
getUrl()Returns the element’s full URL.
getValidators()Returns all the validators declared in rules().
hasContent()Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).
hasEagerLoadedElements()Returns whether elements have been eager-loaded with a given handle.
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.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
hasShunned()Returns whether the user has shunned a given message.
hasStatuses()Returns whether elements of this type have statuses.
hasTitles()Returns whether elements of this type have traditional titles.
hasUris()Returns whether elements of this type can have their own slugs and URIs.
indexHtml()Returns the element index HTML.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAncestorOf()Returns whether this element is an ancestor of another one.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf()Returns whether this element is a direct child of another one.
isDescendantOf()Returns whether this element is a descendant of another one.
isFieldEmpty()Returns whether a field is empty.
isInGroup()Returns whether the user is in a specific group.
isLocalized()Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf()Returns whether this element is the direct next sibling of another one.
isParentOf()Returns whether this element is a direct parent of another one.
isPrevSiblingOf()Returns whether this element is the direct previous sibling of another one.
isSiblingOf()Returns whether this element is a sibling of another one.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
mergePreferences()Merges new user preferences with the existing ones, and returns the result.
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.
refHandle()Returns the handle that should be used to refer to this element type from reference tags.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
searchableAttributes()Defines which element attributes should be searchable.
setAttributes()Sets the attribute values in a massive way.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
setFieldParamNamespace()Sets the namespace used by custom field params on the request.
setFieldValue()Sets the value for a given field.
setFieldValues()Sets the element’s custom field values.
setFieldValuesFromRequest()Sets the element’s custom field values, when the values have come from post data.
setGroups()Sets an array of User element objects on the user.
setNext()Sets the default next element.
setParent()Sets the element’s parent.
setPhoto()Sets the entry's author.
setPrev()Sets the default previous element.
setScenario()Sets the scenario for the model.
sortOptions()Returns the sort options for the element type.
sources()Returns the source definitions that elements of this type may belong to.
statuses()Returns all of the possible statuses that elements of this type may have.
tableAttributes()Defines all of the available columns that can be shown in table views.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateAuthKey()Validates the given auth key.
validateCustomFieldAttribute()Calls a custom validation function on a custom field.
validateCustomFieldContentSize()Validates that the content size is going to fit within the field’s database column.
validateMultiple()Validates multiple models.
validateUnverifiedEmail()Validates the unverifiedEmail value is unique.

__toString()

Use the full name or username as the string representation.

View source

Returns

string

Signature

public string __toString ( )

afterSave()

Performs actions after an element is saved.

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

Throws

Signature

public void afterSave ( \craft\elements\bool $isNew )

attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source

Returns

array – Attribute labels (name => label)

Signature

public array attributeLabels ( )

attributes()

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source

Returns

array – List of attribute names.

Signature

public array attributes ( )

authData()

Returns the authentication data from a given auth key.

View source

Arguments

Returns

array, null – The authentication data, or null if it was invalid.

Signature

public static array, null authData ( \craft\elements\string $authKey )

authenticate()

Determines whether the user is allowed to be logged in with a given password.

View source

Arguments

  • $password (string) – The user's plain text passwerd.

Returns

boolean

Signature

public boolean authenticate ( \craft\elements\string $password )

beforeDelete()

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

Signature

public boolean beforeDelete ( )

can()

Returns whether the user has permission to perform a given action.

View source

Arguments

Returns

boolean

Signature

public boolean can ( \craft\elements\string $permission )

datetimeAttributes()

Returns the names of any attributes that should hold DateTime values.

View source

Returns

string[]

Signature

public string[] datetimeAttributes ( )

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

Signature

public static string displayName ( )

eagerLoadingMap()

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

  • elementType – the fully qualified class name of the element type that should be eager-loaded
  • map – an array of element ID mappings, where each element is a sub-array with source and target keys.
  • criteria(optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.

View source

Arguments

  • $sourceElements (craft\base\ElementInterface[]) – An array of the source elements
  • $handle (string) – The property handle used to identify which target elements should be included in the map

Returns

array, false – The eager-loading element ID mappings, or false if no mappings exist

Signature

public static array, false eagerLoadingMap ( array $sourceElements, \craft\elements\string $handle )

extraFields()

Returns the list of fields that can be expanded further and returned by toArray().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

Signature

public array extraFields ( )

find()

Creates an craft\elements\db\ElementQueryInterface instance for query purpose.

The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface before one() or all() is called to return populated \craft\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->limit(50);
    }
}

View source

Returns

craft\elements\db\UserQuery – The newly created craft\elements\db\UserQuery instance.

Signature

public static craft\elements\db\UserQuery find ( )

findIdentity()

Finds an identity by the given ID.

View source

Arguments

Returns

yii\web\IdentityInterface – The identity object that matches the given ID. Null should be returned if such an identity cannot be found or the identity is not in an active state (disabled, deleted, etc.)

Signature

public static yii\web\IdentityInterface findIdentity ( $id )

findIdentityByAccessToken()

Finds an identity by the given token.

View source

Arguments

  • $token (mixed) – The token to be looked for
  • $type (mixed) – The type of the token. The value of this parameter depends on the implementation. For example, yii\filters\auth\HttpBearerAuth will set this parameter to be yii\filters\auth\HttpBearerAuth.

Returns

yii\web\IdentityInterface – The identity object that matches the given token. Null should be returned if such an identity cannot be found or the identity is not in an active state (disabled, deleted, etc.)

Signature

public static yii\web\IdentityInterface findIdentityByAccessToken ( $token, $type = null )

getAuthKey()

Returns a key that can be used to check the validity of a given identity ID.

The key should be unique for each individual user, and should be persistent so that it can be used to check the validity of the user identity.

The space of such keys should be big enough to defeat potential identity attacks.

This is required if craft\elements\User::enableAutoLogin is enabled.

View source

Returns

string – A key that is used to check the validity of a given identity ID.

Signature

public string getAuthKey ( )

getCooldownEndTime()

Returns the time when the user will be over their cooldown period.

View source

Returns

DateTime, null

Signature

public DateTime, null getCooldownEndTime ( )

getCpEditUrl()

Returns the element’s CP edit URL.

View source

Returns

string, null

Signature

public string, null getCpEditUrl ( )

getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source

Returns

string – The HTML for the editor HUD

Signature

public string getEditorHtml ( )

getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

Signature

public craft\models\FieldLayout, null getFieldLayout ( )

getFriendlyName()

Gets the user's first name or username.

View source

Returns

string, null

Signature

public string, null getFriendlyName ( )

getFullName()

Returns the user's full name.

View source

Returns

string, null

Signature

public string, null getFullName ( )

getGroups()

Returns the user's groups.

View source

Returns

craft\models\UserGroup[]

Signature

public craft\models\UserGroup[] getGroups ( )

getIsCurrent()

Returns whether this is the current logged-in user.

View source

Returns

boolean

Signature

public boolean getIsCurrent ( )

getIsEditable()

Returns whether the current user can edit the element.

View source

Returns

boolean

Signature

public boolean getIsEditable ( )

getName()

Returns the user's full name or username.

View source

Returns

string

Signature

public string getName ( )

getPhoto()

Returns the user's photo.

View source

Returns

craft\elements\Asset, null

Throws

Signature

public craft\elements\Asset, null getPhoto ( )

getPhotoUrl()

DEPRECATED

Deprecated in 3.0. Use getPhoto().getUrl() instead.

Returns the URL to the user's photo.

View source

Arguments

  • $size (integer) – The width and height the photo should be sized to

Returns

string, null

Signature

public string, null getPhotoUrl ( \craft\elements\int $size = 100 )

getPreference()

Returns one of the user’s preferences by its key.

View source

Arguments

  • $key (string) – The preference’s key
  • $default (mixed) – The default value, if the preference hasn’t been set

Returns

mixed – The user’s preference

Signature

public mixed getPreference ( \craft\elements\string $key, $default = null )

getPreferences()

Returns the user’s preferences.

View source

Returns

array – The user’s preferences.

Signature

public array getPreferences ( )

getPreferredLanguage()

Returns the user’s preferred language, if they have one.

View source

Returns

string, null – The preferred language

Signature

public string, null getPreferredLanguage ( )

getRef()

Returns the reference string to this element.

View source

Returns

string, null

Signature

public string, null getRef ( )

getRemainingCooldownTime()

Returns the remaining cooldown time for this user, if they've entered their password incorrectly too many times.

View source

Returns

DateInterval, null

Signature

public DateInterval, null getRemainingCooldownTime ( )

getStatus()

Returns the element’s status.

View source

Returns

string, null

Signature

public string, null getStatus ( )

getThumbUrl()

Returns the URL to the element’s thumbnail, if there is one.

View source

Arguments

Returns

string, null

Signature

public string, null getThumbUrl ( \craft\elements\int $size )

hasContent()

Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).

View source

Returns

boolean – Whether elements of this type will be storing any data in the content table.

Signature

public static boolean hasContent ( )

hasShunned()

Returns whether the user has shunned a given message.

View source

Arguments

Returns

boolean

Signature

public boolean hasShunned ( \craft\elements\string $message )

hasStatuses()

Returns whether elements of this type have statuses.

If this returns true, the element index template will show a Status menu by default, and your elements will get status indicator icons next to them. Use statuses() to customize which statuses the elements might have.

View source

Returns

boolean – Whether elements of this type have statuses.

Signature

public static boolean hasStatuses ( )

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Signature

public void init ( )

isInGroup()

Returns whether the user is in a specific group.

View source

Arguments

Returns

boolean

Signature

public boolean isInGroup ( $group )

mergePreferences()

Merges new user preferences with the existing ones, and returns the result.

View source

Arguments

  • $preferences (array) – The new preferences

Returns

array – The user’s new preferences.

Signature

public array mergePreferences ( array $preferences )

refHandle()

Returns the handle that should be used to refer to this element type from reference tags.

View source

Returns

string, null – The reference handle, or null if the elemnet type doesn’t support reference tags

Signature

public static string, null refHandle ( )

rules()

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

  • attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
  • validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
  • on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
  • additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\elements\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\elements\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source

Returns

array – Validation rules

Signature

public array rules ( )

scenarios()

Returns a list of scenarios and the corresponding active attributes.

An active attribute is one that is subject to validation in the current scenario. The returned array should be in the following format:

[
    'scenario1' => ['attribute11', 'attribute12', ...],
    'scenario2' => ['attribute21', 'attribute22', ...],
    ...
]

By default, an active attribute is considered safe and can be massively assigned. If an attribute should NOT be massively assigned (thus considered unsafe), please prefix the attribute with an exclamation character (e.g. '!rank').

The default implementation of this method will return all scenarios found in the rules() declaration. A special scenario named SCENARIO_DEFAULT will contain all attributes found in the rules(). Each scenario will be associated with the attributes that are being validated by the validation rules that apply to the scenario.

View source

Returns

array – A list of scenarios and the corresponding active attributes.

Signature

public array scenarios ( )

setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source

Arguments

Signature

public void setEagerLoadedElements ( \craft\elements\string $handle, array $elements )

setGroups()

Sets an array of User element objects on the user.

View source

Arguments

Signature

public void setGroups ( array $groups )

setPhoto()

Sets the entry's author.

View source

Arguments

Signature

public void setPhoto ( craft\elements\Asset $photo = null )

statuses()

Returns all of the possible statuses that elements of this type may have.

This method will be called when populating the Status menu on element indexes, for element types whose hasStatuses() method returns true. It will also be called when craft\elements\db\ElementQuery is querying for elements, to ensure that its “status” parameter is set to a valid status. It should return an array whose keys are the status values, and values are the human-facing status labels, or an array with the following keys:

  • label – The human-facing status label.
  • color – The status color (green, orange, red, yellow, pink, purple, blue, turquoise, light, grey, black, or white) You can customize the database query condition that should be applied for your custom statuses from craft\elements\db\ElementQuery::statusCondition().

View source

Returns

array

Signature

public static array statuses ( )

validateAuthKey()

Validates the given auth key.

This is required if craft\elements\User::enableAutoLogin is enabled.

View source

Arguments

  • $authKey (string) – The given auth key

Returns

boolean – Whether the given auth key is valid.

Signature

public boolean validateAuthKey ( $authKey )

validateUnverifiedEmail()

Validates the unverifiedEmail value is unique.

View source

Arguments

Signature

public void validateUnverifiedEmail ( \craft\elements\string $attribute, $params, yii\validators\InlineValidator $validator )

Protected Methods

MethodDescription
defineActions()Defines the available element actions for a given source (if one is provided).
defineDefaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
defineSearchableAttributes()Defines which element attributes should be searchable.
defineSortOptions()Returns the sort options for the element type.
defineSources()Defines the sources that elements of this type may belong to.
defineTableAttributes()Defines all of the available columns that can be shown in table views.
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.
fieldByHandle()Returns the field with a given handle.
fieldLayoutFields()Returns each of this element’s fields.
findByCondition()Finds Element instance(s) by the given condition.
htmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the Control Panel.
normalizeFieldValue()Normalizes a field’s value.
prepElementQueryForTableAttribute()Preps the element criteria for a given table attribute
resolveFields()Determines which fields can be returned by toArray().
route()Returns the route that should be used when the element’s URI is requested.
tableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.

defineActions()

Defines the available element actions for a given source (if one is provided).

View source

Arguments

  • $source (string, null) – The selected source’s key, if any.

Returns

array – The available element actions.

Signature

protected static array defineActions ( \craft\elements\string $source = null )

defineDefaultTableAttributes()

Returns the list of table attribute keys that should be shown by default.

View source

Arguments

  • $source (string) – The selected source’s key

Returns

string[] – The table attributes.

Signature

protected static string[] defineDefaultTableAttributes ( \craft\elements\string $source )

defineSearchableAttributes()

Defines which element attributes should be searchable.

View source

Returns

string[] – The element attributes that should be searchable

Signature

protected static string[] defineSearchableAttributes ( )

defineSortOptions()

Returns the sort options for the element type.

View source

Returns

array – The attributes that elements can be sorted by

Signature

protected static array defineSortOptions ( )

defineSources()

Defines the sources that elements of this type may belong to.

View source

Arguments

  • $context (string, null) – The context ('index' or 'modal').

Returns

array – The sources.

Signature

protected static array defineSources ( \craft\elements\string $context = null )

defineTableAttributes()

Defines all of the available columns that can be shown in table views.

View source

Returns

array – The table attributes.

Signature

protected static array defineTableAttributes ( )

tableAttributeHtml()

Returns the HTML that should be shown for a given attribute in Table View.

View source

Arguments

  • $attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute in Table View.

Signature

protected string tableAttributeHtml ( \craft\elements\string $attribute )

Constants

ConstantDescription
AUTH_ACCOUNT_COOLDOWN
AUTH_ACCOUNT_LOCKED
AUTH_ACCOUNT_SUSPENDED
AUTH_INVALID_CREDENTIALS
AUTH_NO_CP_ACCESS
AUTH_NO_CP_OFFLINE_ACCESS
AUTH_NO_SITE_OFFLINE_ACCESS
AUTH_PASSWORD_RESET_REQUIRED
AUTH_PENDING_VERIFICATION
IMPERSONATE_KEY
SCENARIO_DEFAULTThe name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
SCENARIO_PASSWORD
SCENARIO_REGISTRATION
STATUS_ACTIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED
STATUS_LOCKED
STATUS_PENDING
STATUS_SUSPENDED

Events

EVENT_BEFORE_AUTHENTICATE

Type
craft\events\AuthenticateUserEvent

The event that is triggered before a user is authenticated.

You may set craft\events\AuthenticateUserEvent::isValid to false to prevent the user from getting authenticated