BaseField

Type
Abstract Class
Namespace
craft\fieldlayoutelements
Inherits
craft\fieldlayoutelements\BaseField » craft\base\FieldLayoutElement » yii\base\BaseObject (opens new window)
Implements
craft\base\FieldLayoutElementInterface, yii\base\Configurable (opens new window)
Uses traits
yii\base\ArrayableTrait (opens new window)
Extended by
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 (opens new window)

# Public Properties

Property Description
instructions string (opens new window), null (opens new window) – The field’s instructions
label string (opens new window), null (opens new window) – The field’s label
required boolean (opens new window) – Whether the field is required.
tip string (opens new window), null (opens new window) – The field’s tip text
warning string (opens new window), null (opens new window) – The field’s warning text
width integer (opens new window) – The width (%) of the field

# instructions

Type
string (opens new window), null (opens new window)
Default value
null

The field’s instructions

View source (opens new window)

# label

Type
string (opens new window), null (opens new window)
Default value
null

The field’s label

View source (opens new window)

# required

Type
boolean (opens new window)
Default value
false

Whether the field is required.

View source (opens new window)

# tip

Type
string (opens new window), null (opens new window)
Default value
null

The field’s tip text

View source (opens new window)

# warning

Type
string (opens new window), null (opens new window)
Default value
null

The field’s warning text

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
attribute() Returns the element attribute this field is for.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formHtml() Returns the element’s form HTMl.
hasCustomWidth() Returns whether the element can have a custom width.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) 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() (opens new window) Converts the model into an array.

# __construct()

Constructor.

The default implementation does two things:

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 (opens new window)

Arguments

# attribute()

Returns the element attribute this field is for.

View source (opens new window)

Returns

string (opens new window)

# formHtml()

Returns the element’s form HTMl.

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

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# hasCustomWidth()

Returns whether the element can have a custom width.

View source (opens new window)

Returns

boolean (opens new window)

# keywords()

Returns the search keywords for this layout element.

View source (opens new window)

Returns

string (opens new window)[]

# label()

Returns the field’s label.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# mandatory()

Returns whether the field must be present within the layout.

View source (opens new window)

Returns

boolean (opens new window)

# requirable()

Returns whether the field can optionally be marked as required.

View source (opens new window)

Returns

boolean (opens new window)

# selectorHtml()

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

View source (opens new window)

Returns

string (opens new window)

# settingsHtml()

Returns the settings HTML for the layout element.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# Protected Methods

Method Description
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.
errors() Returns the field’s validation errors.
extractFieldsFor() (opens new window) 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() (opens new window) 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.
labelAttributes() Returns label HTML attributes.
orientation() Returns the field’s orientation (ltr or rtl).
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
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.
statusLabel() Returns the field’s status label.
tip() Returns the field’s tip text.
translatable() Returns whether the field is translatable.
translationDescription() Returns the descriptive text for how this field is translatable.
value() Returns the field’s value.
warning() Returns the field’s warning text.

# defaultInstructions()

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

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# defaultLabel()

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

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# errors()

Returns the field’s validation errors.

View source (opens new window)

Arguments

Returns

string (opens new window)[]

# id()

Returns the id of the input.

View source (opens new window)

Returns

string (opens new window)

# inputContainerAttributes()

Returns input container HTML attributes.

View source (opens new window)

Arguments

Returns

array (opens new window)

# inputHtml()

Returns the field’s input HTML.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# labelAttributes()

Returns label HTML attributes.

View source (opens new window)

Arguments

Returns

array (opens new window)

# orientation()

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

View source (opens new window)

Arguments

Returns

string (opens new window)

# selectorAttributes()

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

View source (opens new window)

Returns

array (opens new window)

# selectorInnerHtml()

Returns the selector’s inner HTML.

View source (opens new window)

Returns

string (opens new window)

# showLabel()

Since
3.5.6

Returns whether the label should be shown in form inputs.

View source (opens new window)

Returns

boolean (opens new window)

# statusClass()

Returns the field’s status class.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# statusLabel()

Returns the field’s status label.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# tip()

Returns the field’s tip text.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# translatable()

Returns whether the field is translatable.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# translationDescription()

Returns the descriptive text for how this field is translatable.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# value()

Returns the field’s value.

View source (opens new window)

Arguments

Returns

mixed

# warning()

Returns the field’s warning text.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)