Field

Type

Class

Namespace

craft\records

Inherits

craft\records\Field » 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

Since

3.0.0

Class Field record.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
columnSuffix	string, null
context	string – Context
dateCreated	DateTime, string, null – Date created
dateUpdated	DateTime, string, null – Date updated
dirtyAttributes	array – The changed attribute values (name-value pairs).
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
group	craft\records\FieldGroup – Group
groupId	integer – Group ID
handle	string – Handle
id	integer – ID
instructions	string – Instructions
isNewRecord	boolean – Whether the record is new and should be inserted when calling save().
iterator	ArrayIterator – An iterator for traversing the items in the list.
name	string – Name
oldAttributes	array – The old attribute values (name-value pairs).
oldColumnSuffix	string, null
oldHandle	string, null
oldPrimaryKey	mixed – The old primary key value.
primaryKey	mixed – The primary key value.
relatedRecords	array – An array of related records indexed by relation names.
scenario	string – The scenario that this model is in.
searchable	boolean – Searchable
settings	array – Settings
translationKeyFormat	string – Translation key format
translationMethod	string – Translation method
type	string – Type
uid	string – UUID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

columnSuffix

Type

string, null

Default value

null

View source

context

Type

string

Default value

null

Context

View source

group

Type

craft\records\FieldGroup

Default value

null

Group

View source

groupId

Type

integer

Default value

null

Group ID

View source

handle

Type

string

Default value

null

Handle

View source

id

Type

integer

Default value

null

ID

View source

instructions

Type

string

Default value

null

Instructions

View source

name

Type

string

Default value

null

Name

View source

oldColumnSuffix

Type

string, null

Default value

null

Access

Read-only

Since

3.7.0

View source

oldHandle

Type

string, null

Default value

null

Access

Read-only

View source

searchable

Type

boolean

Default value

null

Searchable

View source

settings

Type

array

Default value

null

Settings

View source

translationKeyFormat

Type

string

Default value

null

Translation key format

View source

translationMethod

Type

string

Default value

null

Translation method

View source

type

Type

string

Default value

null

Type

View source

Public Methods

Method	Description
__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.
getGroup()	Returns the field’s group.
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.
getOldColumnSuffix()	Returns the old column suffix.
getOldHandle()	Returns the old handle.
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.
storeOldData()	Store the old handle.
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.

getGroup()

Returns the field’s group.

View source

Returns

yii\db\ActiveQueryInterface – The relational query object.

getOldColumnSuffix()

Since

3.7.0

Returns the old column suffix.

View source

Returns

string, null

getOldHandle()

Returns the old handle.

View source

Returns

string, null

init()

Initializes the object.

This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event.

View source

storeOldData()

Store the old handle.

View source

tableName()

Declares the name of the database table associated with this AR class.

By default this method returns the class name as the table name by calling yii\helpers\Inflector::camel2id() with prefix yii\db\Connection::$tablePrefix. For example if yii\db\Connection::$tablePrefix is tbl_, Customer becomes tbl_customer, and OrderItem becomes tbl_order_item. You may override this method if the table is not named after this convention.

View source

Returns

string – The table name

Protected Methods

Method	Description
createRelationQuery()	Creates a query instance for has-one or has-many relation.
deleteInternal()	Deletes an ActiveRecord without considering transaction.
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".
extractRootFields()	Extracts the root field names from nested fields.
insertInternal()	Inserts an ActiveRecord into DB without considering transaction.
prepareForDb()	Sets the dateCreated, dateUpdated, and uid attributes on the record.
refreshInternal()	Repopulates this active record with the latest data from a newly fetched instance.
resolveFields()	Determines which fields can be returned by toArray().
updateInternal()

Constants

Constant	Description
OP_ALL	All three operations: insert, update, delete.
OP_DELETE	The delete operation. This is mainly used when overriding transactions() to specify which operations are transactional.
OP_INSERT	The insert operation. This is mainly used when overriding transactions() to specify which operations are transactional.
OP_UPDATE	The update operation. This is mainly used when overriding transactions() to specify which operations are transactional.
SCENARIO_DEFAULT	The name of the default scenario.