Interface Yiisoft\ActiveRecord\ActiveRecordInterface

Sets the old value of the named property.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::hasProperty().

Sets the old property values.

All existing old property values will be discarded.

Create Yiisoft\ActiveRecord\ActiveQueryInterface instance for the given model class.

Returns the database connection used by the Active Record instance.

Deletes the table row corresponding to this active record.

Deletes rows in the table using the provided conditions.

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

$customer = new Customer();
$customer->deleteAll('status = 3');

Warning: If you don't specify any condition, this method will delete all rows in the table.

$customers = Customer::query()->where('status = 3')->all();
foreach ($customers as $customer) {
    $customer->delete();
}

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

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 Yiisoft\ActiveRecord\ActiveRecordInterface::isNew() they're also considered not equal.

Returns the named property value.

If this record is the result of a query and the property isn't loaded, null will be returned.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::hasProperty().

Declares a has-many relation.

The declaration is returned in terms of a relational Yiisoft\ActiveRecord\ActiveQuery instance through which the related record can be queried and retrieved back.

A has-many relation means that there are multiple related records matching the criteria set by this relation, e.g., a customer has many orders.

For example, to declare the orders relation for Customer class, you can write the following code in the Customer class:

public function getOrdersQuery()
{
    return $this->hasMany(Order::className(), ['customer_id' => 'id']);
}

Note that the customer_id key in the $link parameter refers to a property name in the related class Order, while the 'id' value refers to a property name in the current active record class.

Call methods declared in Yiisoft\ActiveRecord\ActiveQuery to further customize the relation.

Declares a has-one relation.

The declaration is returned in terms of a relational Yiisoft\ActiveRecord\ActiveQuery instance through which the related record can be queried and retrieved back.

A has-one relation means that there is at most one related record matching the criteria set by this relation, e.g., a customer has one country.

For example, to declare the country relation for Customer class, you can write the following code in the Customer class:

public function getCountryQuery()
{
    return $this->hasOne(Country::className(), ['id' => 'country_id']);
}

Note that the id key in the $link parameter refers to a property name in the related class Country, while the country_id value refers to a property name in the current active record class.

Call methods declared in Yiisoft\ActiveRecord\ActiveQuery to further customize the relation.

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

Inserts a row into the associated database table using the property values of this record.

You may specify the properties to be inserted as list of name or name-value pairs. If name-value pair specified, the corresponding property values will be modified.

Only the Yiisoft\ActiveRecord\ActiveRecordInterface::newValues() changed property values will be inserted into a database.

If the table's primary key is auto incremental and is null during insertion, it will be populated with the actual value after insertion.

For example, to insert a customer record:

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

To insert a customer record with specific properties:

$customer->insert(['name' => $name, 'email' => $email]);

Checks if any property returned by Yiisoft\ActiveRecord\ActiveRecordInterface::propertyNames() method has changed.

A new active record instance is considered changed if any property has been set including default values.

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

Returns a value indicating whether the given set of property names represents the primary key for this active record.

Returns whether the named property has been changed using the not identical operator !==.

Returns whether the named property has been changed using the not equal operator !=.

Check whether the named relation has been populated with records.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::relationQuery().

Establishes the relationship between two records.

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 a 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 isn't null.

Loads default values from database table schema.

You may call this method to load default values after creating a new instance:

// class Customer extends ActiveRecord
$customer = new Customer();
$customer->loadDefaultValues();

Marks this record as existing. The record should be updated when calling Yiisoft\ActiveRecord\ActiveRecordInterface::save().

Note: all current properties will be considered unchanged after calling this method.

See also:

• Yiisoft\ActiveRecord\ActiveRecordInterface::isNew()
• Yiisoft\ActiveRecord\ActiveRecordInterface::markAsNew()

Marks this record as new. The record should be inserted when calling Yiisoft\ActiveRecord\ActiveRecordInterface::save().

See also:

• Yiisoft\ActiveRecord\ActiveRecordInterface::isNew()
• Yiisoft\ActiveRecord\ActiveRecordInterface::markAsExisting()

Marks a property as changed.

This method may be called to force updating a record when calling Yiisoft\ActiveRecord\ActiveRecordInterface::update(), even if there is no change being made to the record.

Returns the property values that have been modified since they're loaded or saved most recently.

The comparison of new and old values uses ===.

Returns the old value of the named property.

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

See also Yiisoft\ActiveRecord\ActiveRecordInterface::hasProperty().

Returns the old property values.

Sets the property values in a massive way.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::propertyNames().

Populates an active record object using a row of data from the database/storage.

This is an internal method meant to be called to create active record objects after fetching data from the database. It's mainly used by Yiisoft\ActiveRecord\ActiveQuery to populate the query results into active records.

Populates the named relation with the related records.

Note that this method doesn't check if the relation exists or not.

Returns the primary key names for this AR class.

The default implementation will return the primary keys as declared in the DB table that's associated with this AR class.

If the DB table doesn't declare any primary key, you should override this method to return the property names that you want to use as primary keys for this active record class.

Note that an array should be returned even for a table with a single primary key.

Returns the old value of the primary key as a scalar.

This refers to the primary key value that is populated into the record after data is retrieved from the database by an instance of Yiisoft\ActiveRecord\ActiveQueryInterface.

The value remains unchanged while the record will not be \Yiisoft\ActiveRecord\ActiveRecordInterface::update() updated.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::primaryKeyOldValues().

Returns the old values of the primary key as an array with property names as keys and property values as values.

This refers to the primary key values that is populated into the record after data is retrieved from the database by an instance of Yiisoft\ActiveRecord\ActiveQueryInterface.

The value remains unchanged while the record will not be \Yiisoft\ActiveRecord\ActiveRecordInterface::update() updated.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::primaryKeyOldValues().

Returns the scalar value of the primary key.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::primaryKeyValues().

Returns the values of the primary key as an array with property names as keys and property values as values.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::primaryKeyValue().

Returns the list of property names mapped to column names of the table associated with this active record class.

Returns property values.

Create Yiisoft\ActiveRecord\ActiveQueryInterface instance for the given model class.

Returns all populated related records.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::relationQuery().

Returns the relation object with the specified name.

Returns the relation query object with the specified name.

A relation is defined by a getter method which returns an object implementing the Yiisoft\ActiveRecord\ActiveQueryInterface (normally this would be a relational Yiisoft\ActiveRecord\ActiveQuery object).

Relations can be defined using Yiisoft\ActiveRecord\ActiveRecordInterface::hasOne() and Yiisoft\ActiveRecord\ActiveRecordInterface::hasMany() methods. For example:

public function relationQuery(string $name): ActiveQueryInterface
{
    return match ($name) {
        'orders' => $this->hasMany(Order::class, ['customer_id' => 'id']),
        'country' => $this->hasOne(Country::class, ['id' => 'country_id']),
        default => parent::relationQuery($name),
    };
}

Resets relation data for the specified name.

Saves the changes to this active record into the associated database table.

You may specify the properties to be updated as list of name or name-value pairs. If name-value pair specified, the corresponding property values will be modified.

Only the Yiisoft\ActiveRecord\ActiveRecordInterface::newValues() changed property values will be saved into a database.

This method will call Yiisoft\ActiveRecord\ActiveRecordInterface::insert() when Yiisoft\ActiveRecord\ActiveRecordInterface::isNew() is true, or Yiisoft\ActiveRecord\ActiveRecordInterface::update() when Yiisoft\ActiveRecord\ActiveRecordInterface::isNew() is false.

For example, to save a customer record:

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

To save a customer record with specific properties:

$customer->save(['name' => $name, 'email' => $email]);

Sets the named property value.

Return the name of the table associated with this AR class.

final class User extends ActiveRecord
{
    public string const TABLE_NAME = 'user';

    public function tableName(): string
    {
         return self::TABLE_NAME;
    }
}

Returns the schema information of the DB table associated with this AR class.

Destroys the relationship between two records.

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.

Destroys the relationship in the current model.

The active 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 model will be saved without validation.

To destroy the relationship without removing records, make sure your keys can be set to null.

Saves the changes to this active record into the associated database table.

You may specify the properties to be updated as list of name or name-value pairs. If name-value pair specified, the corresponding property values will be modified.

The method will then save the specified properties into a database.

Only the Yiisoft\ActiveRecord\ActiveRecordInterface::newValues() changed property values will be saved into a database.

For example, to update a customer record:

$customer = Customer::query()->findByPk(1);
$customer->name = $name;
$customer->email = $email;
$customer->update();

To update a customer record with specific properties:

$customer->update(['name' => $name, 'email' => $email]);

Note that it's possible the update doesn't affect any row in the table. In this case, this method will return 0. For this reason, you should use the following code to check if update() is successful or not:

if ($customer->update() !== 0) {
    // update successful
} else {
    // update failed
}

Updates the whole table using the provided property values and conditions.

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

$customer = new Customer();
$customer->updateAll(['status' => 1], 'status = 2');

Warning: If you don't specify any condition, this method will update all rows in the table.

$customers = Customer::query()->where('status = 2')->all();
foreach ($customers as $customer) {
    $customer->status = 1;
    $customer->update();
}

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

Updates the whole table using the provided counters and condition.

For example, to increment all customers' age by 1:

$customer = new Customer();
$customer->updateAllCounters(['age' => 1]);

Note that this method will not trigger any events.

Updates one or several counters for the current active record object.

Note that this method differs from Yiisoft\ActiveRecord\ActiveRecordInterface::updateAllCounters() in that it only saves counters for the current active record object.

An example usage is as follows:

$post = new Post();
$post->updateCounters(['view_count' => 1]);

See also Yiisoft\ActiveRecord\ActiveRecordInterface::updateAllCounters().

Insert a row into the associated database table if the record doesn't already exist (matching unique constraints) or update the record if it exists, with populating model by the returning record values.

Only the Yiisoft\ActiveRecord\ActiveRecordInterface::newValues() changed property values will be inserted or updated.

If the table's primary key is auto incremental and is null during execution, it will be populated with the actual value after insertion or update.

For example, to upsert a customer record:

$customer = new Customer();
$customer->name = $name;
$customer->email = $email; // unique property
$customer->created_at = new DateTimeImmutable();
$customer->upsert();

To upsert a customer record with specific properties:

$customer->upsert(
    ['name' => $name, 'email' => $email, 'created_at' => new DateTimeImmutable()],
    ['name', 'email', 'updated_at' => new DateTimeImmutable()],
);