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.
Public Properties ​
| Property | Description |
|---|---|
| instructions | string, null – The field’s instructions |
| label | string, null – The field’s label |
| required | boolean – Whether the field is required. |
| tip | string, null – The field’s tip text |
| warning | string, null – The field’s warning text |
| width | integer – The width (%) of the field |
instructions ​
The field’s instructions
label ​
The field’s label
required ​
- Type
- boolean
- Default value
false
Whether the field is required.
tip ​
The field’s tip text
warning ​
The field’s warning text
Public Methods ​
| Method | Description |
|---|---|
| __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
$confighere. - call the parent implementation at the end of the constructor.
Arguments ​
$config(array) – Name-value pairs that will be used to initialize the object properties
attribute() ​
Returns the element attribute this field is for.
Returns ​
formHtml() ​
Returns the element’s form HTMl.
Return null if the element should not be present within the form.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
hasCustomWidth() ​
Returns whether the element can have a custom width.
Returns ​
keywords() ​
Returns the search keywords for this layout element.
Returns ​
string[]
label() ​
Returns the field’s label.
Returns ​
mandatory() ​
Returns whether the field must be present within the layout.
Returns ​
requirable() ​
Returns whether the field can optionally be marked as required.
Returns ​
selectorHtml() ​
Returns the selector HTML that should be displayed within field layout designers.
Returns ​
settingsHtml() ​
Returns the settings HTML for the layout element.
Returns ​
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. |
| 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.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
defaultLabel() ​
Returns the field’s default label, which will be used if label() is null.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
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 ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
errors() ​
Returns the field’s validation errors.
Arguments ​
$element(craft\base\ElementInterface, null)
Returns ​
string[]
errorsId() ​
- Since
- 3.7.24
Returns the id of the field errors.
Returns ​
id() ​
Returns the id of the input.
Returns ​
inputContainerAttributes() ​
Returns input container HTML attributes.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
inputHtml() ​
Returns the field’s input HTML.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
instructions() ​
- Since
- 3.7.24
Returns the field’s instructions.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
instructionsId() ​
- Since
- 3.7.24
Returns the id of the field instructions.
Returns ​
labelAttributes() ​
Returns label HTML attributes.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
orientation() ​
Returns the field’s orientation (ltr or rtl).
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
selectorAttributes() ​
Returns HTML attributes that should be added to the selector container.
Returns ​
selectorInnerHtml() ​
Returns the selector’s inner HTML.
Returns ​
showLabel() ​
- Since
- 3.5.6
Returns whether the label should be shown in form inputs.
Returns ​
statusClass() ​
Returns the field’s status class.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
statusId() ​
- Since
- 3.7.29
Returns the id if the field status message.
Returns ​
statusLabel() ​
Returns the field’s status label.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
tip() ​
Returns the field’s tip text.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
tipId() ​
- Since
- 3.7.24
Returns the id of the field tip.
Returns ​
translatable() ​
Returns whether the field is translatable.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
translationDescription() ​
Returns the descriptive text for how this field is translatable.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
useFieldset() ​
- Since
- 3.6.0
Returns whether the element’s form HTML should use a <fieldset> + <legend> instead of a <div> + <label>.
Returns ​
value() ​
Returns the field’s value.
Arguments ​
$element(craft\base\ElementInterface, null)
Returns ​
mixed
warning() ​
Returns the field’s warning text.
Arguments ​
$element(craft\base\ElementInterface, null) – The element the form is being rendered for$static(boolean) – Whether the form should be static (non-interactive)
Returns ​
warningId() ​
- Since
- 3.7.24
Returns the id of the field warning.