Template ​
- Type
- Class
- Namespace
- craft\fieldlayoutelements
- Inherits
- craft\fieldlayoutelements\Template » craft\fieldlayoutelements\BaseUiElement » craft\base\FieldLayoutElement » yii\base\BaseObject
- Implements
- craft\base\FieldLayoutElementInterface, yii\base\Configurable
- Uses traits
- yii\base\ArrayableTrait
- Since
- 3.5.0
Template represents a UI element based on a custom template that can be included in field layouts.
Public Properties ​
| Property | Description |
|---|---|
| template | string – The template path |
| width | integer – The width (%) of the field |
template ​
- Type
- string
- Default value
null
The template path
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. |
| 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. |
| 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. |
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 ​
settingsHtml() ​
Returns the settings HTML for the layout element.
Returns ​
Protected Methods ​
| Method | Description |
|---|---|
| containerAttributes() | Returns the element container HTML attributes. |
| 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. |
| resolveFields() | Determines which fields can be returned by toArray(). |
| selectorIcon() | Returns the path to the widget’s SVG icon, or the actual SVG contents. |
| selectorLabel() | Returns the selector label. |
| selectorLabelAttributes() | Returns the selector label HTML attributes. |
selectorIcon() ​
Returns the path to the widget’s SVG icon, or the actual SVG contents.
Returns ​
selectorLabel() ​
Returns the selector label.
Returns ​
selectorLabelAttributes() ​
Returns the selector label HTML attributes.