ProducerSelector¶

ProducerSelector element is a select list with producers.

producer-selector

Build-in Validators¶

Element validate if chosen producer exists.

Available Validators¶

Element has available validators:

Relations Support¶

Element does not support relations between elements.

Configuration output schema¶

schema

{
  "<element_type>" : "producerSelector",
  "<element_name>" : string,
  "<element_label>" : string,
  "<element_labelDescription>" : string,
  "<element_isRequired>" : bool,
  "<element_isHidden>" : bool,
  "<element_defaultValue>" : int,
  "<element_validators>" : []
}

example

{
  "type" : "producerSelector",
  "name" : "producer",
  "label" : "Displayed producer",
  "isRequired" : false,
  "isHidden" : false,
  "defaultValue" : 12,
  "validators": [
    {
      "type" : "lessEqThan",
      "options" : { "max" : 25 }
    }
  ]
}

Element value¶

If value is filled: int.

usage in module TWIG

{% if moduleConfig.producer %}
    Displayed producer ID: {{ moduleConfig.producer }}
{% endif %}

Example of module¶

Twig¶

Twig

{% set producerId = moduleConfig.selectedProducerId %}
{% if producerId %}
    {% set producer = ObjectApi.getProducer(producerId) %}
    {% if producer %}
        <section>
            <div>
                <h2 class="h2">{{ producer.name }}</h2>

                {% if moduleConfig.showDescription and producer.description %}
                    <p>
                        {{ producer.description|raw }}
                    </p>
                {% endif %}

                <div>
                    <a href="{{ producer.url }}" class="btn btn_primary">
                        {{ translate("See producer's products") }}
                    </a>
                </div>
            </div>
        </section>
    {% endif %}
{% endif %}

JSON configuration¶

JSON configuration

[
  {
    "label": "Producer",
    "state": "unfolded",
    "elements": [
      {
        "name": "selectedProducerId",
        "type": "producerSelector",
        "label": "Select Producer"
      },
      {
        "name": "showDescription",
        "type": "checkbox",
        "label": "Show producer description"
      }
    ]
  }
]

JSON translations¶

JSON translations

{
  "module": {
    "pl_PL": {
      "See producer's products": "Zobacz produkty producenta"
    },
    "en_US": {
      "See producer's products": "See producer's products"
    }
  },
  "schema": {
    "pl_PL": {
      "Producer" : "Producent",
      "Select Producer" : "Wybierz producenta",
      "Show producer description" : "Pokaż opis producenta"
    },
    "en_US": {
      "Producer" : "Producer",
      "Select Producer" : "Select Producer",
      "Show producer description" : "Show producer description"
    }
  }
}