Class lispa\amos\core\user\User
User model
Public Properties
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $adminInstalled | lispa\amos\core\user\User |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | PHP getter magic method. | yii\db\BaseActiveRecord |
| __isset() | Checks if a property value is null. | yii\db\BaseActiveRecord |
| __set() | PHP setter magic method. | yii\db\BaseActiveRecord |
| __toString() | lispa\amos\core\record\Record | |
| __unset() | Sets a component property to be null. | yii\db\BaseActiveRecord |
| activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. | yii\base\Model |
| addError() | Adds a new error to the specified attribute. | yii\base\Model |
| addErrors() | Adds a list of errors. | yii\base\Model |
| afterDelete() | This method is invoked after deleting a record. | yii\db\BaseActiveRecord |
| afterFind() | This method is called when the AR object is created and populated with the query result. | yii\db\BaseActiveRecord |
| afterRefresh() | This method is called when the AR object is refreshed. | yii\db\BaseActiveRecord |
| afterSave() | Override Required for cache | lispa\amos\core\record\Record |
| afterValidate() | This method is invoked after validation ends. | yii\base\Model |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| attributeHints() | Returns the attribute hints. | yii\base\Model |
| attributeLabels() | lispa\amos\core\record\Record | |
| attributes() | Returns the list of all attribute names of the model. | yii\db\ActiveRecord |
| basicFind() | Base query, it INCLUDE deleted elements | lispa\amos\core\record\Record |
| beforeDelete() | Override for demos | lispa\amos\core\record\Record |
| beforeSave() | Override for demos | lispa\amos\core\record\Record |
| beforeValidate() | This method is invoked before validation starts. | lispa\amos\core\record\Record |
| behaviors() | lispa\amos\core\record\Record | |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\db\BaseActiveRecord |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\db\BaseActiveRecord |
| canUseModuleOrder() | Check if there is an order variable for the module | lispa\amos\core\record\Record |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| clearErrors() | Removes errors for all attributes or a single attribute. | yii\base\Model |
| createValidators() | Creates validator objects based on the validation rules specified in rules(). | yii\base\Model |
| delete() | Deletes the table row corresponding to this active record. | yii\db\ActiveRecord |
| deleteAll() | Deletes rows in the table using the provided conditions. | yii\db\ActiveRecord |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviorByClassName() | This method detach a behavior from the model. | lispa\amos\core\record\Record |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| detachBehaviorsOnWhiteList() | lispa\amos\core\record\Record | |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| equals() | Returns a value indicating whether the given active record is the same as the current one. | yii\db\ActiveRecord |
| extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). | yii\base\ArrayableTrait |
| fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. | yii\base\ArrayableTrait |
| find() | Creates an yii\db\ActiveQueryInterface instance for query purpose. | yii\db\ActiveRecord |
| findAll() | Returns a list of active record models that match the specified primary key value(s) or a set of column values. | yii\db\BaseActiveRecord |
| findBehaviorByClassName() | This method find a behavior from the model. | lispa\amos\core\record\Record |
| findByEmail() | Finds user by email | lispa\amos\core\user\User |
| findByEmailInactive() | Finds inactive user by email | lispa\amos\core\user\User |
| findByPasswordResetToken() | Finds user by password reset token | lispa\amos\core\user\User |
| findBySql() | Creates an yii\db\ActiveQuery instance with a given SQL statement. | yii\db\ActiveRecord |
| findByUsername() | Finds user by username | lispa\amos\core\user\User |
| findByUsernameInactive() | Find inactive user by username | lispa\amos\core\user\User |
| findByUsernameOrEmail() | Finds user by username or email | lispa\amos\core\user\User |
| findByUsernameOrEmailInactive() | Finds inactive user by username or email | lispa\amos\core\user\User |
| findIdentity() | Finds an identity by the given ID. | lispa\amos\core\user\User |
| findIdentityByAccessToken() | Finds an identity by the given token. | lispa\amos\core\user\User |
| findOne() | Returns a single active record model instance by a primary key or an array of column values. | yii\db\BaseActiveRecord |
| formName() | Returns the form name that this model class should use. | yii\base\Model |
| generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. | yii\base\Model |
| generateAuthKey() | Generates "remember me" authentication key | lispa\amos\core\user\User |
| generatePasswordResetToken() | Generates new password reset token | lispa\amos\core\user\User |
| getActiveValidators() | Returns the validators applicable to the current $scenario. | yii\base\Model |
| getAttribute() | Returns the named attribute value. | yii\db\BaseActiveRecord |
| getAttributeHint() | Returns the text hint for the specified attribute. | yii\db\BaseActiveRecord |
| getAttributeLabel() | Returns the text label for the specified attribute. | yii\db\BaseActiveRecord |
| getAttributes() | Returns attribute values. | yii\base\Model |
| getAuthKey() | Returns a key that can be used to check the validity of a given identity ID. | lispa\amos\core\user\User |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getCreatedUserProfile() | lispa\amos\core\record\Record | |
| getDb() | Returns the database connection used by this AR class. | yii\db\ActiveRecord |
| getDeletedUserProfile() | lispa\amos\core\record\Record | |
| getDirtyAttributes() | Returns the attribute values that have been modified since they are loaded or saved most recently. | yii\db\BaseActiveRecord |
| getErrors() | Returns the errors for all attributes or a single attribute. | yii\base\Model |
| getFirstError() | Returns the first error of the specified attribute. | yii\base\Model |
| getFirstErrors() | Returns the first error of every attribute in the model. | yii\base\Model |
| getId() | Returns an ID that can uniquely identify a user identity. | lispa\amos\core\user\User |
| getIsNewRecord() | Returns a value indicating whether the current record is new. | yii\db\BaseActiveRecord |
| getIterator() | Returns an iterator for traversing the attributes in the model. | yii\base\Model |
| getOldAttribute() | Returns the old value of the named attribute. | yii\db\BaseActiveRecord |
| getOldAttributes() | Returns the old attribute values. | yii\db\BaseActiveRecord |
| getOldPrimaryKey() | Returns the old primary key value(s). | yii\db\BaseActiveRecord |
| getOrderAttributesLabels() | Array of fields => labels for the ORDER form see "_order.php" file | lispa\amos\core\record\Record |
| getPrimaryKey() | Returns the primary key value(s). | yii\db\BaseActiveRecord |
| getProfile() | lispa\amos\core\user\User | |
| getRelatedRecords() | Returns all populated related records. | yii\db\BaseActiveRecord |
| getRelation() | Returns the relation object with the specified name. | yii\db\BaseActiveRecord |
| getScenario() | Returns the scenario that this model is used in. | yii\base\Model |
| getStatsToolbar() | lispa\amos\core\record\Record | |
| getTableSchema() | Returns the schema information of the DB table associated with this AR class. | yii\db\ActiveRecord |
| getUpdatedUserProfile() | lispa\amos\core\record\Record | |
| getUserProfile() | lispa\amos\core\user\User | |
| getValidatorUsersId() | Method return user ids of record validators | lispa\amos\core\record\Record |
| getValidators() | Returns all the validators declared in rules(). | yii\base\Model |
| getWorkflowStatusLabel() | This method return the correct workflow status label. It checks if the workflow behavior is present, then checks if the model has a workflow status and return the correct label. | lispa\amos\core\record\Record |
| globalSearchTags() | This method is called by search module to fetch results matching one or more tags | lispa\amos\core\record\Record |
| hasAttribute() | Returns a value indicating whether the model has an attribute with the specified name. | yii\db\BaseActiveRecord |
| hasErrors() | Returns a value indicating whether there is any validation error. | yii\base\Model |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMany() | Declares a has-many relation. |
yii\db\BaseActiveRecord |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasOne() | Declares a has-one relation. |
yii\db\BaseActiveRecord |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | lispa\amos\core\user\User | |
| initOrderVars() | Init the order variables from the module config | lispa\amos\core\record\Record |
| insert() | Inserts a row into the associated database table using the attribute values of this record. | yii\db\ActiveRecord |
| instantiate() | Creates an active record instance. | yii\db\BaseActiveRecord |
| isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. | yii\base\Model |
| isAttributeChanged() | Returns a value indicating whether the named attribute has been changed. | yii\db\BaseActiveRecord |
| isAttributeRequired() | Returns a value indicating whether the attribute is required. | yii\base\Model |
| isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. | yii\base\Model |
| isDemo() | Check is demo environment | lispa\amos\core\record\Record |
| isEnabledCwh() | lispa\amos\core\record\Record | |
| isEnabledModule() | lispa\amos\core\record\Record | |
| isEnabledTag() | lispa\amos\core\record\Record | |
| isPasswordResetTokenValid() | Finds out if password reset token is valid | lispa\amos\core\user\User |
| isPrimaryKey() | Returns a value indicating whether the given set of attributes represents the primary key for this model | yii\db\BaseActiveRecord |
| isRelationPopulated() | Check whether the named relation has been populated with records. | yii\db\BaseActiveRecord |
| isTransactional() | Returns a value indicating whether the specified operation is transactional in the current $scenario. | yii\db\ActiveRecord |
| link() | Establishes the relationship between two models. | yii\db\BaseActiveRecord |
| load() | Populates the model with input data. | yii\base\Model |
| loadDefaultValues() | Loads default values from database table schema | yii\db\ActiveRecord |
| loadMultiple() | Populates a set of models with the data from end user. | yii\base\Model |
| markAttributeDirty() | Marks an attribute dirty. | yii\db\BaseActiveRecord |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| offsetExists() | Returns whether there is an element at the specified offset. | yii\db\BaseActiveRecord |
| offsetGet() | Returns the element at the specified offset. | yii\base\Model |
| offsetSet() | Sets the element at the specified offset. | yii\base\Model |
| offsetUnset() | Sets the element value at the specified offset to null. | yii\db\BaseActiveRecord |
| on() | Attaches an event handler to an event. | yii\base\Component |
| onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. | yii\base\Model |
| optimisticLock() | Returns the name of the column that stores the lock version for implementing optimistic locking. | yii\db\BaseActiveRecord |
| populateRecord() | Populates an active record object using a row of data from the database/storage. | yii\db\ActiveRecord |
| populateRelation() | Populates the named relation with the related records. | yii\db\BaseActiveRecord |
| primaryKey() | Returns the primary key name(s) for this AR class. | yii\db\ActiveRecord |
| refresh() | Repopulates this active record with the latest data. | yii\db\BaseActiveRecord |
| removePasswordResetToken() | Removes password reset token | lispa\amos\core\user\User |
| renameFormNamesAndIds() | This method return an array of array. The array keys are all the model fields and the values are arrays with "name! and "id" keys modified with the string contained in the param. The return array structure is the following: $newNameAndIds = [ 'FIELD_NAME_1' => [ 'name' => 'NEW_NAME', 'id' => 'NEW_ID' ], . | lispa\amos\core\record\Record |
| representingColumn() | lispa\amos\core\record\Record | |
| rules() | lispa\amos\core\user\User | |
| safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. | yii\base\Model |
| save() | Saves the current record. | yii\db\BaseActiveRecord |
| scenarios() | Returns a list of scenarios and the corresponding active attributes. | lispa\amos\core\record\Record |
| setAttribute() | Sets the named attribute value. | yii\db\BaseActiveRecord |
| setAttributes() | Sets the attribute values in a massive way. | yii\base\Model |
| setIsNewRecord() | Sets the value indicating whether the record is new. | yii\db\BaseActiveRecord |
| setOldAttribute() | Sets the old value of the named attribute. | yii\db\BaseActiveRecord |
| setOldAttributes() | Sets the old attribute values. | yii\db\BaseActiveRecord |
| setOrderAttribute() | Set order field | lispa\amos\core\record\Record |
| setOrderAttributes() | Set the list of fields order for this module | lispa\amos\core\record\Record |
| setOrderType() | Set order type: ascending (SORT_ASC), descending (SORT_DESC) | lispa\amos\core\record\Record |
| setOrderVars() | Identifies the sort fields | lispa\amos\core\record\Record |
| setPassword() | Generates password hash from password and sets it to the model | lispa\amos\core\user\User |
| setScenario() | Sets the scenario for the model. | yii\base\Model |
| tableName() | Declares the name of the database table associated with this AR class. | lispa\amos\core\user\User |
| toArray() | Converts the model into an array. | yii\base\ArrayableTrait |
| toStringWithCharLimit() | lispa\amos\core\record\Record | |
| transactions() | Declares which DB operations should be performed within a transaction in different scenarios. | yii\db\ActiveRecord |
| trigger() | Triggers an event. | yii\base\Component |
| unlink() | Destroys the relationship between two models. | yii\db\BaseActiveRecord |
| unlinkAll() | Destroys the relationship in current model. | yii\db\BaseActiveRecord |
| update() | Saves the changes to this active record into the associated database table. | yii\db\ActiveRecord |
| updateAll() | Updates the whole table using the provided attribute values and conditions. | yii\db\ActiveRecord |
| updateAllCounters() | Updates the whole table using the provided counter changes and conditions. | yii\db\ActiveRecord |
| updateAttributes() | Updates the specified attributes. | yii\db\BaseActiveRecord |
| updateCounters() | Updates one or several counter columns for the current AR object. | yii\db\BaseActiveRecord |
| validate() | Performs the data validation. | yii\base\Model |
| validateAuthKey() | Validates the given auth key. | lispa\amos\core\user\User |
| validateMultiple() | Validates multiple models. | yii\base\Model |
| validatePassword() | Validates password | lispa\amos\core\user\User |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| __shortText() | Parse string and return limited one | lispa\amos\core\record\Record |
| createRelationQuery() | Creates a query instance for has-one or has-many relation. |
yii\db\BaseActiveRecord |
| deleteInternal() | Deletes an ActiveRecord without considering transaction. | yii\db\ActiveRecord |
| findByCondition() | Finds ActiveRecord instance(s) by the given condition. | yii\db\ActiveRecord |
| insertInternal() | Inserts an ActiveRecord into DB without considering transaction. | yii\db\ActiveRecord |
| resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
| updateInternal() | yii\db\BaseActiveRecord |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_DELETE | yii\base\Event | An event that is triggered after a record is deleted. | yii\db\BaseActiveRecord |
| EVENT_AFTER_FIND | yii\base\Event | An event that is triggered after the record is created and populated with query result. | yii\db\BaseActiveRecord |
| EVENT_AFTER_INSERT | yii\db\AfterSaveEvent | An event that is triggered after a record is inserted. | yii\db\BaseActiveRecord |
| EVENT_AFTER_REFRESH | yii\base\Event | An event that is triggered after a record is refreshed. (available since version 2.0.8) | yii\db\BaseActiveRecord |
| EVENT_AFTER_UPDATE | yii\db\AfterSaveEvent | An event that is triggered after a record is updated. | yii\db\BaseActiveRecord |
| EVENT_AFTER_VALIDATE | yii\base\Event | An event raised at the end of validate() | yii\base\Model |
| EVENT_BEFORE_DELETE | yii\base\ModelEvent | An event that is triggered before deleting a record. | yii\db\BaseActiveRecord |
| EVENT_BEFORE_INSERT | yii\base\ModelEvent | An event that is triggered before inserting a record. | yii\db\BaseActiveRecord |
| EVENT_BEFORE_UPDATE | yii\base\ModelEvent | An event that is triggered before updating a record. | yii\db\BaseActiveRecord |
| EVENT_BEFORE_VALIDATE | yii\base\ModelEvent | An event raised at the beginning of validate(). | yii\base\Model |
| EVENT_INIT | yii\base\Event | An event that is triggered when the record is initialized via init(). | yii\db\BaseActiveRecord |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| OP_ALL | 7 | All three operations: insert, update, delete. This is a shortcut of the expression: OP_INSERT | OP_UPDATE | OP_DELETE. | yii\db\ActiveRecord |
| OP_DELETE | 4 | The delete operation. This is mainly used when overriding transactions() to specify which operations are transactional. | yii\db\ActiveRecord |
| OP_INSERT | 1 | The insert operation. This is mainly used when overriding transactions() to specify which operations are transactional. | yii\db\ActiveRecord |
| OP_UPDATE | 2 | The update operation. This is mainly used when overriding transactions() to specify which operations are transactional. | yii\db\ActiveRecord |
| SCENARIO_DEFAULT | 'default' | The name of the default scenario. | yii\base\Model |
| SCENARIO_FAKE_REQUIRED | 'scenario_fake_required' | lispa\amos\core\record\Record | |
| STATUS_ACTIVE | 10 | lispa\amos\core\user\User | |
| STATUS_DELETED | 0 | lispa\amos\core\user\User |
Property Details
A key that is used to check the validity of a given identity ID.
An ID that uniquely identifies a user identity.
Method Details
Finds user by email
| public static static|null findByEmail ( $email ) | ||
| string | ||
Finds inactive user by email
| public static static|null findByEmailInactive ( $email ) | ||
| string | ||
Finds user by password reset token
| public static static|null findByPasswordResetToken ( $token ) | ||
| $token | string | Password reset token |
Finds user by username
| public static static|null findByUsername ( $username ) | ||
| $username | string | |
Find inactive user by username
| public static static|null findByUsernameInactive ( $username ) | ||
| $username | string | |
Finds user by username or email
| public static static|null findByUsernameOrEmail ( $usernameOrEmail ) | ||
| $usernameOrEmail | string | |
Finds inactive user by username or email
| public static static|null findByUsernameOrEmailInactive ( $usernameOrEmail ) | ||
| $usernameOrEmail | string | |
Finds an identity by the given ID.
| public static yii\web\IdentityInterface findIdentity ( $id ) | ||
| $id | string|integer | The ID to be looked for |
| return | 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.) |
|---|---|---|
Finds an identity by the given token.
| public static yii\web\IdentityInterface findIdentityByAccessToken ( $token, $type = null ) | ||
| $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 |
| return | 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.) |
|---|---|---|
Generates "remember me" authentication key
| public void generateAuthKey ( ) |
Generates new password reset token
| public void generatePasswordResetToken ( ) |
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 lispa\amos\core\user\User::enableAutoLogin is enabled.
| public string getAuthKey ( ) | ||
| return | string | A key that is used to check the validity of a given identity ID. |
|---|---|---|
Returns an ID that can uniquely identify a user identity.
| public string|integer getId ( ) | ||
| return | string|integer | An ID that uniquely identifies a user identity. |
|---|---|---|
| public yii\db\ActiveRecord getProfile ( ) |
| public yii\db\ActiveQuery getUserProfile ( ) |
| public void init ( ) |
Finds out if password reset token is valid
| public static boolean isPasswordResetTokenValid ( $token ) | ||
| $token | string | Password reset token |
Removes password reset token
| public void removePasswordResetToken ( ) |
| public void rules ( ) |
Generates password hash from password and sets it to the model
| public void setPassword ( $password ) | ||
| $password | string | |
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 \lispa\amos\core\user\Inflector::camel2id()
with prefix \lispa\amos\core\user\Connection::tablePrefix. For example if \lispa\amos\core\user\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.
| public static string tableName ( ) | ||
| return | string | The table name |
|---|---|---|
Validates the given auth key.
This is required if lispa\amos\core\user\User::enableAutoLogin is enabled.
| public boolean validateAuthKey ( $authKey ) | ||
| $authKey | string | The given auth key |
| return | boolean | Whether the given auth key is valid. |
|---|---|---|
Validates password
| public boolean validatePassword ( $password ) | ||
| $password | string | Password to validate |
| return | boolean | If password provided is valid for current user |
|---|---|---|