You are here

Home » API reference » Drupal 9 » TableDragTestForm.php

class TableDragTestForm in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/system/tests/modules/tabledrag_test/src/Form/TableDragTestForm.php \Drupal\tabledrag_test\Form\TableDragTestForm

Provides a form for draggable table testing.

Hierarchy

Expanded class hierarchy of TableDragTestForm

1 string reference to 'TableDragTestForm'
tabledrag_test.routing.yml in core/modules/system/tests/modules/tabledrag_test/tabledrag_test.routing.yml
core/modules/system/tests/modules/tabledrag_test/tabledrag_test.routing.yml

File

core/modules/system/tests/modules/tabledrag_test/src/Form/TableDragTestForm.php, line 13

Namespace

Drupal\tabledrag_test\Form
View source 
class TableDragTestForm extends FormBase {

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * Constructs a TableDragTestForm object.
   *
   * @param \Drupal\Core\State\StateInterface $state
   *   The state service.
   */
  public function __construct(StateInterface $state) {
    $this->state = $state;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('state'));
  }

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

  /**
   * Builds the draggable test table.
   *
   * @param array $rows
   *   (optional) Rows that should be shown on the table. Default value is an
   *   empty array.
   * @param string $table_id
   *   (optional) An HTML ID for the table, defaults to 'tabledrag-test-table'.
   * @param string $group_prefix
   *   (optional) A prefix for HTML classes generated in the method, defaults to
   *   'tabledrag-test'.
   * @param bool $indentation
   *   (optional) A boolean indicating whether the rows can be indented,
   *   defaults to TRUE.
   *
   * @return array
   *   The renderable array of the draggable table used for testing.
   */
  protected function buildTestTable(array $rows = [], $table_id = 'tabledrag-test-table', $group_prefix = 'tabledrag-test', $indentation = TRUE) {
    $tabledrag = [
      [
        'action' => 'order',
        'relationship' => 'sibling',
        'group' => "{$group_prefix}-weight",
      ],
    ];
    if ($indentation) {
      $tabledrag[] = [
        'action' => 'match',
        'relationship' => 'parent',
        'group' => "{$group_prefix}-parent",
        'subgroup' => "{$group_prefix}-parent",
        'source' => "{$group_prefix}-id",
        'hidden' => TRUE,
        'limit' => 2,
      ];
      $tabledrag[] = [
        'action' => 'depth',
        'relationship' => 'group',
        'group' => "{$group_prefix}-depth",
        'hidden' => TRUE,
      ];
    }
    $table = [
      '#type' => 'table',
      '#header' => [
        [
          'data' => $this
            ->t('Text'),
          'colspan' => $indentation ? 4 : 2,
        ],
        $this
          ->t('Weight'),
      ],
      '#tabledrag' => $tabledrag,
      '#attributes' => [
        'id' => $table_id,
      ],
      '#attached' => [
        'library' => [
          'tabledrag_test/tabledrag',
        ],
      ],
    ];

    // Provide a default set of five rows.
    $rows = !empty($rows) ? $rows : $this->state
      ->get('tabledrag_test_table', array_flip(range(1, 5)));
    foreach ($rows as $id => $row) {
      if (!is_array($row)) {
        $row = [];
      }
      $row += [
        'parent' => '',
        'weight' => 0,
        'depth' => 0,
        'classes' => [],
        'draggable' => TRUE,
      ];
      if (!empty($row['draggable'])) {
        $row['classes'][] = 'draggable';
      }
      $table[$id] = [
        'title' => [
          'indentation' => [
            '#theme' => 'indentation',
            '#size' => $indentation ? $row['depth'] : 0,
          ],
          '#plain_text' => "Row with id {$id}",
        ],
        'id' => [
          '#type' => 'hidden',
          '#value' => $id,
          '#parents' => [
            'table',
            $id,
            'id',
          ],
          '#attributes' => [
            'class' => [
              "{$group_prefix}-id",
            ],
          ],
        ],
        '#attributes' => [
          'class' => $row['classes'],
        ],
      ];
      if ($indentation) {
        $table[$id]['parent'] = [
          '#type' => 'hidden',
          '#default_value' => $row['parent'],
          '#parents' => [
            'table',
            $id,
            'parent',
          ],
          '#attributes' => [
            'class' => [
              "{$group_prefix}-parent",
            ],
          ],
        ];
        $table[$id]['depth'] = [
          '#type' => 'hidden',
          '#default_value' => $row['depth'],
          '#parents' => [
            'table',
            $id,
            'depth',
          ],
          '#attributes' => [
            'class' => [
              "{$group_prefix}-depth",
            ],
          ],
        ];
      }
      $table[$id]['weight'] = [
        '#type' => 'weight',
        '#default_value' => $row['weight'],
        '#parents' => [
          'table',
          $id,
          'weight',
        ],
        '#attributes' => [
          'class' => [
            "{$group_prefix}-weight",
          ],
        ],
      ];
    }
    return $table;
  }

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

    // Provide a default set of five rows.
    $form['table'] = $this
      ->buildTestTable();
    $form['actions'] = $this
      ->buildFormActions();
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $operation = isset($form_state
      ->getTriggeringElement()['#op']) ? $form_state
      ->getTriggeringElement()['#op'] : 'save';
    switch ($operation) {
      case 'reset':
        $this->state
          ->set('tabledrag_test_table', array_flip(range(1, 5)));
        break;
      default:
        $test_table = [];
        foreach ($form_state
          ->getValue('table') as $row) {
          $test_table[$row['id']] = $row;
        }
        $this->state
          ->set('tabledrag_test_table', $test_table);
        break;
    }
  }

  /**
   * Builds the test table form actions.
   *
   * @return array
   *   The renderable array of form actions.
   */
  protected function buildFormActions() {
    return [
      '#type' => 'actions',
      'save' => [
        '#type' => 'submit',
        '#value' => $this
          ->t('Save'),
      ],
      'reset' => [
        '#type' => 'submit',
        '#op' => 'reset',
        '#value' => $this
          ->t('Reset'),
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
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.
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 72
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
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. 4
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.
TableDragTestForm::$state protected property The state service.
TableDragTestForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 1
TableDragTestForm::buildFormActions protected function Builds the test table form actions.
TableDragTestForm::buildTestTable protected function Builds the draggable test table.
TableDragTestForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
TableDragTestForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 1
TableDragTestForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
TableDragTestForm::__construct public function Constructs a TableDragTestForm object.