FieldInterface

Type
Interface
Namespace
craft\base
Extends
craft\base\SavableComponentInterface
Implemented by
craft\base\Field, craft\fields\BaseOptionsField, craft\fields\Checkboxes, craft\fields\Color, craft\fields\Date, craft\fields\Dropdown, craft\fields\Email, craft\fields\Lightswitch, craft\fields\Matrix, craft\fields\MissingField, craft\fields\MultiSelect, craft\fields\Number, craft\fields\PlainText, craft\fields\RadioButtons, craft\fields\Table, craft\fields\Url
Since
3.0

FieldInterface defines the common interface to be implemented by field classes.

A class implementing this interface should also use craft\base\SavableComponentTrait and craft\base\FieldTrait.

View source

Public Methods

MethodDescription
afterDelete()Performs actions after a component is deleted.
afterElementDelete()Performs actions after the element has been deleted.
afterElementSave()Performs actions after the element has been saved.
afterSave()Performs actions after a component is saved.
beforeDelete()Performs actions before a component is deleted.
beforeElementDelete()Performs actions before an element is deleted.
beforeElementSave()Performs actions before an element is saved.
beforeSave()Performs actions before a component is saved.
displayName()Returns the display name of this class.
getContentColumnType()Returns the column type that this field should get within the content table.
getElementValidationRules()Returns the validation rules for an element with this field.
getGroup()Returns the field’s group.
getInputHtml()Returns the field’s input HTML.
getIsNew()Returns whether the component is new (unsaved).
getIsTranslatable()Returns whether the field should be shown as translatable in the UI.
getSearchKeywords()Returns the search keywords that should be associated with this field.
getSettings()Returns an array of the component’s settings.
getSettingsHtml()Returns the component’s settings HTML.
getStaticHtml()Returns a static (non-editable) version of the field’s input HTML.
getTranslationKey()Returns the field’s translation key, based on a given element.
hasContentColumn()Returns whether this field has a column in the content table.
isSelectable()Returns whether the component should be selectable in component Type selects.
isValueEmpty()Returns whether the given value should be considered “empty” to a validator.
modifyElementIndexQuery()Modifies an element index query.
modifyElementsQuery()Modifies an element query.
normalizeValue()Normalizes the field’s value for use.
serializeValue()Prepares the field’s value to be stored somewhere, like the content table or JSON-encoded in an entry revision table.
setIsFresh()Sets whether the field is fresh.
settingsAttributes()Returns the list of settings attribute names.
supportedTranslationMethods()Returns which translation methods the field supports.
validate()Validates the component.

afterElementDelete()

Performs actions after the element has been deleted.

View source

Arguments

Signature

public abstract void afterElementDelete ( craft\base\ElementInterface $element )

afterElementSave()

Performs actions after the element has been saved.

View source

Arguments

Signature

public abstract void afterElementSave ( craft\base\ElementInterface $element, \craft\base\bool $isNew )

beforeElementDelete()

Performs actions before an element is deleted.

View source

Arguments

Returns

boolean – Whether the element should be deleted

Signature

public abstract boolean beforeElementDelete ( craft\base\ElementInterface $element )

beforeElementSave()

Performs actions before an element is saved.

View source

Arguments

Returns

boolean – Whether the element should be saved

Signature

public abstract boolean beforeElementSave ( craft\base\ElementInterface $element, \craft\base\bool $isNew )

getContentColumnType()

Returns the column type that this field should get within the content table. This method will only be called if hasContentColumn() returns true. See also yii\db\QueryBuilder::getColumnType()View source

Returns

string – The column type. yii\db\QueryBuilder::getColumnType() will be called to convert the give column type to the physical one. For example, string will be converted as varchar(255) and string(100) becomes varchar(100). not null will automatically be appended as well.

Signature

public abstract string getContentColumnType ( )

getElementValidationRules()

Returns the validation rules for an element with this field. Rules should be defined in the array syntax required by yii\base\Model::rules(), with one difference: you can skip the first argument (the attribute list).

[
    // explicitly specify the field attribute
    [$this->handle, 'string', 'min' => 3, 'max' => 12],
    // skip the field attribute
    ['string', 'min' => 3, 'max' => 12],
    // you can only pass the validator class name/handle if not setting any params
    'bool',
]

To register validation rules that should only be enforced for live elements, set the rule scenario to live:

[
    ['string', 'min' => 3, 'max' => 12, 'on' => \craft\base\Element::SCENARIO_LIVE],
]

View source

Returns

array

Signature

public abstract array getElementValidationRules ( )

getGroup()

Returns the field’s group.

View source

Returns

craft\records\FieldGroup, null

Signature

public abstract craft\records\FieldGroup, null getGroup ( )

getInputHtml()

Returns the field’s input HTML. An extremely simple implementation would be to directly return some HTML:

return '<textarea name="'.$name.'">'.$value.'</textarea>';

For more complex inputs, you might prefer to create a template, and render it via craft\web\View::renderTemplate(). For example, the following code would render a template located at path/to/myplugin/templates/_fieldinput.html, passing the $name and $value variables to it:

return Craft::$app->view->renderTemplate('myplugin/_fieldinput', [
    'name'  => $name,
    'value' => $value
]);

If you need to tie any JavaScript code to your input, it’s important to know that any name= and id= attributes within the returned HTML will probably get namespaced, however your JavaScript code will be left untouched. For example, if getInputHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id= attribute was changed from foo to namespace-foo. Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, craft\web\View provides a couple handy methods that can help you deal with this:

So here’s what a getInputHtml() method that includes field-targeting JavaScript code might look like:

public function getInputHtml($value, $element)
{
    // Come up with an ID value based on $name
    $id = Craft::$app->view->formatInputId($name);
    // Figure out what that ID is going to be namespaced into
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('myplugin/_fieldinput', [
        'name'         => $name,
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'value'        => $value
    ]);
}

And the _fieldinput.html template might look like this:

<textarea id="{{ id }}" name="{{ name }}">{{ value }}</textarea>
<script type="text/javascript">
    var textarea = document.getElementById('{{ namespacedId }}');
</script>

The same principles also apply if you’re including your JavaScript code with craft\web\View::registerJs().

View source

Arguments

  • $value (mixed) – The field’s value. This will either be the normalized value, raw POST data (i.e. if there was a validation error), or null
  • $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one

Returns

string – The input HTML.

Signature

public abstract string getInputHtml ( $value, craft\base\ElementInterface $element = null )

getIsTranslatable()

Returns whether the field should be shown as translatable in the UI. Note this method has no effect on whether the field’s value will get copied over to other sites when the entry is actually getting saved. That is determined by getTranslationKey().

View source

Arguments

Returns

boolean

Signature

public abstract boolean getIsTranslatable ( craft\base\ElementInterface $element = null )

getSearchKeywords()

Returns the search keywords that should be associated with this field. The keywords can be separated by commas and/or whitespace; it doesn’t really matter. craft\services\Search will be able to find the individual keywords in whatever string is returned, and normalize them for you.

View source

Arguments

  • $value (mixed) – The field’s value
  • $element (craft\base\ElementInterface) – The element the field is associated with, if there is one

Returns

string – A string of search keywords.

Signature

public abstract string getSearchKeywords ( $value, craft\base\ElementInterface $element )

getStaticHtml()

Returns a static (non-editable) version of the field’s input HTML. This function is called to output field values when viewing entry drafts.

View source

Arguments

Returns

string – The static version of the field’s input HTML

Signature

public abstract string getStaticHtml ( $value, craft\base\ElementInterface $element )

getTranslationKey()

Returns the field’s translation key, based on a given element. When saving an element on a multi-site Craft install, if $propagate is true for craft\services\Elements::saveElement(), then getTranslationKey() will be called for each custom field and for each site the element should be propagated to. If the method returns the same value as it did for the initial site, then the initial site’s value will be copied over to the target site.

View source

Arguments

Returns

string – The translation key

Signature

public abstract string getTranslationKey ( craft\base\ElementInterface $element )

hasContentColumn()

Returns whether this field has a column in the content table.

View source

Returns

boolean

Signature

public abstract static boolean hasContentColumn ( )

isValueEmpty()

Returns whether the given value should be considered “empty” to a validator.

See also yii\validators\Validator::$isEmptyView source

Arguments

  • $value (mixed) – The field’s value
  • $element (craft\base\ElementInterface) – The element the field is associated with, if there is one

Returns

boolean – Whether the value should be considered “empty”

Signature

public abstract boolean isValueEmpty ( $value, craft\base\ElementInterface $element )

modifyElementIndexQuery()

Modifies an element index query. This method will be called whenever an element index is being loaded, which contains a column for this field.

View source

Arguments

Signature

public abstract void modifyElementIndexQuery ( craft\elements\db\ElementQueryInterface $query )

modifyElementsQuery()

Modifies an element query. This method will be called whenever elements are being searched for that may have this field assigned to them. If the method returns false, the query will be stopped before it ever gets a chance to execute.

View source

Arguments

Returns

null, falsefalse in the event that the method is sure that no elements are going to be found.

Signature

public abstract null, false modifyElementsQuery ( craft\elements\db\ElementQueryInterface $query, $value )

normalizeValue()

Normalizes the field’s value for use. This method is called when the field’s value is first accessed from the element. For example, the first time entry.myFieldHandle is called from a template, or right before getInputHtml() is called. Whatever this method returns is what entry.myFieldHandle will likewise return, and what getInputHtml()’s and serializeValue()’s $value arguments will be set to.

View source

Arguments

Returns

mixed – The prepared field value

Signature

public abstract mixed normalizeValue ( $value, craft\base\ElementInterface $element = null )

serializeValue()

Prepares the field’s value to be stored somewhere, like the content table or JSON-encoded in an entry revision table. Data types that are JSON-encodable are safe (arrays, integers, strings, booleans, etc). Whatever this returns should be something normalizeValue() can handle.

View source

Arguments

Returns

mixed – The serialized field value

Signature

public abstract mixed serializeValue ( $value, craft\base\ElementInterface $element = null )

setIsFresh()

Sets whether the field is fresh.

View source

Arguments

  • $isFresh (boolean, null) – Whether the field is fresh.

Signature

public abstract void setIsFresh ( \craft\base\bool $isFresh = null )

supportedTranslationMethods()

Returns which translation methods the field supports. This method should return an array with at least one of the following values:

  • 'none' (values will always be copied to other sites)
  • 'language' (values will be copied to other sites with the same language)
  • 'site' (values will never be copied to other sites)
  • 'custom' (values will be copied/not copied depending on a custom translation key) See also getTranslationKey()View source

Returns

string[]

Signature

public abstract static string[] supportedTranslationMethods ( )