MarketplaceConnectButton

---

MarketplaceConnectButton

MarketplaceConnectButton Field.

Whenever someone creates a new field in Craft, they must specify what type of field it is. The system comes with a handful of field types baked in, and we’ve made it extremely easy for plugins to add new ones.

https://craftcms.com/docs/plugins/field-types

• Full name: \kennethormandy\marketplace\fields\MarketplaceConnectButton
• Parent class: Field
• This class implements: \craft\base\PreviewableFieldInterface

Methods

displayName

public static displayName(): string

• This method is static.

---

rules

Returns the validation rules for attributes. 2

public rules(): array

Validation rules are used by [[validate()]] to check if attribute values are valid. Child classes may override this method to declare different validation rules.

More info: http://www.yiiframework.com/doc-2.0/guide-input-validation.html

Return Value:

This and that

---

getContentColumnType

Returns the column type that this field should get within the content table.

public getContentColumnType(): string

This method will only be called if [[hasContentColumn()]] returns true.

Return Value:

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.

See Also:

• \yii\db\QueryBuilder::getColumnType() -

---

normalizeValue

Normalizes the field’s value for use.

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

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.

Parameters:

Parameter	Type	Description
$value	mixed	The raw field value
$element	\craft\base\ElementInterface|null	The element the field is associated with, if there is one

Return Value:

The prepared field value

---

serializeValue

Modifies an element query.

public serializeValue(mixed $value, ?\craft\base\ElementInterface $element = null): null|false

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.

Parameters:

Parameter	Type	Description
$value	mixed	The value that was set on this field’s corresponding [[ElementCriteriaModel]] param, if any.
$element	?\craft\base\ElementInterface

Return Value:

false in the event that the method is sure that no elements are going to be found.

---

getSettingsHtml

Returns the component’s settings HTML.

public getSettingsHtml(): string|null

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

return '<textarea name="foo">'.$this->getSettings()->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 loacated at craft/plugins/myplugin/templates/_settings.html, passing the settings to it:

return Craft::$app->getView()->renderTemplate('myplugin/_settings', [
    'settings' => $this->getSettings()
]);

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 [[\craft\web\View::namespaceInputs() 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->getView()->namespaceInputId($id);

    // Render and return the input template
    return Craft::$app->getView()->renderTemplate('myplugin/_fieldinput', [
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'settings'     => $this->getSettings()
    ]);
}

And the _settings.html template might look like this:

<textarea id="{{ id }}" name="foo">{{ settings.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()]].

---

getInputHtml

Returns the field’s input HTML.

public getInputHtml(mixed $value, \craft\base\ElementInterface|null $element = null): string

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 craft/plugins/myplugin/templates/_fieldinput.html, passing the $name and $value variables to it:

return Craft::$app->getView()->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 [[\craft\web\View::namespaceInputs() 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->getView()->formatInputId($name);

    // Figure out what that ID is going to be namespaced into
    $namespacedId = Craft::$app->getView()->namespaceInputId($id);

    // Render and return the input template
    return Craft::$app->getView()->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()]].

Parameters:

Parameter	Type	Description
$value	mixed	The field’s value. This will either be the [[normalizeValue() 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

Return Value:

The input HTML.

---

---

Automatically generated on 2024-11-13