UserModel

Type

Class

Namespace

Craft

Inherits

Craft\UserModel » Craft\BaseElementModel » Craft\BaseModel » CModel (opens new window) » CComponent (opens new window)

Implements

ArrayAccess (opens new window), IteratorAggregate (opens new window)

Since

1.0

User model class.

See also http://craftcms.com

View source (opens new window)

Protected Properties

Property	Description
$classSuffix	string (opens new window)
$elementType	string (opens new window)
$strictAttributes	boolean (opens new window) – Whether this model should be strict about only allowing values to be set on defined attributes

$elementType

Type

string (opens new window)

View source (opens new window)

Signature

protected string $elementType = \Craft\ElementType::User

Public Methods

Method	Description
__call()	Magic __call() method, used for chain-setting attribute values.
__construct()	Constructor
__get()	Getter
__isset()	Treats custom fields as properties.
__set()	PHP setter magic method.
__toString()	Use the full name or username as the string representation.
__unset() (opens new window)	Sets a component property to be null.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
asa() (opens new window)	Returns the named behavior object.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attachEventHandler() (opens new window)	Attaches an event handler to an event.
attributeLabels()	Returns the attribute labels.
attributeNames()	Returns the list of this model's attribute names.
behaviors() (opens new window)	Returns a list of behaviors that this model should behave as.
can()	Returns whether the user has permission to perform a given action.
canGetProperty() (opens new window)	Determines whether a property can be read.
canSetProperty() (opens new window)	Determines whether a property can be set.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
copy()	Returns a copy of this model.
createValidators() (opens new window)	Creates validator objects based on the specification in {@link rules}.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
detachEventHandler() (opens new window)	Detaches an existing event handler.
disableBehavior() (opens new window)	Disables an attached behavior.
disableBehaviors() (opens new window)	Disables all behaviors attached to this component.
enableBehavior() (opens new window)	Enables an attached behavior.
enableBehaviors() (opens new window)	Enables all behaviors attached to this component.
evaluateExpression() (opens new window)	Evaluates a PHP expression or callback under the context of this component.
generateAttributeLabel()	Generates a user friendly attribute label.
getAllErrors()	Returns all errors in a single, flattened list, devoid of attribute names.
getAncestors()	Returns the element's ancestors.
getAttribute()	Gets an attribute’s value.
getAttributeConfigs()	Returns this model's normalized attribute configs.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributes()	Returns an array of attribute values.
getChildren()	Returns the element's children.
getClassHandle()	Get the class name, sans namespace and suffix.
getContent()	Returns the content for the element.
getContentFromPost()	Returns the raw content from the post data, before it was passed through {@link prepValueFromPost()}.
getContentPostLocation()	Returns the location in POST that the content was pulled from.
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 some eager-loaded elements on a given handle.
getElementType()	Returns the type of element this is.
getError() (opens new window)	Returns the first error of the specified attribute.
getErrors() (opens new window)	Returns the errors for all attribute or a single attribute.
getEventHandlers() (opens new window)	Returns the list of attached event handlers for an event.
getExtraAttributeNames()	Returns a list of the names of the extra attributes that have been saved on this model, if it's not strict.
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.
getFieldValue()	Returns the prepped content for a given field.
getFriendlyName()	Gets the user's first name or username.
getFullName()	Gets the user's full name.
getGroups()	Returns the user's groups.
getHasFreshContent()	Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getLink()	Returns an anchor pre-filled with this element's URL and title.
getLocales()	Returns the locale IDs this element is available in.
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()	Get the element's parent.
getParents()	Returns a new ElementCriteriaModel prepped to return this element's same-type parents.
getPhotoUrl()	Returns the URL to the user's photo.
getPrev()	Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()	Returns the element's previous sibling.
getRawContent()	Returns the raw content saved on this entity.
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.
getSafeAttributeNames() (opens new window)	Returns the attribute names that are safe to be massively assigned.
getScenario() (opens new window)	Returns the scenario that this model is used in.
getSiblings()	Returns all of the element's siblings.
getStatus()	Returns the element's status.
getThumbUrl()	Returns the URL to the element's thumbnail, if there is one.
getTitle()	Returns the element's title.
getTotalDescendants()	Returns the total number of descendants that the element has.
getUrl()	Returns the element's full URL.
getUrlFormat()	Returns the URL format used to generate this element's URL.
getValidatorList() (opens new window)	Returns all the validators declared in the model.
getValidators() (opens new window)	Returns the validators applicable to the current {@link scenario}.
hasDescendants()	Returns whether the element has descendants.
hasEagerLoadedElements()	Returns whether elements have been eager-loaded with a given handle.
hasErrors() (opens new window)	Returns a value indicating whether there is any validation error.
hasEvent() (opens new window)	Determines whether an event is defined.
hasEventHandler() (opens new window)	Checks whether the named event has attached handlers.
hasProperty() (opens new window)	Determines whether a property is defined.
hasShunned()	Returns whether the user has shunned a given message.
isAncestorOf()	Returns whether this element is an ancestor of another one.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf()	Returns whether this element is a direct child of another one.
isCurrent()	Returns whether this is the current logged-in user.
isDescendantOf()	Returns whether this element is a descendant of another one.
isEditable()	Returns whether the current user can edit the element.
isInGroup()	Returns whether the user is in a specific group.
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.
offsetExists()	Treats custom fields as array offsets.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Unsets the element at the specified offset.
onAfterConstruct() (opens new window)	This event is raised after the model instance is created by new operator.
onAfterValidate() (opens new window)	This event is raised after the validation is performed.
onBeforeValidate() (opens new window)	This event is raised before the validation is performed.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
populateModel()	Populates a new model instance with a given set of attributes.
populateModels()	Mass-populates models based on an array of attribute arrays.
raiseEvent() (opens new window)	Raises an event.
rules()	Returns this model's validation rules.
setActive()	Sets a user's status to active.
setAttribute()	Sets an attribute's value.
setAttributes()	Sets multiple attribute values at once.
setContent()	Sets the content for the element.
setContentFromPost()	Sets the content from post data, calling prepValueFromPost() on the field types.
setContentPostLocation()	Sets the location in POST that the content was pulled from.
setEagerLoadedElements()	Sets some eager-loaded elements on a given handle.
setGroups()	Sets an array of {@link UserGroupModel} objects on the user.
setNext()	Sets the default next element.
setParent()	Sets the element's parent.
setPrev()	Sets the default previous element.
setRawPostContent()	Sets a field’s raw post content.
setScenario() (opens new window)	Sets the scenario for the model.
unsetAttributes() (opens new window)	Sets the attributes to be null.
validate()	Validates all of the attributes for the current Model. Any attributes that fail validation will additionally get logged to the craft/storage/runtime/logs folder with a level of LogLevel::Warning.

__toString()

Use the full name or username as the string representation.

View source (opens new window)

Returns

string (opens new window)

Signature

public string __toString ( )

can()

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

View source (opens new window)

Arguments

• $permission (string (opens new window))

Returns

boolean (opens new window)

Signature

public boolean can ( $permission )

getCooldownEndTime()

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

View source (opens new window)

Returns

Craft\DateTime, null (opens new window)

Signature

public Craft\DateTime, null getCooldownEndTime ( )

getCpEditUrl()

Returns the element's CP edit URL.

BaseElementModel::getCpEditUrl()

View source (opens new window)

Returns

string (opens new window), false (opens new window)

Signature

public string, false getCpEditUrl ( )

getFriendlyName()

Gets the user's first name or username.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

Signature

public string, null getFriendlyName ( )

getFullName()

Gets the user's full name.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

Signature

public string, null getFullName ( )

getGroups()

Returns the user's groups.

View source (opens new window)

Arguments

• $indexBy (string (opens new window), null (opens new window))

Returns

array (opens new window)

Signature

public array getGroups ( $indexBy = null )

getName()

Returns the user's full name or username.

View source (opens new window)

Returns

string (opens new window)

Signature

public string getName ( )

getPhotoUrl()

Returns the URL to the user's photo.

View source (opens new window)

Arguments

• $size (integer (opens new window))

Returns

string (opens new window), null (opens new window)

Signature

public string, null getPhotoUrl ( $size = 100 )

getRef()

Returns the reference string to this element.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

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 (opens new window)

Returns

Craft\DateInterval, null (opens new window)

Signature

public Craft\DateInterval, null getRemainingCooldownTime ( )

getStatus()

Returns the element's status.

BaseElementModel::getStatus()

View source (opens new window)

Returns

string (opens new window), null (opens new window)

Signature

public string, null getStatus ( )

getThumbUrl()

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

BaseElementModel::getThumbUrl()

View source (opens new window)

Arguments

• $size (integer (opens new window))

Returns

false (opens new window), null (opens new window), string (opens new window)

Signature

public false, null, string getThumbUrl ( $size = 100 )

hasShunned()

Returns whether the user has shunned a given message.

View source (opens new window)

Arguments

• $message (string (opens new window))

Returns

boolean (opens new window)

Signature

public boolean hasShunned ( $message )

isCurrent()

Returns whether this is the current logged-in user.

View source (opens new window)

Returns

boolean (opens new window)

Signature

public boolean isCurrent ( )

isEditable()

Returns whether the current user can edit the element.

BaseElementModel::isEditable()

View source (opens new window)

Returns

boolean (opens new window)

Signature

public boolean isEditable ( )

isInGroup()

Returns whether the user is in a specific group.

View source (opens new window)

Arguments

• $group (mixed) – The user group model, its handle, or ID.

Returns

boolean (opens new window)

Signature

public boolean isInGroup ( $group )

populateModel()

Populates a new model instance with a given set of attributes.

BaseModel::populateModel()

BaseModel::populateModel()

View source (opens new window)

Arguments

• $attributes (mixed)

Returns

Craft\UserModel

Signature

public static Craft\UserModel populateModel ( $attributes )

setActive()

Sets a user's status to active.

View source (opens new window)

Signature

public void setActive ( )

setGroups()

Sets an array of {@link UserGroupModel} objects on the user.

View source (opens new window)

Arguments

• $groups – An array of {@link UserGroupModel} objects.

Returns

null (opens new window)

Signature

public null setGroups ( $groups )

validate()

Validates all of the attributes for the current Model. Any attributes that fail validation will additionally get logged to the craft/storage/runtime/logs folder with a level of LogLevel::Warning. In addition, we check that the username does not have any whitespace in it.

View source (opens new window)

Arguments

• $attributes (null (opens new window))
• $clearErrors (boolean (opens new window))

Returns

boolean (opens new window), null (opens new window)

Signature

public boolean, null validate ( $attributes = null, $clearErrors = true )

Protected Methods

Method	Description
afterConstruct() (opens new window)	This method is invoked after a model instance is created by new operator.
afterValidate() (opens new window)	This method is invoked after validation ends.
beforeValidate() (opens new window)	This method is invoked before validation starts.
createContent()	Creates the content model associated with this element.
defineAttributes()	Defines this model's attributes.
getFieldByHandle()	Returns the field with a given handle.

defineAttributes()

Defines this model's attributes.

BaseModel::defineAttributes()

BaseModel::defineAttributes()

View source (opens new window)

Returns

array (opens new window)

Signature

protected array defineAttributes ( )

Constants

Constant	Description
ARCHIVED
DISABLED
ENABLED