Skip to content

BaseField

Type
Abstract Class
Namespace
craft\fieldlayoutelements
Inherits
craft\fieldlayoutelements\BaseField » craft\base\FieldLayoutElement » yii\base\BaseObject
Implements
craft\base\FieldLayoutElementInterface, yii\base\Configurable
Uses traits
yii\base\ArrayableTrait
Extended by
craft\fieldlayoutelements\AssetTitleField, craft\fieldlayoutelements\CustomField, craft\fieldlayoutelements\EntryTitleField, craft\fieldlayoutelements\StandardField, craft\fieldlayoutelements\StandardTextField, craft\fieldlayoutelements\TitleField
Since
3.5.0

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

View source

Public Properties

PropertyDescription
instructionsstring, null – The field’s instructions
labelstring, null – The field’s label
requiredboolean – Whether the field is required.
tipstring, null – The field’s tip text
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.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
attribute()Returns the element attribute this field is for.
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.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()
formHtml()Returns the element’s form HTMl.
hasCustomWidth()Returns whether the element can have a custom width.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
keywords()Returns the search keywords for this layout element.
label()Returns the field’s label.
mandatory()Returns whether the field must be present within the layout.
requirable()Returns whether the field can optionally be marked as required.
selectorHtml()Returns the selector HTML that should be displayed within field layout designers.
settingsHtml()Returns the settings HTML for the layout element.
toArray()Converts the model into an array.

__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.

View source

Arguments

  • $config (array) – Name-value pairs that will be used to initialize the object properties

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

settingsHtml()

Returns the settings HTML for the layout element.

View source

Returns

string, null

Protected Methods

MethodDescription
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.
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.
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.
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

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

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