CustomField

Type

Class

Namespace

craft\fieldlayoutelements

Inherits

craft\fieldlayoutelements\CustomField » 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)

Since

3.5.0

CustomField represents a custom field that can be included in field layouts.

View source (opens new window)

Public Properties

Property	Description
field	craft\base\FieldInterface – The custom field this layout field is based on
fieldUid	string (opens new window) – The UID of the field this layout field is based on
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

field

Type

craft\base\FieldInterface

Default value

null

The custom field this layout field is based on

View source (opens new window)

fieldUid

Type

string (opens new window)

Default value

null

The UID of the field this layout field is based on

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()	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.
getField()	Returns the custom field this layout field is based on.
getFieldUid()	Returns the UID of the field this layout field is based on.
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.
setField()	Sets the custom field this layout field is based on.
setFieldUid()	Sets the UID of the field this layout field is based on.
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:

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

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

• $field (craft\base\FieldInterface, null (opens new window))
• $config (array (opens new window)) – Name-value pairs that will be used to initialize the object properties

attribute()

Returns the element attribute this field is for.

View source (opens new window)

Returns

string (opens new window)

fields()

Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.

A field is a named element in the returned array by toArray() (opens new window).

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:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

• email: the field name is the same as the property name email;
• firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
• fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.

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.

View source (opens new window)

Returns

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

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

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

getField()

Returns the custom field this layout field is based on.

View source (opens new window)

Returns

craft\base\FieldInterface

getFieldUid()

Returns the UID of the field this layout field is based on.

View source (opens new window)

Returns

string (opens new window)

requirable()

Returns whether the field can optionally be marked as required.

View source (opens new window)

Returns

boolean (opens new window)

setField()

Sets the custom field this layout field is based on.

View source (opens new window)

Arguments

• $field (craft\base\FieldInterface)

setFieldUid()

Sets the UID of the field this layout field is based on.

View source (opens new window)

Arguments

• $uid (string (opens new window))

Throws

• yii\base\InvalidArgumentException (opens new window)
  if $uid is invalid

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() (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.
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() (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.
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.

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

array (opens new window)

defaultInstructions()

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

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

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

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

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

id()

Returns the id of the input.

View source (opens new window)

Returns

string (opens new window)

inputHtml()

Returns the field’s input HTML.

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

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

orientation()

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

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

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)

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

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

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

statusLabel()

Returns the field’s status label.

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

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

translatable()

Returns whether the field is translatable.

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

boolean (opens new window)

translationDescription()

Returns the descriptive text for how this field is translatable.

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for
• $static (boolean (opens new window)) – Whether the form should be static (non-interactive)

Returns

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

useFieldset()

Since

3.6.0

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

View source (opens new window)

Returns

boolean (opens new window)

value()

Since

3.5.2

Returns the field’s value.

View source (opens new window)

Arguments

• $element (craft\base\ElementInterface, null (opens new window))

Returns

mixed