CustomField
- Type
- Class
- Namespace
- craft\fieldlayoutelements
- Inherits
- craft\fieldlayoutelements\CustomField » 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
- Since
- 3.5.0
CustomField represents a custom field that can be included in field layouts.
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. |
| elementCondition | craft\elements\conditions\ElementConditionInterface, null – The element condition for this layout element |
| errors | array – Errors for all attributes or the specified attribute. |
| field | craft\base\FieldInterface – The custom field this layout field is based on |
| fieldUid | string – The UID of the field this layout field is based on |
| firstErrors | array – The first errors. |
| instructions | string, null – The field’s instructions |
| iterator | ArrayIterator – An iterator for traversing the items in the list. |
| label | string, null – The field’s label |
| layout | craft\models\FieldLayout – The layout this element belongs to |
| required | boolean – Whether the field is required. |
| scenario | string – The scenario that this model is in. |
| settingsHtml | string |
| tip | string, null – The field’s tip text |
| uid | string, null – The UUID of the layout element. |
| userCondition | craft\elements\conditions\users\UserCondition, null – The user condition for this layout element |
| validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
| warning | string, null – The field’s warning text |
| width | integer – The width (%) of the field |
field
- Type
- craft\base\FieldInterface
- Default value
null
The custom field this layout field is based on
fieldUid
- Type
- string
- Default value
null
The UID of the field this layout field is based on
Public Methods
| Method | Description |
|---|---|
| __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. |
| getField() | Returns the custom field this layout field is based on. |
| getFieldUid() | Returns the UID of the field this layout field is based on. |
| 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. |
| setField() | Sets the custom field this layout field is based on. |
| setFieldUid() | Sets the UID of the field this layout field is based on. |
| 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()
Arguments
$field(craft\base\FieldInterface, null)$config
attribute()
Returns the element attribute this field is for.
Returns
fields()
Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
A field is a named element in the returned array by toArray().
This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:
php
function ($model, $field) {
// return field value
}For example, the following code declares four fields:
email: the field name is the same as the property nameemail;firstNameandlastName: the field names arefirstNameandlastName, and their values are obtained from thefirst_nameandlast_nameproperties;fullName: the field name isfullName. Its value is obtained by concatenatingfirst_nameandlast_name.
php
return [
'email',
'firstName' => 'first_name',
'lastName' => 'last_name',
'fullName' => function () {
return $this->first_name . ' ' . $this->last_name;
},
];In this method, you may also want to return different lists of fields based on some context information. For example, depending on the privilege of the current application user, you may return different sets of visible fields or filter out some fields.
The default implementation of this method returns the public object member variables indexed by themselves.
Returns
array – The list of field names or field definitions.
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
getField()
Returns the custom field this layout field is based on.
Returns
getFieldUid()
Returns the UID of the field this layout field is based on.
Returns
requirable()
Returns whether the field can optionally be marked as required.
Returns
setField()
Sets the custom field this layout field is based on.
Arguments
$field(craft\base\FieldInterface)
setFieldUid()
Sets the UID of the field this layout field is based on.
Arguments
$uid(string)
Throws
- craft\errors\FieldNotFoundException
if $uid is invalid
showAttribute()
- Since
- 4.5.4
Returns whether the attribute should be shown for admin users with “Show field handles in edit forms” enabled.
Returns
Protected Methods
| Method | Description |
|---|---|
| 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. |
containerAttributes()
Returns the element 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
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
id()
Returns the id of the input.
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
labelId()
- Since
- 4.1.0
Returns the id of the field label.
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
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
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
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()
- Since
- 3.5.2
Returns the field’s value.
Arguments
$element(craft\base\ElementInterface, null)
Returns
mixed
Constants
| Constant | Description |
|---|---|
SCENARIO_DEFAULT | The name of the default scenario. |