You are here

Home » API reference » Vertical Tabs Config 8 » OrderConfigurationForm.php

class OrderConfigurationForm in Vertical Tabs Config 8

Configure order for this site.

Hierarchy

Expanded class hierarchy of OrderConfigurationForm

1 string reference to 'OrderConfigurationForm'
vertical_tabs_config.routing.yml in ./vertical_tabs_config.routing.yml
vertical_tabs_config.routing.yml

File

src/Form/OrderConfigurationForm.php, line 11

Namespace

Drupal\vertical_tabs_config\Form
View source 
class OrderConfigurationForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('vertical_tabs_config.order');
    $vertical_tabs = vertical_tabs_config_vertical_tab_list(TRUE);
    $form['desc'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t('Reorder vertical tabs in the table to set a global order.'),
    ];

    // https://www.drupal.org/node/1876710
    $form['vttable'] = [
      '#type' => 'table',
      '#header' => [
        t('Vertical tab'),
        t('Weight'),
      ],
      '#empty' => t('There are no vertical tabs.'),
      // Insert or not selection checkbox on first column.
      '#tableselect' => FALSE,
      // TableDrag: callback arguments for drupal_add_tabledrag().
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'vttable-order-weight',
        ],
      ],
    ];
    foreach ($vertical_tabs as $vt_machine_name => $vt_human_name) {
      $id = 'vertical_tabs_config_' . $vt_machine_name;

      // TableDrag: Mark the table row as draggable.
      $form['vttable'][$id]['#attributes']['class'][] = 'draggable';

      // TableDrag: Sort the table row according to its existing/configured weight.
      $form['vttable'][$id]['#weight'] = $config
        ->get('vertical_tabs_config_' . $vt_machine_name);

      // Some table columns containing raw markup.
      $form['vttable'][$id]['label'] = [
        '#plain_text' => $vt_human_name,
      ];

      // TableDrag: Weight column element.
      $form['vttable'][$id]['weight'] = [
        '#type' => 'weight',
        '#title' => t('Weight for @title', [
          '@title' => $vt_human_name,
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $config
          ->get('vertical_tabs_config_' . $vt_machine_name),
        // Classify the weight element for #tabledrag.
        '#attributes' => [
          'class' => [
            'vttable-order-weight',
          ],
        ],
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $vertical_tabs = vertical_tabs_config_vertical_tab_list();
    foreach ($vertical_tabs as $vt_machine_name => $vt_human_name) {
      $new_value = $values['vttable']['vertical_tabs_config_' . $vt_machine_name]['weight'];
      $this
        ->config('vertical_tabs_config.order')
        ->set('vertical_tabs_config_' . $vt_machine_name, $new_value)
        ->save();
    }
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OrderConfigurationForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
OrderConfigurationForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
OrderConfigurationForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
OrderConfigurationForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.