Skip to content

BaseField

Type
Abstract Class
Namespace
craft\fieldlayoutelements
Inherits
craft\fieldlayoutelements\BaseField » craft\base\FieldLayoutElement » craft\base\FieldLayoutComponent » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by
craft\fieldlayoutelements\BaseNativeField, craft\fieldlayoutelements\CustomField, craft\fieldlayoutelements\FullNameField, craft\fieldlayoutelements\TextField, craft\fieldlayoutelements\TextareaField, craft\fieldlayoutelements\TitleField, craft\fieldlayoutelements\addresses\AddressField, craft\fieldlayoutelements\addresses\CountryCodeField, craft\fieldlayoutelements\addresses\LabelField, craft\fieldlayoutelements\addresses\LatLongField, craft\fieldlayoutelements\addresses\OrganizationField, craft\fieldlayoutelements\addresses\OrganizationTaxIdField, craft\fieldlayoutelements\assets\AltField, craft\fieldlayoutelements\assets\AssetTitleField, craft\fieldlayoutelements\entries\EntryTitleField, craft\fieldlayoutelements\users\AddressesField
Since
3.5.0

BaseField is the base class for native and custom fields that can be included in field layouts.

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.
elementConditioncraft\elements\conditions\ElementConditionInterface, null – The element condition for this layout element
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
instructionsstring, null – The field’s instructions
iteratorArrayIterator – An iterator for traversing the items in the list.
labelstring, null – The field’s label
layoutcraft\models\FieldLayout – The layout this element belongs to
requiredboolean – Whether the field is required.
scenariostring – The scenario that this model is in.
settingsHtmlstring
tipstring, null – The field’s tip text
uidstring, null – The UUID of the layout element.
userConditioncraft\elements\conditions\users\UserCondition, null – The user condition for this layout element
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
warningstring, null – The field’s warning text
widthinteger – The width (%) of the field

instructions

Type
string, null
Default value
null

The field’s instructions

View source

label

Type
string, null
Default value
null

The field’s label

View source

required

Type
boolean
Default value
false

Whether the field is required.

View source

tip

Type
string, null
Default value
null

The field’s tip text

View source

warning

Type
string, null
Default value
null

The field’s warning text

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__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.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attribute()Returns the element attribute this field is for.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
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().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
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.
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.
formHtml()Returns the element’s form HTMl.
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.
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.
getElementCondition()Returns the element condition for this layout element.
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.
getIterator()Returns an iterator for traversing the attributes in the model.
getLayout()Returns the layout this element belongs to.
getScenario()Returns the scenario that this model is used in.
getSettingsHtml()Returns the settings HTML for the layout element.
getUserCondition()Returns the user condition for this layout element.
getValidators()Returns all the validators declared in rules().
hasConditions()Returns whether this element has any conditions.
hasCustomWidth()Returns whether the element can have a custom width.
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.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
keywords()Returns the search keywords for this layout element.
label()Returns the field’s label.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
mandatory()Returns whether the field must be present within the layout.
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.
requirable()Returns whether the field can optionally be marked as required.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
selectorHtml()Returns the selector HTML that should be displayed within field layout designers.
setAttributes()Sets the attribute values in a massive way.
setElementCondition()Sets the element condition for this layout element.
setLayout()Sets the layout this element belongs to.
setScenario()Sets the scenario for the model.
setUserCondition()Sets the user condition for this layout element.
showAttribute()Returns whether the attribute should be shown for admin users with “Show field handles in edit forms” enabled.
showInForm()Returns whether the layout element should be shown in an edit form for the given element.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

__construct()

View source

Arguments

  • $config

attribute()

Returns the element attribute this field is for.

View source

Returns

string

formHtml()

Returns the element’s form HTMl.

Return null if the element should not be present within the form.

View source

Arguments

Returns

string, null

hasCustomWidth()

Returns whether the element can have a custom width.

View source

Returns

boolean

keywords()

Returns the search keywords for this layout element.

View source

Returns

string[]

label()

Returns the field’s label.

View source

Returns

string, null

mandatory()

Returns whether the field must be present within the layout.

View source

Returns

boolean

requirable()

Returns whether the field can optionally be marked as required.

View source

Returns

boolean

selectorHtml()

Returns the selector HTML that should be displayed within field layout designers.

View source

Returns

string

showAttribute()

Since
4.5.4

Returns whether the attribute should be shown for admin users with “Show field handles in edit forms” enabled.

View source

Returns

boolean

Protected Methods

MethodDescription
conditional()Returns whether this element can be conditional.
containerAttributes()Returns the element container HTML attributes.
defaultInstructions()Returns the field’s default instructions, which will be used if instructions() is null.
defaultLabel()Returns the field’s default label, which will be used if label() is null.
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()Returns the validation rules for attributes.
describedBy()Returns the aria-describedby attribute value that should be set on the focusable input(s).
errors()Returns the field’s validation errors.
errorsId()Returns the id of the field errors.
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.
id()Returns the id of the input.
inputContainerAttributes()Returns input container HTML attributes.
inputHtml()Returns the field’s input HTML.
instructions()Returns the field’s instructions.
instructionsId()Returns the id of the field instructions.
labelAttributes()Returns label HTML attributes.
labelId()Returns the id of the field label.
orientation()Returns the field’s orientation (ltr or rtl).
resolveFields()Determines which fields can be returned by toArray().
selectorAttributes()Returns HTML attributes that should be added to the selector container.
selectorInnerHtml()Returns the selector’s inner HTML.
selectorLabel()Returns the selector label.
settingsHtml()Returns the settings HTML for the layout element.
showLabel()Returns whether the label should be shown in form inputs.
statusClass()Returns the field’s status class.
statusId()Returns the id if the field status message.
statusLabel()Returns the field’s status label.
tip()Returns the field’s tip text.
tipId()Returns the id of the field tip.
translatable()Returns whether the field is translatable.
translationDescription()Returns the descriptive text for how this field is translatable.
useFieldset()Returns whether the element’s form HTML should use a <fieldset> + <legend> instead of a <div> + <label>.
value()Returns the field’s value.
warning()Returns the field’s warning text.
warningId()Returns the id of the field warning.

defaultInstructions()

Returns the field’s default instructions, which will be used if instructions() is null.

View source

Arguments

Returns

string, null

defaultLabel()

Returns the field’s default label, which will be used if label() is null.

View source

Arguments

Returns

string, null

describedBy()

Since
3.7.24

Returns the aria-describedby attribute value that should be set on the focusable input(s).

See also inputHtml()View source

Arguments

Returns

string, null

errors()

Returns the field’s validation errors.

View source

Arguments

Returns

string[]

errorsId()

Since
3.7.24

Returns the id of the field errors.

View source

Returns

string

id()

Returns the id of the input.

View source

Returns

string

inputContainerAttributes()

Returns input container HTML attributes.

View source

Arguments

Returns

array

inputHtml()

Returns the field’s input HTML.

View source

Arguments

Returns

string, null

instructions()

Since
3.7.24

Returns the field’s instructions.

View source

Arguments

Returns

string, null

instructionsId()

Since
3.7.24

Returns the id of the field instructions.

View source

Returns

string

labelAttributes()

Returns label HTML attributes.

View source

Arguments

Returns

array

labelId()

Since
4.1.0

Returns the id of the field label.

View source

Returns

string

orientation()

Returns the field’s orientation (ltr or rtl).

View source

Arguments

Returns

string

selectorAttributes()

Returns HTML attributes that should be added to the selector container.

View source

Returns

array

selectorInnerHtml()

Returns the selector’s inner HTML.

View source

Returns

string

selectorLabel()

Since
4.0.0

Returns the selector label.

View source

settingsHtml()

Returns the settings HTML for the layout element.

View source

Returns

string, null

showLabel()

Since
3.5.6

Returns whether the label should be shown in form inputs.

View source

Returns

boolean

statusClass()

Returns the field’s status class.

View source

Arguments

Returns

string, null

statusId()

Since
3.7.29

Returns the id if the field status message.

View source

Returns

string

statusLabel()

Returns the field’s status label.

View source

Arguments

Returns

string, null

tip()

Returns the field’s tip text.

View source

Arguments

Returns

string, null

tipId()

Since
3.7.24

Returns the id of the field tip.

View source

Returns

string

translatable()

Returns whether the field is translatable.

View source

Arguments

Returns

boolean

translationDescription()

Returns the descriptive text for how this field is translatable.

View source

Arguments

Returns

string, null

useFieldset()

Since
3.6.0

Returns whether the element’s form HTML should use a <fieldset> + <legend> instead of a <div> + <label>.

View source

Returns

boolean

value()

Returns the field’s value.

View source

Arguments

Returns

mixed

warning()

Returns the field’s warning text.

View source

Arguments

Returns

string, null

warningId()

Since
3.7.24

Returns the id of the field warning.

View source

Returns

string

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.