Craft 5 Class Reference

Appearance

ActiveRecord ​

Type
Abstract Class
Namespace
craft\db
Inherits
craft\db\ActiveRecord » yii\db\ActiveRecord » yii\db\BaseActiveRecord » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface, yii\db\ActiveRecordInterface
Uses traits
yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by
craft\records\Address, craft\records\Asset, craft\records\AssetIndexData, craft\records\AssetIndexingSession, craft\records\Authenticator, craft\records\Category, craft\records\CategoryGroup, craft\records\CategoryGroup_SiteSettings, craft\records\CraftIdToken, craft\records\Element, craft\records\Element_SiteSettings, craft\records\Entry, craft\records\EntryType, craft\records\Field, craft\records\FieldLayout, craft\records\GlobalSet, craft\records\GqlSchema, craft\records\GqlToken, craft\records\ImageTransform, craft\records\Plugin, craft\records\RecoveryCodes, craft\records\Section, craft\records\Section_SiteSettings, craft\records\Session, craft\records\Site, craft\records\SiteGroup, craft\records\Structure, craft\records\StructureElement, craft\records\SystemMessage, craft\records\Tag, craft\records\TagGroup, craft\records\Token, craft\records\User, craft\records\UserGroup, craft\records\UserGroup_User, craft\records\UserPermission, craft\records\UserPermission_User, craft\records\UserPermission_UserGroup, craft\records\Volume, craft\records\VolumeFolder, craft\records\WebAuthn, craft\records\Widget
Since
3.0.0

Active Record base class.

View source

Public Properties ​

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
dateCreatedDateTime, string, null – Date created
dateUpdatedDateTime, string, null – Date updated
dirtyAttributesarray – The changed attribute values (name-value pairs).
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
isNewRecordboolean – Whether the record is new and should be inserted when calling save().
iteratorArrayIterator – An iterator for traversing the items in the list.
oldAttributesarray – The old attribute values (name-value pairs).
oldPrimaryKeymixed – The old primary key value.
primaryKeymixed – The primary key value.
relatedRecordsarray – An array of related records indexed by relation names.
scenariostring – The scenario that this model is in.
uidstring – UUID
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

dateCreated ​

Type
DateTime, string, null
Default value
null

Date created

View source

dateUpdated ​

Type
DateTime, string, null
Default value
null

Date updated

View source

uid ​

Type
string
Default value
null

UUID

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()PHP getter magic method.
__isset()Checks if a property value is null.
__set()PHP setter magic method.
__unset()Sets a component property to be null.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
afterDelete()This method is invoked after deleting a record.
afterFind()This method is called when the AR object is created and populated with the query result.
afterRefresh()This method is called when the AR object is refreshed.
afterSave()This method is called at the end of inserting or updating a record.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of all attribute names of the model.
beforeDelete()This method is invoked before deleting a record.
beforeSave()This method is called at the beginning of inserting or updating a record.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
delete()Deletes the table row corresponding to this active record.
deleteAll()Deletes rows in the table using the provided conditions.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
equals()Returns a value indicating whether the given active record is the same as the current one.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
find()Creates an \craft\db\ActiveQueryInterface instance for query purpose.
findAll()Returns a list of active record models that match the specified primary key value(s) or a set of column values.
findBySql()See yii\db\ActiveRecord::findBySql() for more info.
findOne()Returns a single active record model instance by a primary key or an array of column values.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAttribute()Returns the named attribute value.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getDb()Returns the database connection used by this AR class.
getDirtyAttributes()Returns the attribute values that have been modified since they are loaded or saved most recently.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getIsNewRecord()Returns a value indicating whether the current record is new.
getIterator()Returns an iterator for traversing the attributes in the model.
getOldAttribute()Returns the old value of the named attribute.
getOldAttributes()Returns the old attribute values.
getOldPrimaryKey()Returns the old primary key value(s).
getPrimaryKey()Returns the primary key value(s).
getRelatedRecords()Returns all populated related records.
getRelation()Returns the relation object with the specified name.
getScenario()Returns the scenario that this model is used in.
getTableSchema()Returns the schema information of the DB table associated with this AR class.
getValidators()Returns all the validators declared in rules().
hasAttribute()Returns a value indicating whether the model has an attribute with the specified name.
hasErrors()Returns a value indicating whether there is any validation error.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMany()See yii\db\BaseActiveRecord::hasMany() for more info.
hasMethod()Returns a value indicating whether a method is defined.
hasOne()See yii\db\BaseActiveRecord::hasOne() for more info.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
insert()Inserts a row into the associated database table using the attribute values of this record.
instance()Returns static class instance, which can be used to obtain meta information.
instantiate()Creates an active record instance.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeChanged()Returns a value indicating whether the named attribute has been changed.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isPrimaryKey()Returns a value indicating whether the given set of attributes represents the primary key for this model.
isRelationPopulated()Check whether the named relation has been populated with records.
isTransactional()Returns a value indicating whether the specified operation is transactional in the current scenario.
link()Establishes the relationship between two models.
load()Populates the model with input data.
loadDefaultValues()Loads default values from database table schema.
loadMultiple()Populates a set of models with the data from end user.
markAttributeDirty()Marks an attribute dirty.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
optimisticLock()Returns the name of the column that stores the lock version for implementing optimistic locking.
populateRecord()Populates an active record object using a row of data from the database/storage.
populateRelation()Populates the named relation with the related records.
primaryKey()Returns the primary key name(s) for this AR class.
refresh()Repopulates this active record with the latest data.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
save()Saves the current record.
scenarios()Returns a list of scenarios and the corresponding active attributes.
setAttribute()Sets the named attribute value.
setAttributes()Sets the attribute values in a massive way.
setIsNewRecord()Sets the value indicating whether the record is new.
setOldAttribute()Sets the old value of the named attribute.
setOldAttributes()Sets the old attribute values.
setScenario()Sets the scenario for the model.
tableName()Declares the name of the database table associated with this AR class.
toArray()Converts the model into an array.
transactions()Declares which DB operations should be performed within a transaction in different scenarios.
trigger()Triggers an event.
unlink()Destroys the relationship between two models.
unlinkAll()Destroys the relationship in current model.
update()Saves the changes to this active record into the associated database table.
updateAll()Updates the whole table using the provided attribute values and conditions.
updateAllCounters()Updates the whole table using the provided counter changes and conditions.
updateAttributes()Updates the specified attributes.
updateCounters()Updates one or several counter columns for the current AR object.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

__set() ​

Since
3.4.0

PHP setter magic method.

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

View source

Arguments ​

  • $name (string) – Property name
  • $value (mixed) – Property value

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:

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

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

View source

Arguments ​

  • $insert (boolean) – Whether this method called while inserting a record. If false, it means the method is called while updating a record.

Returns ​

boolean – Whether the insertion or updating should continue. If false, the insertion or updating will be cancelled.

behaviors() ​

Since
3.4.0

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:

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

Note that a behavior class must extend from \craft\db\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).

View source

Returns ​

array – The behavior configurations.

find() ​

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

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

php
// 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,

php
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:

php
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();




[View source](https://github.com/craftcms/cms/blob/5.1.3/src/db/ActiveRecord.php#L42-L45)



#### Returns

[craft\db\ActiveQuery](craft-db-activequery.md) – The newly created [craft\db\ActiveQuery](craft-db-activequery.md) instance.



### `findBySql()` {#method-findbysql}





See [yii\db\ActiveRecord::findBySql()](https://www.yiiframework.com/doc/api/2.0/yii-db-activerecord#findBySql()-detail) for more info.




[View source](https://github.com/craftcms/cms/blob/5.1.3/src/db/ActiveRecord.php)


#### Arguments

- `$sql`
- `$params`

#### Returns

[craft\db\ActiveQuery](craft-db-activequery.md) –  



### `hasMany()` {#method-hasmany}





See [yii\db\BaseActiveRecord::hasMany()](https://www.yiiframework.com/doc/api/2.0/yii-db-baseactiverecord#hasMany()-detail) for more info.




[View source](https://github.com/craftcms/cms/blob/5.1.3/src/db/ActiveRecord.php)


#### Arguments

- `$class`
- `$link`

#### Returns

[craft\db\ActiveQuery](craft-db-activequery.md) –  



### `hasOne()` {#method-hasone}





See [yii\db\BaseActiveRecord::hasOne()](https://www.yiiframework.com/doc/api/2.0/yii-db-baseactiverecord#hasOne()-detail) for more info.




[View source](https://github.com/craftcms/cms/blob/5.1.3/src/db/ActiveRecord.php)


#### Arguments

- `$class`
- `$link`

#### Returns

[craft\db\ActiveQuery](craft-db-activequery.md) –  



### `setAttribute()` {#method-setattribute}



Since
:  3.4.0



Sets the named attribute value.








[View source](https://github.com/craftcms/cms/blob/5.1.3/src/db/ActiveRecord.php#L75-L79)


#### Arguments

- `$name` ([string](https://php.net/language.types.string)) – The attribute name
- `$value` (`mixed`) – The attribute value.


#### Throws

- [yii\base\InvalidArgumentException](https://www.yiiframework.com/doc/api/2.0/yii-base-invalidargumentexception)\
  if the named attribute does not exist.




## Protected Methods

| Method                                                                                                                                                      | Description
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| [createRelationQuery()](https://www.yiiframework.com/doc/api/2.0/yii-db-baseactiverecord#createRelationQuery()-detail "Defined by yii\db\BaseActiveRecord") | Creates a query instance for `has-one` or `has-many` relation.
| [deleteInternal()](https://www.yiiframework.com/doc/api/2.0/yii-db-activerecord#deleteInternal()-detail "Defined by yii\db\ActiveRecord")                   | Deletes an ActiveRecord without considering transaction.
| [extractFieldsFor()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#extractFieldsFor()-detail "Defined by yii\base\ArrayableTrait")       | 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".
| [extractRootFields()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#extractRootFields()-detail "Defined by yii\base\ArrayableTrait")     | Extracts the root field names from nested fields.
| [insertInternal()](https://www.yiiframework.com/doc/api/2.0/yii-db-activerecord#insertInternal()-detail "Defined by yii\db\ActiveRecord")                   | Inserts an ActiveRecord into DB without considering transaction.
| [prepareForDb()](craft-db-activerecord.md#method-preparefordb)                                                                                              | Sets the `dateCreated`, `dateUpdated`, and `uid` attributes on the record.
| [refreshInternal()](https://www.yiiframework.com/doc/api/2.0/yii-db-baseactiverecord#refreshInternal()-detail "Defined by yii\db\BaseActiveRecord")         | Repopulates this active record with the latest data from a newly fetched instance.
| [resolveFields()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#resolveFields()-detail "Defined by yii\base\ArrayableTrait")             | Determines which fields can be returned by [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail).
| [updateInternal()](https://www.yiiframework.com/doc/api/2.0/yii-db-baseactiverecord#updateInternal()-detail "Defined by yii\db\BaseActiveRecord")           |

### `prepareForDb()` {#method-preparefordb}



Since
:  3.1.0



Sets the `dateCreated`, `dateUpdated`, and `uid` attributes on the record.




[View source](https://github.com/craftcms/cms/blob/5.1.3/src/db/ActiveRecord.php#L95-L128)








## Constants

| Constant           | Description
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| `OP_ALL`           | All three operations: insert, update, delete.
| `OP_DELETE`        | The delete operation. This is mainly used when overriding [transactions()](https://www.yiiframework.com/doc/api/2.0/yii-db-activerecord#transactions()-detail) to specify which operations are transactional.
| `OP_INSERT`        | The insert operation. This is mainly used when overriding [transactions()](https://www.yiiframework.com/doc/api/2.0/yii-db-activerecord#transactions()-detail) to specify which operations are transactional.
| `OP_UPDATE`        | The update operation. This is mainly used when overriding [transactions()](https://www.yiiframework.com/doc/api/2.0/yii-db-activerecord#transactions()-detail) to specify which operations are transactional.
| `SCENARIO_DEFAULT` | The name of the default scenario.


## Events

### EVENT_DEFINE_BEHAVIORS



Type
:  [craft\events\DefineBehaviorsEvent](craft-events-definebehaviorsevent.md)

Since
:  3.4.0



The event that is triggered when defining the class behaviors

See also [behaviors()](craft-db-activerecord.md#method-behaviors)

---