class TableDragTestForm in Drupal 8

Provides a form for draggable table testing.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\tabledrag_test\Form\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

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';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['table'] = [
      '#type' => 'table',
      '#header' => [
        [
          'data' => $this
            ->t('Text'),
          'colspan' => 4,
        ],
        $this
          ->t('Weight'),
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'tabledrag-test-weight',
        ],
        [
          'action' => 'match',
          'relationship' => 'parent',
          'group' => 'tabledrag-test-parent',
          'subgroup' => 'tabledrag-test-parent',
          'source' => 'tabledrag-test-id',
          'hidden' => TRUE,
          'limit' => 2,
        ],
        [
          'action' => 'depth',
          'relationship' => 'group',
          'group' => 'tabledrag-test-depth',
          'hidden' => TRUE,
        ],
      ],
      '#attributes' => [
        'id' => 'tabledrag-test-table',
      ],
      '#attached' => [
        'library' => [
          'tabledrag_test/tabledrag',
        ],
      ],
    ];

    // Provide a default set of five 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';
      }
      $form['table'][$id] = [
        'title' => [
          'indentation' => [
            '#theme' => 'indentation',
            '#size' => $row['depth'],
          ],
          '#plain_text' => "Row with id {$id}",
        ],
        'id' => [
          '#type' => 'hidden',
          '#value' => $id,
          '#attributes' => [
            'class' => [
              'tabledrag-test-id',
            ],
          ],
        ],
        'parent' => [
          '#type' => 'hidden',
          '#default_value' => $row['parent'],
          '#parents' => [
            'table',
            $id,
            'parent',
          ],
          '#attributes' => [
            'class' => [
              'tabledrag-test-parent',
            ],
          ],
        ],
        'depth' => [
          '#type' => 'hidden',
          '#default_value' => $row['depth'],
          '#attributes' => [
            'class' => [
              'tabledrag-test-depth',
            ],
          ],
        ],
        'weight' => [
          '#type' => 'weight',
          '#default_value' => $row['weight'],
          '#attributes' => [
            'class' => [
              'tabledrag-test-weight',
            ],
          ],
        ],
        '#attributes' => [
          'class' => $row['classes'],
        ],
      ];
    }
    $form['save'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $test_table = [];
    foreach ($form_state
      ->getValue('table') as $row) {
      $test_table[$row['id']] = $row;
    }
    $this->state
      ->set('tabledrag_test_table', $test_table);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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.
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.
TableDragTestForm::$state	protected	property	The state service.
TableDragTestForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
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
TableDragTestForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
TableDragTestForm::__construct	public	function	Constructs a TableDragTestForm object.
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.