Method Details

afterDelete() public abstract method #

Performs actions after a component is deleted.

public abstract void afterDelete ( )

afterSave() public abstract method #

Performs actions after a component is saved.

public abstract void afterSave ( \craft\base\bool $isNew )

beforeDelete() public abstract method #

Performs actions before a component is deleted.

public abstract boolean beforeDelete ( )

beforeSave() public abstract method #

Performs actions before a component is saved.

public abstract boolean beforeSave ( \craft\base\bool $isNew )

getIsNew() public abstract method #

Returns whether the component is new (unsaved).

public abstract boolean getIsNew ( )

getSettings() public abstract method #

Returns an array of the component’s settings.

public abstract array getSettings ( )

getSettingsHtml() public abstract method #

Returns the component’s settings HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="foo">'.$this->foo.'</textarea>';

For more complex settings, 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 src/templates/_settings.html, passing the settings to it:

return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
    'widget' => $this
]);

If you need to tie any JavaScript code to your settings, 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 getSettingsHtml() 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 service 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 getSettingsHtml() method that includes field-targeting JavaScript code might look like:

public function getSettingsHtml()
{
    // Come up with an ID value for 'foo'
    $id = Craft::$app->getView()->formatInputId('foo');
    // 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('plugin-handle/_widget-settings', [
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'widget'       => $this
    ]);
}

And the _widget-settings.twig template might look like this:

<textarea id="{{ id }}" name="foo">{{ widget.foo }}</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, null getSettingsHtml ( )

isSelectable() public abstract static method #

Returns whether the component should be selectable in component Type selects.

public abstract static boolean isSelectable ( )

settingsAttributes() public abstract method #

Returns the list of settings attribute names.

By default, this method returns all public non-static properties that were defined on the called class. You may override this method to change the default behavior.

See also getSettings().

public abstract array settingsAttributes ( )

validate() public abstract method #

Validates the component.

public abstract boolean validate ( $attributeNames = null, $clearErrors = true )