Property Details

$branchLimit public property #

Branch limit

public integer, null $branchLimit = null

Method Details

defaultSelectionLabel() public static method #

Returns the default $selectionLabel value.

public static string defaultSelectionLabel ( )

displayName() public static method #

Returns the display name of this class.

public static string displayName ( )

elementType() protected static method #

Returns the element class associated with this field type.

protected static string elementType ( )

getInputHtml() public 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 string getInputHtml ( $value, craft\base\ElementInterface $element = null )

init() public method #

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

inputTemplateVariables() protected method #

Returns an array of variables that should be passed to the input template.

protected array inputTemplateVariables ( $value = null, craft\base\ElementInterface $element = null )

normalizeValue() public 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 mixed normalizeValue ( $value, craft\base\ElementInterface $element = null )