BlocktabsEditForm.php in Block Tabs 8

Namespace

Drupal\blocktabs\Form

File

src/Form/BlocktabsEditForm.php

<?php

namespace Drupal\blocktabs\Form;

use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\blocktabs\ConfigurableTabInterface;
use Drupal\blocktabs\TabManager;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Controller for blocktabs edit form.
 */
class BlocktabsEditForm extends BlocktabsFormBase {

  /**
   * The tab manager service.
   *
   * @var \Drupal\blocktabs\TabManager
   */
  protected $tabManager;

  /**
   * Constructs an BlockTabsEditForm object.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $entity_storage
   *   The storage.
   * @param \Drupal\blocktabs\TabManager $tab_manager
   *   The tab manager service.
   */
  public function __construct(EntityStorageInterface $entity_storage, TabManager $tab_manager) {
    parent::__construct($entity_storage);
    $this->tabManager = $tab_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager')
      ->getStorage('blocktabs'), $container
      ->get('plugin.manager.blocktabs.tab'));
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $user_input = $form_state
      ->getUserInput();
    $form['#title'] = $this
      ->t('Edit blocktabs %name', [
      '%name' => $this->entity
        ->label(),
    ]);
    $form['#tree'] = TRUE;
    $form['#attached']['library'][] = 'blocktabs/admin';

    // Build the list of existing tabs for this blocktabs.
    $form['tabs'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Tab'),
        $this
          ->t('Weight'),
        $this
          ->t('Operations'),
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'tab-order-weight',
        ],
      ],
      '#attributes' => [
        'id' => 'blocktabs-tabs',
      ],
      '#empty' => $this
        ->t('There are currently no tabs in this blocktabs. Add one by selecting an option below.'),
      // Render tabs below parent elements.
      '#weight' => 5,
    ];
    foreach ($this->entity
      ->getTabs() as $tab) {
      $key = $tab
        ->getUuid();
      $form['tabs'][$key]['#attributes']['class'][] = 'draggable';
      $form['tabs'][$key]['#weight'] = isset($user_input['tabs']) ? $user_input['tabs'][$key]['weight'] : NULL;
      $form['tabs'][$key]['tab'] = [
        '#tree' => FALSE,
        'data' => [
          'label' => [
            '#plain_text' => $tab
              ->label(),
          ],
        ],
      ];
      $summary = $tab
        ->getSummary();
      if (!empty($summary)) {
        $summary['#prefix'] = ' ';
        $form['tabs'][$key]['tab']['data']['summary'] = $summary;
      }
      $form['tabs'][$key]['weight'] = [
        '#type' => 'weight',
        '#title' => $this
          ->t('Weight for @title', [
          '@title' => $tab
            ->label(),
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $tab
          ->getWeight(),
        '#delta' => 50,
        '#attributes' => [
          'class' => [
            'tab-order-weight',
          ],
        ],
      ];
      $links = [];
      $is_configurable = $tab instanceof ConfigurableTabInterface;
      if ($is_configurable) {
        $links['edit'] = [
          'title' => $this
            ->t('Edit'),
          'url' => Url::fromRoute('blocktabs.tab_edit_form', [
            'blocktabs' => $this->entity
              ->id(),
            'tab' => $key,
          ]),
        ];
      }
      $links['delete'] = [
        'title' => $this
          ->t('Delete'),
        'url' => Url::fromRoute('blocktabs.tab_delete', [
          'blocktabs' => $this->entity
            ->id(),
          'tab' => $key,
        ]),
      ];
      $form['tabs'][$key]['operations'] = [
        '#type' => 'operations',
        '#links' => $links,
      ];
    }

    // Build the new tab addition form and add it to the tab list.
    $new_tab_options = [];
    $tabs = $this->tabManager
      ->getDefinitions();
    uasort($tabs, function ($a, $b) {
      return strcasecmp($a['id'], $b['id']);
    });
    foreach ($tabs as $tab => $definition) {
      $new_tab_options[$tab] = $definition['label'];
    }
    $form['tabs']['new'] = [
      '#tree' => FALSE,
      '#weight' => isset($user_input['weight']) ? $user_input['weight'] : NULL,
      '#attributes' => [
        'class' => [
          'draggable',
        ],
      ],
    ];
    $form['tabs']['new']['tab'] = [
      'data' => [
        'new' => [
          '#type' => 'select',
          '#title' => $this
            ->t('Tab'),
          '#title_display' => 'invisible',
          '#options' => $new_tab_options,
          '#empty_option' => $this
            ->t('Select a new tab'),
        ],
        [
          'add' => [
            '#type' => 'submit',
            '#value' => $this
              ->t('Add'),
            '#validate' => [
              '::tabValidate',
            ],
            '#submit' => [
              '::submitForm',
              '::tabSave',
            ],
          ],
        ],
      ],
      '#prefix' => '<div class="blocktabs-new">',
      '#suffix' => '</div>',
    ];
    $form['tabs']['new']['weight'] = [
      '#type' => 'weight',
      '#title' => $this
        ->t('Weight for new tab'),
      '#title_display' => 'invisible',
      '#default_value' => count($this->entity
        ->getTabs()) + 1,
      '#attributes' => [
        'class' => [
          'tab-order-weight',
        ],
      ],
    ];
    $form['tabs']['new']['operations'] = [
      'data' => [],
    ];
    return parent::form($form, $form_state);
  }

  /**
   * Validate handler for tab.
   */
  public function tabValidate($form, FormStateInterface $form_state) {
    if (!$form_state
      ->getValue('new')) {
      $form_state
        ->setErrorByName('new', $this
        ->t('Select an tab to add.'));
    }
  }

  /**
   * Submit handler for tab.
   */
  public function tabSave($form, FormStateInterface $form_state) {
    $this
      ->save($form, $form_state);

    // Check if this field has any configuration options.
    $tab = $this->tabManager
      ->getDefinition($form_state
      ->getValue('new'));

    // Load the configuration form for this option.
    if (is_subclass_of($tab['class'], '\\Drupal\\blocktabs\\ConfigurableTabInterface')) {
      $form_state
        ->setRedirect('blocktabs.tab_add_form', [
        'blocktabs' => $this->entity
          ->id(),
        'tab' => $form_state
          ->getValue('new'),
      ], [
        'query' => [
          'weight' => $form_state
            ->getValue('weight'),
        ],
      ]);
    }
    else {
      $tab = [
        'id' => $tab['id'],
        'data' => [],
        'weight' => $form_state
          ->getValue('weight'),
      ];
      $tab_id = $this->entity
        ->addTab($tab);
      $this->entity
        ->save();
      if (!empty($tab_id)) {
        \Drupal::messenger()
          ->addMessage($this
          ->t('The tab was successfully added.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Update tab weights.
    if (!$form_state
      ->isValueEmpty('tabs')) {
      $this
        ->updateTabWeights($form_state
        ->getValue('tabs'));
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    parent::save($form, $form_state);
    \Drupal::messenger()
      ->addMessage($this
      ->t('Changes to the blocktabs have been saved.'));
  }

  /**
   * {@inheritdoc}
   */
  public function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = $this
      ->t('Update blocktabs');
    return $actions;
  }

  /**
   * Updates tab weights.
   *
   * @param array $tabs
   *   Associative array with tabs having tab uuid as keys and array
   *   with tab data as values.
   */
  protected function updateTabWeights(array $tabs) {
    foreach ($tabs as $uuid => $tab_data) {
      if ($this->entity
        ->getTabs()
        ->has($uuid)) {
        $this->entity
          ->getTab($uuid)
          ->setWeight($tab_data['weight']);
      }
    }
  }

}

Classes

Name	Description
BlocktabsEditForm	Controller for blocktabs edit form.