public function Stroke::buildConfigurationForm in Openlayers 8.4

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides PluginFormInterface::buildConfigurationForm

File

src/Plugin/OpenlayersStyle/Stroke.php, line 50

Class

Stroke

Defines the Line style for Openlayers features.

Namespace

Drupal\openlayers\Plugin\OpenlayersStyle

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['color'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['color'],
    '#title' => t('Stroke color'),
    //  TODO - improve description to recognise other valid color formats.
    '#description' => t('The color to be used for line features on the map. Use web-style hex colors (#FFFFFF for white, #000000 for black).'),
    '#size' => 20,
    '#maxlength' => 20,
    '#required' => FALSE,
  ];
  $form['lineDash'] = [
    '#type' => 'number',
    '#default_value' => $this->configuration['lineDash'],
    '#title' => t('Line dash pattern'),
    '#description' => t('The dash pattern to use for line features on the map. Leave blank for no dash.'),
    '#required' => FALSE,
  ];
  $form['width'] = [
    '#type' => 'number',
    '#default_value' => $this->configuration['width'],
    '#title' => t('Stroke width'),
    '#description' => t('The width to be used for line features on the map. Defaults to 1.'),
    '#field_suffix' => 'pixels',
    '#required' => FALSE,
  ];
  return $form;
}