Class luya\admin\models\User

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Defined in: yii\base\Model::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

Defined in: luya\admin\ngrest\base\NgRestModel::__construct()

Constructor.

The default implementation does two things:

• Initializes the object with the given configuration $config.
• Call init().

If this method is overridden in a child class, it is recommended that

• the last parameter of the constructor is a configuration array, like $config here.
• call the parent implementation at the end of the constructor.

Defined in: yii\db\BaseActiveRecord::__get()

PHP getter magic method.

This method is overridden so that attributes and related objects can be accessed like properties.

See also getAttribute().

Defined in: yii\db\BaseActiveRecord::__isset()

Checks if a property value is null.

This method overrides the parent implementation by checking if the named attribute is null or not.

Defined in: yii\db\BaseActiveRecord::__set()

PHP setter magic method.

This method is overridden so that AR attributes can be accessed like properties.

Defined in: yii\db\BaseActiveRecord::__unset()

Sets a component property to be null.

This method overrides the parent implementation by clearing the specified attribute value.

Defined in: yii\base\Model::activeAttributes()

Returns the attribute names that are subject to validation in the current scenario.

Defined in: yii\base\Model::addError()

Adds a new error to the specified attribute.

Defined in: yii\base\Model::addErrors()

Adds a list of errors.

Defined in: luya\admin\ngrest\base\NgRestModel::addNgRestServiceData()

Defined in: yii\db\BaseActiveRecord::afterDelete()

This method is invoked after deleting a record.

The default implementation raises the EVENT_AFTER_DELETE event. You may override this method to do postprocessing after the record is deleted. Make sure you call the parent implementation so that the event is raised properly.

Defined in: luya\admin\ngrest\base\NgRestModel::afterFind()

This method is called when the AR object is created and populated with the query result.

The default implementation will trigger an EVENT_AFTER_FIND event. When overriding this method, make sure you call the parent implementation to ensure the event is triggered.

Defined in: yii\db\BaseActiveRecord::afterRefresh()

This method is called when the AR object is refreshed.

The default implementation will trigger an EVENT_AFTER_REFRESH event. When overriding this method, make sure you call the parent implementation to ensure the event is triggered.

Defined in: yii\db\BaseActiveRecord::afterSave()

This method is called at the end of inserting or updating a record.

The default implementation will trigger an EVENT_AFTER_INSERT event when $insert is true, or an EVENT_AFTER_UPDATE event if $insert is false. The event class used is yii\db\AfterSaveEvent. When overriding this method, make sure you call the parent implementation so that the event is triggered.

Defined in: yii\base\Model::afterValidate()

This method is invoked after validation ends.

The default implementation raises an afterValidate event. You may override this method to do postprocessing after validation. Make sure the parent implementation is invoked so that the event can be raised.

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

Defined in: yii\base\Model::attributeHints()

Returns the attribute hints.

Attribute hints are mainly used for display purpose. For example, given an attribute isPublic, we can declare a hint Whether the post should be visible for not logged in users, which provides user-friendly description of the attribute meaning and can be displayed to end users.

Unlike label hint will not be generated, if its explicit declaration is omitted.

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

Defined in: yii\db\ActiveRecord::attributes()

Returns the list of all attribute names of the model.

The default implementation will return all column names of the table associated with this AR class.

Defined in: yii\db\BaseActiveRecord::beforeDelete()

This method is invoked before deleting a record.

The default implementation raises the EVENT_BEFORE_DELETE event. When overriding this method, make sure you call the parent implementation like the following:

public function beforeDelete()
{
    if (!parent::beforeDelete()) {
        return false;
    }

    // ...custom code here...
    return true;
}

Defined in: yii\db\BaseActiveRecord::beforeSave()

This method is called at the beginning of inserting or updating a record.

The default implementation will trigger an EVENT_BEFORE_INSERT event when $insert is true, or an EVENT_BEFORE_UPDATE event if $insert is false. When overriding this method, make sure you call the parent implementation like the following:

public function beforeSave($insert)
{
    if (!parent::beforeSave($insert)) {
        return false;
    }

    // ...custom code here...
    return true;
}

Defined in: yii\base\Model::beforeValidate()

This method is invoked before validation starts.

The default implementation raises a beforeValidate event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Defined in: yii\db\BaseActiveRecord::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

• the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
• the class has a member variable with the specified name (when $checkVars is true);
• an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Defined in: yii\db\BaseActiveRecord::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

• the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
• the class has a member variable with the specified name (when $checkVars is true);
• an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

Defined in: yii\base\Model::clearErrors()

Removes errors for all attributes or a single attribute.

Defined in: yii\db\BaseActiveRecord::createRelationQuery()

Creates a query instance for has-one or has-many relation.

See also:

• hasOne()
• hasMany()

Defined in: yii\base\Model::createValidators()

Creates validator objects based on the validation rules specified in rules().

Unlike getValidators(), each time this method is called, a new list of validators will be returned.

Defined in: yii\db\ActiveRecord::delete()

Deletes the table row corresponding to this active record.

This method performs the following steps in order:

1. call beforeDelete(). If the method returns false, it will skip the rest of the steps;
2. delete the record from the database;
3. call afterDelete().

In the above step 1 and 3, events named EVENT_BEFORE_DELETE and EVENT_AFTER_DELETE will be raised by the corresponding methods.

Defined in: yii\db\ActiveRecord::deleteAll()

Deletes rows in the table using the provided conditions.

For example, to delete all customers whose status is 3:

Customer::deleteAll('status = 3');

Warning: If you do not specify any condition, this method will delete all rows in the table.

Note that this method will not trigger any events. If you need EVENT_BEFORE_DELETE or EVENT_AFTER_DELETE to be triggered, you need to find the models first and then call delete() on each of them. For example an equivalent of the example above would be:

$models = Customer::find()->where('status = 3')->all();
foreach ($models as $model) {
    $model->delete();
}

For a large set of models you might consider using yii\db\ActiveQuery::each() to keep memory usage within limits.

Defined in: yii\db\ActiveRecord::deleteInternal()

Deletes an ActiveRecord without considering transaction.

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

Defined in: yii\db\ActiveRecord::equals()

Returns a value indicating whether the given active record is the same as the current one.

The comparison is made by comparing the table names and the primary key values of the two active records. If one of the records is new they are also considered not equal.

Defined in: yii\base\ArrayableTrait::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".

Defined in: yii\base\ArrayableTrait::extractRootFields()

Extracts the root field names from nested fields.

Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "item".

Defined in: luya\admin\traits\SoftDeleteTrait::fieldStateDescriber()

Describes the fields shoudl be used to the perform the soft deleteion tasks.

Examples value of the method:

return [
    'is_deleted' => [true, false], // on delete sets `is_deleted = true`; on find add where `where(['is_deleted' => false]);`.
    'is_inactive' => true, // on delete sets `is_inactive = true`; on find add where `where([is_inactive' => !true]);`.
];

Defined in: luya\admin\ngrest\base\NgRestModel::find()

Creates an yii\db\ActiveQueryInterface instance for query purpose.

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

// find the customer whose ID is 1
$customer = Customer::find()->where(['id' => 1])->one();

// find all active customers and order them by their age:
$customers = Customer::find()
    ->where(['status' => 1])
    ->orderBy('age')
    ->all();

This method is also called by yii\db\BaseActiveRecord::hasOne() and yii\db\BaseActiveRecord::hasMany() to create a relational query.

You may override this method to return a customized query. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        // use CustomerQuery instead of the default ActiveQuery
        return new CustomerQuery(get_called_class());
    }
}

The following code shows how to apply a default condition for all queries:

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->where(['deleted' => false]);
    }
}

// Use andWhere()/orWhere() to apply the default condition
// SELECT FROM customer WHERE `deleted`=:deleted AND age>30
$customers = Customer::find()->andWhere('age>30')->all();

// Use where() to ignore the default condition
// SELECT FROM customer WHERE age>30
$customers = Customer::find()->where('age>30')->all();

Defined in: luya\admin\ngrest\base\NgRestModel::findActiveQueryBehaviors()

Attach behaviors to the Active Query.

Attach behaviours to every new {{\luya\admin\ngrest\base\NgRestActiveQuery}} on find() but not ngRestFind(). Returns a list of behaviors that the query component should behave as.

As behavior methods can be access from the inner class, use full functions can be used inside the active query. It also enables the option to share standardized behaviors with functions (conditions), for example a soft delete condition.

A behavior example:

class MySuperBehavioir extends yii\base\Behavior
{
    public function active($isActive = true)
    {
         return $this->andWhere(['is_active' => $isActive]);
    }
}

After attaching this behavior, it can be used like MyModel::find()->active()->one().

Whenever possible, directly create a custom Active Query, as it provides full IDE support. The behavior does not, the example above will even show an IDE error because the mmethod andWhere() does not exsist in the yii\base\Behavior class.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

public static function findActiveQueryBehaviors()
{
    return [
        'behaviorName' => [
            'class' => 'BehaviorClass',
            'property1' => 'value1',
            'property2' => 'value2',
         ]
    ]
}

Defined in: yii\db\BaseActiveRecord::findAll()

Returns a list of active record models that match the specified primary key value(s) or a set of column values.

The method accepts:

• a scalar value (integer or string): query by a single primary key value and return an array containing the corresponding record (or an empty array if not found).
• a non-associative array: query by a list of primary key values and return the corresponding records (or an empty array if none was found). Note that an empty condition will result in an empty result as it will be interpreted as a search for primary keys and not an empty WHERE condition.
• an associative array of name-value pairs: query by a set of attribute values and return an array of records matching all of them (or an empty array if none was found). Note that ['id' => 1, 2] is treated as a non-associative array. Column names are limited to current records table columns for SQL DBMS, or filtered otherwise to be limted to simple filter conditions.
• a yii\db\Expression: The expression will be used directly. (@since 2.0.37)

This method will automatically call the all() method and return an array of ActiveRecord instances.

Note: As this is a short-hand method only, using more complex conditions, like ['!=', 'id', 1] will not work. If you need to specify more complex conditions, use find() in combination with where() instead.

See the following code for usage examples:

// find the customers whose primary key value is 10
$customers = Customer::findAll(10);

// the above code is equivalent to:
$customers = Customer::find()->where(['id' => 10])->all();

// find the customers whose primary key value is 10, 11 or 12.
$customers = Customer::findAll([10, 11, 12]);

// the above code is equivalent to:
$customers = Customer::find()->where(['id' => [10, 11, 12]])->all();

// find customers whose age is 30 and whose status is 1
$customers = Customer::findAll(['age' => 30, 'status' => 1]);

// the above code is equivalent to:
$customers = Customer::find()->where(['age' => 30, 'status' => 1])->all();

If you need to pass user input to this method, make sure the input value is scalar or in case of array condition, make sure the array structure can not be changed from the outside:

// yii\web\Controller ensures that $id is scalar
public function actionView($id)
{
    $model = Post::findOne($id);
    // ...
}

// explicitly specifying the colum to search, passing a scalar or array here will always result in finding a single record
$model = Post::findOne(['id' => Yii::$app->request->get('id')]);

// do NOT use the following code! it is possible to inject an array condition to filter by arbitrary column values!
$model = Post::findOne(Yii::$app->request->get('id'));

Defined in: yii\db\ActiveRecord::findBySql()

Creates an yii\db\ActiveQuery instance with a given SQL statement.

Note that because the SQL statement is already specified, calling additional query modification methods (such as where(), order()) on the created yii\db\ActiveQuery instance will have no effect. However, calling with(), asArray() or indexBy() is still fine.

Below is an example:

$customers = Customer::findBySql('SELECT * FROM customer')->all();

Defined in: luya\admin\ngrest\base\NgRestModel::findLatestPrimaryKeyValue()

Get an array with the latest primary key value.

Defined in: yii\db\BaseActiveRecord::findOne()

Returns a single active record model instance by a primary key or an array of column values.

The method accepts:

• a scalar value (integer or string): query by a single primary key value and return the corresponding record (or null if not found).
• a non-associative array: query by a list of primary key values and return the first record (or null if not found).
• an associative array of name-value pairs: query by a set of attribute values and return a single record matching all of them (or null if not found). Note that ['id' => 1, 2] is treated as a non-associative array. Column names are limited to current records table columns for SQL DBMS, or filtered otherwise to be limited to simple filter conditions.
• a yii\db\Expression: The expression will be used directly. (@since 2.0.37)

That this method will automatically call the one() method and return an ActiveRecord instance.

Note: As this is a short-hand method only, using more complex conditions, like ['!=', 'id', 1] will not work. If you need to specify more complex conditions, use find() in combination with where() instead.

See the following code for usage examples:

// find a single customer whose primary key value is 10
$customer = Customer::findOne(10);

// the above code is equivalent to:
$customer = Customer::find()->where(['id' => 10])->one();

// find the customers whose primary key value is 10, 11 or 12.
$customers = Customer::findOne([10, 11, 12]);

// the above code is equivalent to:
$customers = Customer::find()->where(['id' => [10, 11, 12]])->one();

// find the first customer whose age is 30 and whose status is 1
$customer = Customer::findOne(['age' => 30, 'status' => 1]);

// the above code is equivalent to:
$customer = Customer::find()->where(['age' => 30, 'status' => 1])->one();

If you need to pass user input to this method, make sure the input value is scalar or in case of array condition, make sure the array structure can not be changed from the outside:

// yii\web\Controller ensures that $id is scalar
public function actionView($id)
{
    $model = Post::findOne($id);
    // ...
}

// explicitly specifying the colum to search, passing a scalar or array here will always result in finding a single record
$model = Post::findOne(['id' => Yii::$app->request->get('id')]);

// do NOT use the following code! it is possible to inject an array condition to filter by arbitrary column values!
$model = Post::findOne(Yii::$app->request->get('id'));

Defined in: yii\base\Model::formName()

Returns the form name that this model class should use.

The form name is mainly used by yii\widgets\ActiveForm to determine how to name the input fields for the attributes in a model. If the form name is "A" and an attribute name is "b", then the corresponding input name would be "A[b]". If the form name is an empty string, then the input name would be "b".

The purpose of the above naming schema is that for forms which contain multiple different models, the attributes of each model are grouped in sub-arrays of the POST-data and it is easier to differentiate between them.

By default, this method returns the model class name (without the namespace part) as the form name. You may override it when the model is used in different forms.

See also load().

Defined in: yii\base\Model::generateAttributeLabel()

Generates a user friendly attribute label based on the give attribute name.

This is done by replacing underscores, dashes and dots with blanks and changing the first letter of each word to upper case. For example, 'department_name' or 'DepartmentName' will generate 'Department Name'.

Defined in: luya\admin\ngrest\base\NgRestModel::generateNgRestRelations()

Generate an array with NgRestRelation objects

Defined in: luya\admin\ngrest\base\NgRestModel::genericSearch()

The Query which is going to be performend to the concret implementation.

Defined in: luya\admin\ngrest\base\NgRestModel::genericSearchHiddenFields()

An array with fields which will be hidden in the search output, but are available for the State Provider functions.

Defined in: luya\admin\ngrest\base\NgRestModel::genericSearchStateProvider()

The state provider is used to click on the items. Retuns an array with a configuration for the angular state provider. Example

return [
    'state' => 'custom.cmsedit',
    'params' => [
        'navId' => 'id'
    ]
];

The example above would look like this in the angular context

$state.go('custom.cmsedit', { navId : 1 });

All variable for the params are based on the generichSearchFields(), if a variable is defined in the generichSearchFields() method it can be used with % prefix in params value.

If genericSearchStateProvider() returns false the ability to click on the detail icon is disabled.

Defined in: yii\base\Model::getActiveValidators()

Returns the validators applicable to the current $scenario.

Defined in: yii\db\BaseActiveRecord::getAttribute()

Returns the named attribute value.

If this record is the result of a query and the attribute is not loaded, null will be returned.

See also hasAttribute().

Defined in: yii\db\BaseActiveRecord::getAttributeHint()

Returns the text hint for the specified attribute.

If the attribute looks like relatedModel.attribute, then the attribute will be received from the related model.

See also attributeHints().

Defined in: yii\db\BaseActiveRecord::getAttributeLabel()

Returns the text label for the specified attribute.

If the attribute looks like relatedModel.attribute, then the attribute will be received from the related model.

See also:

• generateAttributeLabel()
• attributeLabels()

Defined in: yii\base\Model::getAttributes()

Returns attribute values.

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

Defined in: yii\db\ActiveRecord::getDb()

Returns the database connection used by this AR class.

By default, the "db" application component is used as the database connection. You may override this method if you want to use a different database connection.

Defined in: yii\db\BaseActiveRecord::getDirtyAttributes()

Returns the attribute values that have been modified since they are loaded or saved most recently.

The comparison of new and old values is made for identical values using ===.

Defined in: yii\base\Model::getErrorSummary()

Returns the errors for all attributes as a one-dimensional array.

See also:

• getErrors()
• getFirstErrors()

Defined in: yii\base\Model::getErrors()

Returns the errors for all attributes or a single attribute.

See also:

• getFirstErrors()
• getFirstError()

Defined in: yii\base\Model::getFirstError()

Returns the first error of the specified attribute.

See also:

• getErrors()
• getFirstErrors()

Defined in: yii\base\Model::getFirstErrors()

Returns the first error of every attribute in the model.

See also:

• getErrors()
• getFirstError()

Defined in: luya\admin\ngrest\base\NgRestModel::getI18nOldValue()

Get the old/original i18n value from the database.

See also https://github.com/luyadev/luya-module-admin/pull/567.

Defined in: yii\db\BaseActiveRecord::getIsNewRecord()

Returns a value indicating whether the current record is new.