HumHub Documentation (unofficial)

ActiveRecordInterface extends StaticInstanceInterface
in

Application

ActiveRecordInterface.

Methods

attributes() : array<string|int, mixed>: Returns the list of all attribute names of the record.
delete() : int|bool: Deletes the record from the database.
deleteAll() : int: Deletes records using the provided conditions.
equals() : bool: Returns a value indicating whether the given active record is the same as the current one.
find() : ActiveQueryInterface: Creates an [[ActiveQueryInterface]] instance for query purpose.
findAll() : array<string|int, mixed>: Returns a list of active record models that match the specified primary key value(s) or a set of column values.
findOne() : static|null: Returns a single active record model instance by a primary key or an array of column values.
getAttribute() : mixed: Returns the named attribute value.
getDb() : mixed: Returns the connection used by this AR class.
getIsNewRecord() : bool: Returns a value indicating whether the current record is new (not saved in the database).
getOldPrimaryKey() : mixed: Returns the old primary key value(s).
getPrimaryKey() : mixed: Returns the primary key value(s).
getRelation() : ActiveQueryInterface: Returns the relation object with the specified name.
hasAttribute() : bool: Returns a value indicating whether the record has an attribute with the specified name.
insert() : bool: Inserts the record into the database using the attribute values of this record.
instance() : static: Returns static class instance, which can be used to obtain meta information.
isPrimaryKey() : bool: Returns a value indicating whether the given set of attributes represents the primary key for this model.
link() : mixed: Establishes the relationship between two records.
populateRelation() : mixed: Populates the named relation with the related records.
primaryKey() : array<string|int, string>: Returns the primary key **name(s)** for this AR class.
save() : bool: Saves the current record.
setAttribute() : mixed: Sets the named attribute value.
unlink() : mixed: Destroys the relationship between two records.
update() : int|bool: Saves the changes to this active record into the database.
updateAll() : int: Updates records using the provided attribute values and conditions.

attributes()

Returns the list of all attribute names of the record.


    public
                    attributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

list of attribute names.

delete()

Deletes the record from the database.


    public
                    delete() : int|bool

Return values

int|bool —

the number of rows deleted, or false if the deletion is unsuccessful for some reason. Note that it is possible that the number of rows deleted is 0, even though the deletion execution is successful.

deleteAll()

Deletes records using the provided conditions.


    public
            static        deleteAll([array<string|int, mixed>|null $condition = null ]) : int

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

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

Customer::deleteAll([status = 3]);

Parameters

$condition : array<string|int, mixed>|null = null: the condition that matches the records that should get deleted. Please refer to [[QueryInterface::where()]] on how to specify this parameter. An empty condition will match all records.

Return values

int —

the number of rows deleted

equals()

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


    public
                    equals(static $record) : bool

Two [[getIsNewRecord()|new]] records are considered to be not equal.

Parameters

$record : static: record to compare to

Return values

bool —

whether the two active records refer to the same row in the same database table.

find()

Creates an [[ActiveQueryInterface]] instance for query purpose.


    public
            static        find() : ActiveQueryInterface

The returned [[ActiveQueryInterface]] instance can be further customized by calling methods defined in [[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 [[BaseActiveRecord::hasOne()]] and [[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();

Return values

ActiveQueryInterface —

the newly created [[ActiveQueryInterface]] instance.

findAll()

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


    public
            static        findAll(mixed $condition) : array<string|int, mixed>

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 [[ActiveRecordInterface|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 [[ActiveQuery::where()|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'));

Parameters

$condition : mixed: primary key value or a set of column values

Return values

array<string|int, mixed> —

an array of ActiveRecord instance, or an empty array if nothing matches.

findOne()

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


    public
            static        findOne(mixed $condition) : static|null

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 [[ActiveRecordInterface|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 [[ActiveQuery::where()|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'));

Parameters

$condition : mixed: primary key value or a set of column values

Return values

static|null —

ActiveRecord instance matching the condition, or null if nothing matches.

getAttribute()

Returns the named attribute value.


    public
                    getAttribute(string $name) : mixed

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

Parameters

$name : string: the attribute name

Return values

mixed —

the attribute value. null if the attribute is not set or does not exist.

getDb()

Returns the connection used by this AR class.


    public
            static        getDb() : mixed

Return values

mixed —

the database connection used by this AR class.

getIsNewRecord()

Returns a value indicating whether the current record is new (not saved in the database).


    public
                    getIsNewRecord() : bool

Return values

bool —

whether the record is new and should be inserted when calling [[save()]].

getOldPrimaryKey()

Returns the old primary key value(s).


    public
                    getOldPrimaryKey([bool $asArray = false ]) : mixed

This refers to the primary key value that is populated into the record after executing a find method (e.g. find(), findOne()). The value remains unchanged even if the primary key attribute is manually assigned with a different value.

Parameters

$asArray : bool = false: whether to return the primary key value as an array. If true, the return value will be an array with column name as key and column value as value. If this is false (default), a scalar value will be returned for non-composite primary key.

Return values

mixed —

the old primary key value. An array (column name => column value) is returned if the primary key is composite or $asArray is true. A string is returned otherwise (null will be returned if the key value is null).

getPrimaryKey()

Returns the primary key value(s).


    public
                    getPrimaryKey([bool $asArray = false ]) : mixed

Parameters

$asArray : bool = false: whether to return the primary key value as an array. If true, the return value will be an array with attribute names as keys and attribute values as values. Note that for composite primary keys, an array will always be returned regardless of this parameter value.

Return values

mixed —

the primary key value. An array (attribute name => attribute value) is returned if the primary key is composite or $asArray is true. A string is returned otherwise (null will be returned if the key value is null).

getRelation()

Returns the relation object with the specified name.


    public
                    getRelation(string $name[, bool $throwException = true ]) : ActiveQueryInterface

A relation is defined by a getter method which returns an object implementing the [[ActiveQueryInterface]] (normally this would be a relational [[ActiveQuery]] object). It can be declared in either the ActiveRecord class itself or one of its behaviors.

Parameters

$name : string: the relation name, e.g. orders for a relation defined via getOrders() method (case-sensitive).
$throwException : bool = true: whether to throw exception if the relation does not exist.

Return values

ActiveQueryInterface —

the relational query object

hasAttribute()

Returns a value indicating whether the record has an attribute with the specified name.


    public
                    hasAttribute(string $name) : bool

Parameters

$name : string: the name of the attribute

Return values

bool —

whether the record has an attribute with the specified name.

insert()

Inserts the record into the database using the attribute values of this record.


    public
                    insert([bool $runValidation = true ][, array<string|int, mixed>|null $attributes = null ]) : bool

Usage example:

$customer = new Customer;
$customer->name = $name;
$customer->email = $email;
$customer->insert();

Parameters

$runValidation : bool = true: whether to perform validation (calling [[\yii\base\Model::validate()|validate()]]) before saving the record. Defaults to true. If the validation fails, the record will not be saved to the database and this method will return false.
$attributes : array<string|int, mixed>|null = null: list of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved.

Return values

bool —

whether the attributes are valid and the record is inserted successfully.

instance()

Returns static class instance, which can be used to obtain meta information.


    public
            static        instance([bool $refresh = false ]) : static

Parameters

$refresh : bool = false: whether to re-create static instance even, if it is already cached.

Return values

static —

class instance.

isPrimaryKey()

Returns a value indicating whether the given set of attributes represents the primary key for this model.


    public
            static        isPrimaryKey(array<string|int, mixed> $keys) : bool

Parameters

$keys : array<string|int, mixed>: the set of attributes to check

Return values

bool —

whether the given set of attributes represents the primary key for this model

link()

Establishes the relationship between two records.


    public
                    link(string $name, static $model[, array<string|int, mixed> $extraColumns = [] ]) : mixed

The relationship is established by setting the foreign key value(s) in one record to be the corresponding primary key value(s) in the other record. The record with the foreign key will be saved into database without performing validation.

If the relationship involves a junction table, a new row will be inserted into the junction table which contains the primary key values from both records.

This method requires that the primary key value is not null.

Parameters

$name : string: the case sensitive name of the relationship, e.g. orders for a relation defined via getOrders() method.
$model : static: the record to be linked with the current one.
$extraColumns : array<string|int, mixed> = []: additional column values to be saved into the junction table. This parameter is only meaningful for a relationship involving a junction table (i.e., a relation set with [[ActiveQueryInterface::via()]]).

populateRelation()

Populates the named relation with the related records.


    public
                    populateRelation(string $name, ActiveRecordInterface|array<string|int, mixed>|null $records) : mixed

Note that this method does not check if the relation exists or not.

Parameters

$name : string: the relation name, e.g. orders for a relation defined via getOrders() method (case-sensitive).
$records : ActiveRecordInterface|array<string|int, mixed>|null: the related records to be populated into the relation.

primaryKey()

Returns the primary key **name(s)** for this AR class.


    public
            static        primaryKey() : array<string|int, string>

Note that an array should be returned even when the record only has a single primary key.

For the primary key value see [[getPrimaryKey()]] instead.

Return values

array<string|int, string> —

the primary key name(s) for this AR class.

save()

Saves the current record.


    public
                    save([bool $runValidation = true ][, array<string|int, mixed>|null $attributeNames = null ]) : bool

This method will call [[insert()]] when [[getIsNewRecord()|isNewRecord]] is true, or [[update()]] when [[getIsNewRecord()|isNewRecord]] is false.

For example, to save a customer record:

$customer = new Customer; // or $customer = Customer::findOne($id);
$customer->name = $name;
$customer->email = $email;
$customer->save();

Parameters

$runValidation : bool = true: whether to perform validation (calling [[\yii\base\Model::validate()|validate()]]) before saving the record. Defaults to true. If the validation fails, the record will not be saved to the database and this method will return false.
$attributeNames : array<string|int, mixed>|null = null: list of attribute names that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved.

Return values

bool —

whether the saving succeeded (i.e. no validation errors occurred).

setAttribute()

Sets the named attribute value.


    public
                    setAttribute(string $name, mixed $value) : mixed

Parameters

$name : string: the attribute name.
$value : mixed: the attribute value.

unlink()

Destroys the relationship between two records.


    public
                    unlink(string $name, static $model[, bool $delete = false ]) : mixed

The record with the foreign key of the relationship will be deleted if $delete is true. Otherwise, the foreign key will be set null and the record will be saved without validation.

Parameters

$name : string: the case sensitive name of the relationship, e.g. orders for a relation defined via getOrders() method.
$model : static: the model to be unlinked from the current one.
$delete : bool = false: whether to delete the model that contains the foreign key. If false, the model's foreign key will be set null and saved. If true, the model containing the foreign key will be deleted.

update()

Saves the changes to this active record into the database.


    public
                    update([bool $runValidation = true ][, array<string|int, mixed>|null $attributeNames = null ]) : int|bool

Usage example:

$customer = Customer::findOne($id);
$customer->name = $name;
$customer->email = $email;
$customer->update();

Parameters

$runValidation : bool = true: whether to perform validation (calling [[\yii\base\Model::validate()|validate()]]) before saving the record. Defaults to true. If the validation fails, the record will not be saved to the database and this method will return false.
$attributeNames : array<string|int, mixed>|null = null: list of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved.

Return values

int|bool —

the number of rows affected, or false if validation fails or updating process is stopped for other reasons. Note that it is possible that the number of rows affected is 0, even though the update execution is successful.

updateAll()

Updates records using the provided attribute values and conditions.


    public
            static        updateAll(array<string|int, mixed> $attributes[, mixed $condition = null ]) : int

For example, to change the status to be 1 for all customers whose status is 2:

Customer::updateAll(['status' => 1], ['status' => '2']);

Parameters

$attributes : array<string|int, mixed>: attribute values (name-value pairs) to be saved for the record. Unlike [[update()]] these are not going to be validated.
$condition : mixed = null: the condition that matches the records that should get updated. Please refer to [[QueryInterface::where()]] on how to specify this parameter. An empty condition will match all records.

Return values

int —

the number of rows updated

ActiveRecordInterface extends StaticInstanceInterface in Application

Tags

Table of Contents

Methods

Methods

attributes()

Return values

delete()

Return values

deleteAll()

Parameters

Return values

equals()

Parameters

Return values

find()

Return values

findAll()

Parameters

Return values

findOne()

Parameters

Return values

getAttribute()

Parameters

Tags

Return values

getDb()

Return values

getIsNewRecord()

Return values

getOldPrimaryKey()

Parameters

Return values

getPrimaryKey()

Parameters

Return values

getRelation()

Parameters

Return values

hasAttribute()

Parameters

Return values

insert()

Parameters

Return values

instance()

Parameters

Return values

isPrimaryKey()

Parameters

Return values

link()

Parameters

populateRelation()

Parameters

Tags

primaryKey()

Return values

save()

Parameters

Return values

setAttribute()

Parameters

Tags

unlink()

Parameters

update()

Parameters

Return values

updateAll()

ActiveRecordInterface extends StaticInstanceInterface
in

Application