EntryTitleField

Type
Class
Namespace
craft\fieldlayoutelements
Inherits
craft\fieldlayoutelements\EntryTitleField » craft\fieldlayoutelements\TitleField » craft\fieldlayoutelements\StandardTextField » craft\fieldlayoutelements\StandardField » 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

EntryTitleField represents a Title field that can be included within an entry type’s field layout designer.

View source (opens new window)

# Public Properties

Property Description
attribute string (opens new window) – The element attribute this field is for.
autocapitalize boolean (opens new window) – Whether the input should support auto-capitalization.
autocomplete string (opens new window), boolean (opens new window), null (opens new window) – The input’s autocomplete attribute value.
autocorrect boolean (opens new window) – Whether the input should support autocorrect.
autofocus boolean (opens new window) – Whether the input should get an autofocus attribute.
class string (opens new window), string (opens new window)[], null (opens new window) – The input’s class attribute value.
containerAttributes array (opens new window) – HTML attributes for the field container
disabled boolean (opens new window) – Whether the input should get a disabled attribute.
id string (opens new window), null (opens new window) – The input’s id attribute value.
inputContainerAttributes array (opens new window) – HTML attributes for the input container
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
labelAttributes string (opens new window), null (opens new window) – The ID of the field label
mandatory boolean (opens new window) – Whether the field must be present within the layout.
max integer (opens new window), null (opens new window) – The input’s max attribute value.
maxlength integer (opens new window), null (opens new window) – The input’s maxlength attribute value.
min integer (opens new window), null (opens new window) – The input’s min attribute value.
name string (opens new window), null (opens new window) – The input’s name attribute value.
orientation string (opens new window), null (opens new window) – The field’s orientation (ltr or rtl)
placeholder string (opens new window), null (opens new window) – The input’s placeholder attribute value.
readonly boolean (opens new window) – Whether the input should get a readonly attribute.
requirable boolean (opens new window) – Whether the field can optionally be marked as required.
required boolean (opens new window) – Whether the field is required.
size integer (opens new window), null (opens new window) – The input’s size attribute value.
step integer (opens new window), null (opens new window) – The input’s step attribute value.
tip string (opens new window), null (opens new window) – The field’s tip text
title string (opens new window), null (opens new window) – The input’s title attribute value.
translatable boolean (opens new window) – Whether the field is translatable
type string (opens new window) – The input type
warning string (opens new window), null (opens new window) – The field’s warning text
width integer (opens new window) – The width (%) of the field

# 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.
defaultLabel() Returns the field’s default label, which will be used if label() is null.
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.
inputHtml() Returns the field’s input HTML.
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.

# inputHtml()

Returns the field’s input HTML.

View source (opens new window)

Arguments

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

# selectorInnerHtml()

Returns the selector’s inner HTML.

View source (opens new window)

Returns

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