Abstract Class craft\db\ActiveRecord

Inheritance: 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
Subclasses: craft\records\Asset, craft\records\AssetIndexData, craft\records\AssetTransform, 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\EntryDraft, craft\records\EntryType, craft\records\EntryVersion, craft\records\Field, craft\records\FieldGroup, craft\records\FieldLayout, craft\records\FieldLayoutField, craft\records\FieldLayoutTab, craft\records\GlobalSet, craft\records\MatrixBlock, craft\records\MatrixBlockType, craft\records\Migration, craft\records\Plugin, craft\records\Route, 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\SystemSettings, 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\Widget
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/db/ActiveRecord.php

Active Record base class.

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`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()`	This method is called at the end of inserting or updating a record.	yii\db\BaseActiveRecord
`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()`	Returns the attribute labels.	yii\base\Model
`attributes()`	Returns the list of all attribute names of the record.	yii\db\ActiveRecordInterface
`beforeDelete()`	This method is invoked before deleting a record.	yii\db\BaseActiveRecord
`beforeSave()`	This method is called at the beginning of inserting or updating a record.	craft\db\ActiveRecord
`beforeValidate()`	This method is invoked before validation starts.	yii\base\Model
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`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 record from the database.	yii\db\ActiveRecordInterface
`deleteAll()`	Deletes records using the provided conditions.	yii\db\ActiveRecordInterface
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`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\ActiveRecordInterface
`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\ActiveRecordInterface
`findAll()`	Returns a list of active record models that match the specified primary key value(s) or a set of column values.	yii\db\ActiveRecordInterface
`findBySql()`	Creates an yii\db\ActiveQuery instance with a given SQL statement.	yii\db\ActiveRecord
`findOne()`	Returns a single active record model instance by a primary key or an array of column values.	yii\db\ActiveRecordInterface
`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
`getActiveValidators()`	Returns the validators applicable to the current \yii\base\scenario.	yii\base\Model
`getAttribute()`	Returns the named attribute value.	yii\db\ActiveRecordInterface
`getAttributeHint()`	Returns the text hint for the specified attribute.	yii\base\Model
`getAttributeLabel()`	Returns the text label for the specified attribute.	yii\base\Model
`getAttributes()`	Returns attribute values.	yii\base\Model
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getDb()`	Returns the connection used by this AR class.	yii\db\ActiveRecordInterface
`getDirtyAttributes()`	Returns the attribute values that have been modified since they are loaded or saved most recently.	yii\db\BaseActiveRecord
`getErrorSummary()`	Returns the errors for all attributes as a one-dimensional array.	yii\base\Model
`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
`getIsNewRecord()`	Returns a value indicating whether the current record is new (not saved in the database).	yii\db\ActiveRecordInterface
`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\ActiveRecordInterface
`getPrimaryKey()`	Returns the primary key value(s).	yii\db\ActiveRecordInterface
`getRelatedRecords()`	Returns all populated related records.	yii\db\BaseActiveRecord
`getRelation()`	Returns the relation object with the specified name.	yii\db\ActiveRecordInterface
`getScenario()`	Returns the scenario that this model is used in.	yii\base\Model
`getTableSchema()`	Returns the schema information of the DB table associated with this AR class.	yii\db\ActiveRecord
`getValidators()`	Returns all the validators declared in rules().	yii\base\Model
`hasAttribute()`	Returns a value indicating whether the record has an attribute with the specified name.	yii\db\ActiveRecordInterface
`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\BaseObject
`hasOne()`	Declares a `has-one` relation.	yii\db\BaseActiveRecord
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`insert()`	Inserts the record into the database using the attribute values of this record.	yii\db\ActiveRecordInterface
`instance()`	Returns static class instance, which can be used to obtain meta information.	yii\base\StaticInstanceTrait
`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
`isPrimaryKey()`	Returns a value indicating whether the given set of attributes represents the primary key for this model.	yii\db\ActiveRecordInterface
`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 \yii\db\$scenario.	yii\db\ActiveRecord
`link()`	Establishes the relationship between two records.	yii\db\ActiveRecordInterface
`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\base\Model
`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\base\Model
`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()`	{@inheritdoc}	yii\db\ActiveRecord
`populateRelation()`	Populates the named relation with the related records.	yii\db\ActiveRecordInterface
`primaryKey()`	Returns the primary key name(s) for this AR class.	yii\db\ActiveRecordInterface
`refresh()`	{@inheritdoc}	yii\db\ActiveRecord
`rules()`	Returns the validation rules for attributes.	yii\base\Model
`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\ActiveRecordInterface
`scenarios()`	Returns a list of scenarios and the corresponding active attributes.	yii\base\Model
`setAttribute()`	Sets the named attribute value.	yii\db\ActiveRecordInterface
`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
`setScenario()`	Sets the scenario for the model.	yii\base\Model
`tableName()`	Declares the name of the database table associated with this AR class.	yii\db\ActiveRecord
`toArray()`	Converts the model into an array.	yii\base\ArrayableTrait
`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 records.	yii\db\ActiveRecordInterface
`unlinkAll()`	Destroys the relationship in current model.	yii\db\BaseActiveRecord
`update()`	Saves the changes to this active record into the database.	yii\db\ActiveRecordInterface
`updateAll()`	Updates records using the provided attribute values and conditions.	yii\db\ActiveRecordInterface
`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
`validateMultiple()`	Validates multiple models.	yii\base\Model

Protected Methods
Method	Description	Defined By
`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
`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".	yii\base\ArrayableTrait
`extractRootFields()`	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
`filterCondition()`	Filters array condition before it is assiged to a Query filter.	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
`refreshInternal()`	Repopulates this active record with the latest data from a newly fetched instance.	yii\db\BaseActiveRecord
`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\db\Event	An event that is triggered after a record is deleted.	yii\db\BaseActiveRecord
`EVENT_AFTER_FIND`	\yii\db\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\db\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\db\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

Method Details

`beforeSave()` public method #

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;
}

public boolean beforeSave ( $insert )

`$insert`	boolean	Whether this method called while inserting a record. If `false`, it means the method is called while updating a record.
return	boolean	Whether the insertion or updating should continue. If `false`, the insertion or updating will be cancelled.

Method Details

beforeSave() public method #

`beforeSave()` public method #