Method Details

afterElementDelete() public abstract method #

Performs actions after the element has been deleted.

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

afterElementSave() public abstract method #

Performs actions after the element has been saved.

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

beforeElementDelete() public abstract method #

Performs actions before an element is deleted.

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

beforeElementSave() public abstract method #

Performs actions before an element is saved.

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

getContentColumnType() public abstract method #

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

public abstract string getContentColumnType ( )

getElementValidationRules() public abstract method #

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). Below are some examples:

[
    // 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',
];

public abstract array getElementValidationRules ( )

getGroup() public abstract method #

Returns the field’s group.

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

getInputHtml() public abstract method #

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:

• craft\web\View::namespaceInputId() will give you the namespaced version of a given ID.
• craft\web\View::namespaceInputName() will give you the namespaced version of a given input name.
• craft\web\View::formatInputId() will format an input name to look more like an ID attribute value.

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

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

getIsTranslatable() public abstract method #

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

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

getSearchKeywords() public abstract method #

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.

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

getStaticHtml() public abstract method #

Returns a static (non-editable) version of the field’s input HTML.

This function is called to output field values when viewing entry drafts.

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

getTranslationKey() public abstract method #

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.

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

hasContentColumn() public abstract static method #

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

public abstract static boolean hasContentColumn ( )

isValueEmpty() public abstract method #

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

See also yii\validators\Validator::$isEmpty.

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

modifyElementsQuery() public abstract method #

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.

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

normalizeValue() public abstract method #

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.

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

serializeValue() public abstract method #

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.

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

setIsFresh() public abstract method #

Sets whether the field is fresh.

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

supportedTranslationMethods() public abstract static method #

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

public abstract static string[] supportedTranslationMethods ( )