You are here

Home » API reference » Quick Tabs 8.3 » QuickTabsInstanceEditForm.php

class QuickTabsInstanceEditForm in Quick Tabs 8.3

Class QuickTabsInstanceEditForm.

Hierarchy

Expanded class hierarchy of QuickTabsInstanceEditForm

File

src/Form/QuickTabsInstanceEditForm.php, line 18

Namespace

Drupal\quicktabs\Form
View source 
class QuickTabsInstanceEditForm extends EntityForm {

  /**
   * The tab renderer manager.
   *
   * @var \Drupal\quicktabs\TabRendererManager
   */
  protected $tabRendererManager;

  /**
   * The tab type manager.
   *
   * @var \Drupal\quicktabs\TabTypeManager
   */
  protected $tabTypeManager;

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs the QuickTabsInstanceEditForm object.
   *
   * @param \Drupal\quicktabs\TabRendererManager $tab_renderer
   *   The tab renderer manager.
   * @param \Drupal\quicktabs\TabTypeManager $tab_type
   *   The tab type manager.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(TabRendererManager $tab_renderer, TabTypeManager $tab_type, MessengerInterface $messenger) {
    $this->tabRendererManager = $tab_renderer;
    $this->tabTypeManager = $tab_type;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.tab_renderer'), $container
      ->get('plugin.manager.tab_type'), $container
      ->get('messenger'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $form['label'] = [
      '#title' => $this
        ->t('Name'),
      '#description' => $this
        ->t('This will appear as the block title.'),
      '#type' => 'textfield',
      '#default_value' => $this->entity
        ->label(),
      '#weight' => -9,
      '#required' => TRUE,
      '#placeholder' => $this
        ->t('Enter name'),
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#maxlength' => 32,
      '#required' => TRUE,
      '#default_value' => $this->entity
        ->id(),
      '#machine_name' => [
        'exists' => 'Drupal\\quicktabs\\Entity\\QuickTabsInstance::getQuickTabsInstance',
      ],
      '#description' => $this
        ->t('A unique machine-readable name for this QuickTabs instance. It must only contain lowercase letters, numbers, and underscores. The machine name will be used internally by QuickTabs and will be used in the CSS ID of your QuickTabs block.'),
      '#weight' => -8,
    ];

    // Instantiate all TabRenderer plugins.
    $plugin_definitions = $this->tabRendererManager
      ->getDefinitions();
    $renderers = [];
    $renderer_form_options = [];

    // Use the name of each plugin to create the dropdown.
    foreach ($plugin_definitions as $index => $def) {
      $renderers[$index] = $def['name']
        ->__toString();
      $object = $this->tabRendererManager
        ->createInstance($index);
      $renderer_form_options[$index] = $object
        ->optionsForm($this->entity);
    }
    $form['renderer'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Renderer'),
      '#options' => $renderers,
      '#default_value' => $this->entity
        ->getRenderer(),
      '#description' => $this
        ->t('Choose how to render the content.'),
      '#weight' => -7,
    ];

    // Add the renderer options form elements to the form.
    // Use Drupal Form states API to show only selected renderer options.
    $form['options'] = [
      '#tree' => TRUE,
      '#weight' => -6,
    ];
    foreach ($renderer_form_options as $renderer => $options) {
      foreach ($options as &$option) {
        $option['#states'] = [
          'visible' => [
            ':input[name="renderer"]' => [
              'value' => $renderer,
            ],
          ],
        ];
      }
      $form['options'][$renderer] = $options;
    }
    $form['hide_empty_tabs'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide empty tabs'),
      '#default_value' => $this->entity
        ->getHideEmptyTabs(),
      '#description' => $this
        ->t('Empty and restricted tabs will not be displayed. Could be useful when the tab content is not accessible.<br />This option does not work in ajax mode.'),
      '#weight' => -3,
    ];
    $tab_titles = [
      QuickTabsInstance::QUICKTABS_DELTA_NONE => $this
        ->t('- None -'),
    ];

    // Create a table with each tr corresponding to a tab.
    $qt = new \stdClass();
    if (!empty($form_state
      ->getValue('configuration_data'))) {
      $qt->tabs = $form_state
        ->getValue('configuration_data');
    }
    else {
      $qt->tabs = $this->entity
        ->getConfigurationData();
    }

    // Show 2 empty tabs when adding a new QT instance.
    if (empty($qt->tabs)) {
      $qt->tabs = [
        0 => [],
        1 => [],
      ];
    }
    else {
      if (is_numeric($form_state
        ->get('to_remove'))) {
        unset($qt->tabs[$form_state
          ->get('to_remove')]);
        $form_state
          ->set('num_tabs', $form_state
          ->get('num_tabs') - 1);
      }

      // If the number of rows has been incremented
      // add another row.
      if ($form_state
        ->get('num_tabs') > count($qt->tabs)) {
        $qt->tabs[] = [];
      }
    }
    $delta = 0;
    if (!empty($qt->tabs)) {
      foreach ($qt->tabs as $tab) {
        if (!empty($tab)) {
          $tab_titles[$delta] = $tab['title'];
          $delta++;
        }
      }
    }
    $form['default_tab'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default tab'),
      '#options' => $tab_titles,
      '#default_value' => $this->entity
        ->getDefaultTab(),
      '#access' => !empty($tab_titles),
      '#weight' => -4,
    ];
    $form['configuration_data_wrapper'] = [
      '#tree' => FALSE,
      '#weight' => -3,
      '#prefix' => '<div class="clear-block" id="configuration-data-wrapper">',
      '#suffix' => '</div>',
    ];
    $form['configuration_data_wrapper']['configuration_data'] = $this
      ->getConfigurationDataForm($qt);

    // There are two functions attached to the more button:
    // The submit function will be called first; increments number of rows.
    // The callback function will then return the rendered rows.
    $form['tabs_more'] = [
      '#name' => 'tabs_more',
      '#type' => 'submit',
      '#value' => $this
        ->t('Add tab'),
      '#attributes' => [
        'class' => [
          'add-tab',
        ],
        'title' => $this
          ->t('Click here to add more tabs.'),
      ],
      '#weight' => 1,
      '#submit' => [
        [
          $this,
          'ajaxFormSubmit',
        ],
      ],
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxFormCallback',
        ],
        'progress' => [
          'type' => 'throbber',
          'message' => NULL,
        ],
        'effect' => 'fade',
      ],
    ];

    // The form js will ensure that only one set of tab options is visible.
    $form['#attached']['library'][] = 'quicktabs/quicktabs.form';
    return $form;
  }

  /**
   * Ajax callback for the add tab and remove tab buttons.
   *
   * Returns the table rows.
   */
  public function ajaxFormCallback(array &$form, FormStateInterface $form_state) {

    // Instantiate an AjaxResponse Object to return.
    $ajax_response = new AjaxResponse();
    $ajax_response
      ->addCommand(new HtmlCommand('#configuration-data-wrapper', $form['configuration_data_wrapper']['configuration_data']));
    return $ajax_response;
  }

  /**
   * Submit handler for the 'Add Tab' and 'Remove' buttons.
   *
   * Removes a row or increments the number of rows depending on action.
   */
  public function ajaxFormSubmit(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getTriggeringElement()['#name'] === 'tabs_more') {
      $form_state
        ->set('num_tabs', count($form_state
        ->getValue('configuration_data')) + 1);
      $form_state
        ->setRebuild(TRUE);
    }
    elseif (is_numeric($form_state
      ->getTriggeringElement()['#row_number'])) {
      $form_state
        ->set('to_remove', $form_state
        ->getTriggeringElement()['#row_number']);
      $form_state
        ->setRebuild(TRUE);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array $form, FormStateInterface $form_state) {
    $id = $form_state
      ->getValue('id');
    if (empty($id)) {
      $form_state
        ->setErrorByName('machine_name', $this
        ->t('The quicktabs machine name is required.'));
    }
    elseif (!preg_match('!^[a-z0-9_]+$!', $id)) {
      $form_state
        ->setErrorByName('machine_name', $this
        ->t('The quicktabs machine name must contain only lowercase letters, numbers, and underscores.'));
    }
    $tabs = $form_state
      ->getValue('tabs');
    if (!isset($tabs)) {
      $form_state
        ->setErrorByName('', $this
        ->t('At least one tab should be created.'));
    }
    else {
      foreach ($tabs as $j => $tab) {
        if (empty($tab['title'])) {
          $form_state
            ->setErrorByName('tabs][' . $j . '][title', $this
            ->t('Title is required for each tab.'));
        }
      }
    }
  }

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

    // We need the configuration_data array to be indexed according to weight
    // So change the indexes here.
    $ordered_configuration_data = [];
    foreach ($this->entity
      ->getConfigurationData() as $item) {
      $ordered_configuration_data[] = $item;
    }
    $this->entity
      ->setConfigurationData($ordered_configuration_data);
    $status = $this->entity
      ->save();
    if ($status == SAVED_NEW) {
      $form_state
        ->setRedirect('quicktabs.admin');
    }
    $this->messenger
      ->addStatus($this
      ->t('Your changes have been saved.'));
    drupal_flush_all_caches();
  }

  /**
   * Returns configuration data form.
   */
  private function getConfigurationDataForm($qt) {
    $configuration_data = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Tab title'),
        $this
          ->t('Tab weight'),
        $this
          ->t('Tab type'),
        $this
          ->t('Tab content'),
        $this
          ->t('Operations'),
      ],
      '#empty' => $this
        ->t('There are no tabs yet'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'mytable-order-weight',
        ],
      ],
    ];
    foreach ($qt->tabs as $index => $tab) {
      $tab['entity_id'] = $this->entity
        ->id();
      $tab['delta'] = $index;
      $configuration_data[$index] = $this
        ->getRow($index, $tab);
    }
    return $configuration_data;
  }

  /**
   * Builds and returns instance row.
   */
  private function getRow($row_number, $tab = NULL) {
    if ($tab === NULL) {
      $tab = [];
    }
    $type = $this->tabTypeManager;
    $plugin_definitions = $type
      ->getDefinitions();
    $types = [];
    foreach ($plugin_definitions as $index => $def) {
      $name = $def['name'];
      $types[$index] = $name
        ->render();
    }
    ksort($types);
    $row = [];

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

    // TableDrag: Sort the table row according to its configured weight.
    $row['#weight'] = isset($tab['weight']) ? $tab['weight'] : 0;
    $row['title'] = [
      '#type' => 'textfield',
      '#size' => '10',
      '#default_value' => isset($tab['title']) ? $tab['title'] : '',
    ];

    // TableDrag: Weight column element.
    $row['weight'] = [
      '#type' => 'weight',
      '#title' => $this
        ->t('Weight'),
      '#title_display' => 'invisible',
      '#default_value' => isset($tab['weight']) ? $tab['weight'] : 0,
      // Classify the weight element for #tabledrag.
      '#attributes' => [
        'class' => [
          'mytable-order-weight',
        ],
      ],
    ];
    $row['type'] = [
      '#type' => 'select',
      '#options' => $types,
      '#default_value' => isset($tab['type']) ? $tab['type'] : key($types),
    ];
    foreach ($plugin_definitions as $index => $def) {
      $name = $def['name'];
      $row['content'][$index] = [
        '#prefix' => '<div class="' . $index . '-plugin-content plugin-content qt-tab-options-form qt-tab-' . $index . '-options-form" >',
        '#suffix' => '</div>',
      ];
      $object = $type
        ->createInstance($index);
      $row['content'][$index]['options'] = $object
        ->optionsForm($tab);
    }

    // There are two functions attached to the remove button.
    // The submit function will be called first and used to remove selected row.
    // The callback function will then return the rendered rows.
    $row['operations'] = [
      '#row_number' => $row_number,
      // We need this - the call to getTriggeringElement when clicking the
      // remove button won't work without it.
      '#name' => 'row-' . $row_number,
      '#type' => 'submit',
      '#value' => $this
        ->t('Remove'),
      '#attributes' => [
        'class' => [
          'delete-tab',
        ],
        'title' => $this
          ->t('Click here to delete this tab.'),
      ],
      '#submit' => [
        [
          $this,
          'ajaxFormSubmit',
        ],
      ],
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxFormCallback',
        ],
        'progress' => [
          'type' => 'throbber',
          'message' => NULL,
        ],
        'effect' => 'fade',
      ],
    ];
    return $row;
  }

}

Members

Namesort descending 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
EntityForm::$entity protected property The entity being used by this form. 7
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 29
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm 17
EntityForm::__get public function
EntityForm::__set public function
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 public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
QuickTabsInstanceEditForm::$messenger protected property The Messenger service. Overrides MessengerTrait::$messenger
QuickTabsInstanceEditForm::$tabRendererManager protected property The tab renderer manager.
QuickTabsInstanceEditForm::$tabTypeManager protected property The tab type manager.
QuickTabsInstanceEditForm::ajaxFormCallback public function Ajax callback for the add tab and remove tab buttons.
QuickTabsInstanceEditForm::ajaxFormSubmit public function Submit handler for the 'Add Tab' and 'Remove' buttons.
QuickTabsInstanceEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
QuickTabsInstanceEditForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
QuickTabsInstanceEditForm::getConfigurationDataForm private function Returns configuration data form.
QuickTabsInstanceEditForm::getFormId public function Returns a unique string identifying the form. Overrides EntityForm::getFormId
QuickTabsInstanceEditForm::getRow private function Builds and returns instance row.
QuickTabsInstanceEditForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
QuickTabsInstanceEditForm::validate public function
QuickTabsInstanceEditForm::__construct public function Constructs the QuickTabsInstanceEditForm object.
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.