abstract class TabFormBase in Block Tabs 8

Provides a base form for tab.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\blocktabs\Form\TabFormBase

Expanded class hierarchy of TabFormBase

File

src/Form/TabFormBase.php, line 16

Namespace

Drupal\blocktabs\Form

View source

abstract class TabFormBase extends FormBase {

  /**
   * The blockTabs.
   *
   * @var \Drupal\blocktabs\BlocktabsInterface
   */
  protected $blocktabs;

  /**
   * The tab.
   *
   * @var \Drupal\blocktabs\TabInterface
   */
  protected $tab;

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

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\blocktabs\BlocktabsInterface $blocktabs
   *   The block tabs.
   * @param string $tab
   *   The tab ID.
   *
   * @return array
   *   The form structure.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   */
  public function buildForm(array $form, FormStateInterface $form_state, BlocktabsInterface $blocktabs = NULL, $tab = NULL) {
    $this->blocktabs = $blocktabs;
    try {
      $this->tab = $this
        ->prepareTab($tab);
    } catch (PluginNotFoundException $e) {
      throw new NotFoundHttpException("Invalid tab id: '{$tab}'.");
    }
    $request = $this
      ->getRequest();
    if (!$this->tab instanceof ConfigurableTabInterface) {
      throw new NotFoundHttpException();
    }
    $form['#attached']['library'][] = 'blocktabs/admin';
    $form['uuid'] = [
      '#type' => 'hidden',
      '#value' => $this->tab
        ->getUuid(),
    ];
    $form['id'] = [
      '#type' => 'hidden',
      '#value' => $this->tab
        ->getPluginId(),
    ];
    $form['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Tab title'),
      '#default_value' => $this->tab
        ->getTitle(),
      '#required' => TRUE,
    ];
    $form['data'] = $this->tab
      ->buildConfigurationForm([], $form_state);
    $form['data']['#tree'] = TRUE;

    // Check the URL for a weight, then the tab, otherwise use default.
    $form['weight'] = [
      '#type' => 'hidden',
      '#value' => $request->query
        ->has('weight') ? (int) $request->query
        ->get('weight') : $this->tab
        ->getWeight(),
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#button_type' => 'primary',
    ];
    $form['actions']['cancel'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Cancel'),
      '#url' => $this->blocktabs
        ->toUrl('edit-form'),
      '#attributes' => [
        'class' => [
          'button',
        ],
      ],
    ];
    return $form;
  }

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

    // The tab configuration is stored in the 'data' key in the form,
    // pass that through for validation.
    $tab_data = (new FormState())
      ->setValues($form_state
      ->getValue('data'));
    $this->tab
      ->validateConfigurationForm($form, $tab_data);

    // Update the original form values.
    $form_state
      ->setValue('data', $tab_data
      ->getValues());
  }

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

    // The tab configuration is stored in the 'data' key in the form,
    // pass that through for submission.
    $tab_data = (new FormState())
      ->setValues($form_state
      ->getValue('data'));
    $this->tab
      ->submitConfigurationForm($form, $tab_data);

    // $logger = \Drupal::logger('blocktabs');
    // $logger->notice('submitForm:' . var_export($tab_data, true));
    // $logger->notice('default_view_name:' . var_export($default_view_name, true));
    // Update the original form values.
    $form_state
      ->setValue('data', $tab_data
      ->getValues());
    $this->tab
      ->setTitle($form_state
      ->getValue('title'));
    $this->tab
      ->setWeight($form_state
      ->getValue('weight'));
    if (!$this->tab
      ->getUuid()) {
      $this->blocktabs
        ->addTab($this->tab
        ->getConfiguration());
    }
    else {
      $uuid = $this->tab
        ->getUuid();
      $config = $this->tab
        ->getConfiguration();
      $this->blocktabs
        ->getTabs()
        ->setInstanceConfiguration($uuid, $config);
    }

    // $config = $this->tab->getConfiguration();
    // $logger = \Drupal::logger('blocktabs');
    // $logger->notice('$config:' . var_export($config, true));
    // $tab = $this->blocktabs->getTab($this->tab->getUuid());
    // $config1 = $tab->getConfiguration();
    // $logger = \Drupal::logger('blocktabs');
    // $logger->notice('$config:' . var_export($config1, true));
    // $tab = $this->tab;
    $this->blocktabs
      ->save();
    \Drupal::messenger()
      ->addMessage($this
      ->t('The tab was successfully applied.'));
    $form_state
      ->setRedirectUrl($this->blocktabs
      ->toUrl('edit-form'));
  }

  /**
   * Converts a tab ID into an object.
   *
   * @param string $tab
   *   The tab ID.
   *
   * @return \Drupal\blocktabs\TabInterface
   *   The tab object.
   */
  protected abstract function prepareTab($tab);

}

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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
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.
TabFormBase::$blocktabs	protected	property	The blockTabs.
TabFormBase::$tab	protected	property	The tab.
TabFormBase::buildForm	public	function	Overrides FormInterface::buildForm	2
TabFormBase::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TabFormBase::prepareTab	abstract protected	function	Converts a tab ID into an object.	2
TabFormBase::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
TabFormBase::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.

You are here

abstract class TabFormBase in Block Tabs 8

Hierarchy

File

Namespace

Members

API Navigation