TitleField ​
- Type
- Class
- Namespace
- craft\fieldlayoutelements
- Inherits
- craft\fieldlayoutelements\TitleField » craft\fieldlayoutelements\StandardTextField » craft\fieldlayoutelements\StandardField » 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\EntryTitleField
- Since
- 3.5.0
TitleField represents a Title field that can be included in field layouts.
Public Properties ​
Property | Description |
---|---|
attribute | string – The element attribute this field is for. |
autocapitalize | boolean – Whether the input should support auto-capitalization. |
autocomplete | string, boolean, null – The input’s autocomplete attribute value. |
autocorrect | boolean – Whether the input should support autocorrect. |
autofocus | boolean – Whether the input should get an autofocus attribute. |
class | string, string[], null – The input’s class attribute value. |
containerAttributes | array – HTML attributes for the field container |
disabled | boolean – Whether the input should get a disabled attribute. |
id | string, null – The input’s id attribute value. |
inputContainerAttributes | array – HTML attributes for the input container |
instructions | string, null – The field’s instructions |
label | string, null – The field’s label |
labelAttributes | string, null – The ID of the field label |
mandatory | boolean – Whether the field must be present within the layout. |
max | integer, null – The input’s max attribute value. |
maxlength | integer, null – The input’s maxlength attribute value. |
min | integer, null – The input’s min attribute value. |
name | string, null – The input’s name attribute value. |
orientation | string, null – The field’s orientation (ltr or rtl ) |
placeholder | string, null – The input’s placeholder attribute value. |
readonly | boolean – Whether the input should get a readonly attribute. |
requirable | boolean – Whether the field can optionally be marked as required. |
required | boolean – Whether the field is required. |
size | integer, null – The input’s size attribute value. |
step | integer, null – The input’s step attribute value. |
tip | string, null – The field’s tip text |
title | string, null – The input’s title attribute value. |
translatable | boolean – Whether the field is translatable |
type | string – The input type |
warning | string, null – The field’s warning text |
width | integer – The width (%) of the field |
attribute
​
- Type
- string
- Default value
'title'
The element attribute this field is for.
autofocus
​
- Type
- boolean
- Default value
true
Whether the input should get an autofocus
attribute.
mandatory
​
- Type
- boolean
- Default value
true
Whether the field must be present within the layout.
maxlength
​
The input’s maxlength
attribute value.
required
​
- Type
- boolean
- Default value
true
Whether the field is required.
translatable
​
- Type
- boolean
- Default value
true
Whether the field is translatable
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. |
defaultLabel() | Returns the field’s default label, which will be used if label() is null. |
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. |
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.
Arguments ​
$config
(array) – Name-value pairs that will be used to initialize the object properties
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 ​
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:
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
;firstName
andlastName
: the field names arefirstName
andlastName
, and their values are obtained from thefirst_name
andlast_name
properties;fullName
: the field name isfullName
. Its value is obtained by concatenatingfirst_name
andlast_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.
Returns ​
array – The list of field names or field definitions.
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. |
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. |
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)