WorkbenchSettingsForm.php in Workbench 8

Settings form for Workbench module.

Namespace

Drupal\workbench\Form

File

src/Form/WorkbenchSettingsForm.php

<?php

/**
 * @file
 * Settings form for Workbench module.
 */
namespace Drupal\workbench\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Generates the Workbench configuration form.
 */
class WorkbenchSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'workbench_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'workbench.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('workbench.settings');
    $form['help'] = [
      '#markup' => $this
        ->t('Workbench provides three pages that can be configured. The overview "My Workbench" page has three content sections, while the "My edits" and "All recent content" pages have one. Select the View and display that you wish to use.'),
    ];
    foreach ($this
      ->settingsItems() as $key => $label) {
      $form[$key] = [
        '#title' => $label,
        '#type' => 'select',
        '#options' => $this
          ->getOptions(),
        '#default_value' => $config
          ->get($key),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('workbench.settings');
    foreach ($this
      ->settingsItems() as $key => $label) {
      $config
        ->set($key, $form_state
        ->getValue($key));
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Returns an array of settings items.
   */
  public function settingsItems() {
    return [
      'overview_left' => $this
        ->t('Overview block left'),
      'overview_right' => $this
        ->t('Overview block right'),
      'overview_main' => $this
        ->t('Overview block main'),
      'edits_main' => $this
        ->t('My edits main'),
      'all_main' => $this
        ->t('All content main'),
    ];
  }

  /**
   * Gets a formatted list of all Views.
   */
  public function getOptions() {
    $views = \Drupal::entityTypeManager()
      ->getStorage('view')
      ->loadMultiple();
    foreach ($views as $view => $data) {
      $displays = $data
        ->get('display');
      foreach ($displays as $display => $info) {
        $options[$view . ':' . $display] = $data
          ->label() . ' : ' . $info['display_title'];
      }
    }
    return $options;
  }

}

Classes

Name	Description
WorkbenchSettingsForm	Generates the Workbench configuration form.