public function ConfigForm::buildForm in Linked Field 8

Form constructor.

Parameters

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

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/ConfigForm.php, line 69

Class

ConfigForm

Class ConfigForm.

Namespace

Drupal\linked_field\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('linked_field.config');
  $attributes = $config
    ->get('attributes');
  $conf = [
    'attributes' => $attributes,
  ];
  $config_text = Yaml::encode($conf);
  if (!$this->moduleHandler
    ->moduleExists('yaml_editor')) {
    $message = $this
      ->t('It is recommended to install the <a href="@yaml-editor">YAML Editor</a> module for easier editing.', [
      '@yaml-editor' => 'https://www.drupal.org/project/yaml_editor',
    ]);
    $this
      ->messenger()
      ->addWarning($message);
  }

  // Each attribute needs 3 rows + "attributes:" row + 3 extra lines
  // for adding a new attribute.
  $rows = count($config
    ->get('attributes')) * 3 + 4;
  $form['config'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Configuration'),
    '#description' => $this
      ->t('Available attributes can be defined in YAML syntax.'),
    '#default_value' => $config_text,
    '#rows' => $rows,
    '#attributes' => [
      'data-yaml-editor' => 'true',
    ],
  ];

  // Use module's YAML config file for example structure.
  $module_path = $this->moduleHandler
    ->getModule('linked_field')
    ->getPath();
  $yml_text = file_get_contents($module_path . '/config/install/linked_field.config.yml');
  $form['example'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Example structure'),
  ];
  $form['example']['description'] = [
    '#prefix' => '<p>',
    '#suffix' => '</p>',
    '#markup' => $this
      ->t('Each attribute has an optional label and description.'),
  ];
  $form['example']['code'] = [
    '#prefix' => '<pre>',
    '#suffix' => '</pre>',
    '#markup' => $yml_text,
  ];
  return parent::buildForm($form, $form_state);
}