You are here

Home » API reference » Panels Breadcrumbs 8 » PageVariantBreadcrumbsForm.php

class PageVariantBreadcrumbsForm in Panels Breadcrumbs 8

Class PageVariantBreadcrumbsForm.

Hierarchy

Expanded class hierarchy of PageVariantBreadcrumbsForm

1 file declares its use of PageVariantBreadcrumbsForm
panels_breadcrumbs.module in ./panels_breadcrumbs.module
Module file for panels breadcrumbs module.

File

src/Form/PageVariantBreadcrumbsForm.php, line 12

Namespace

Drupal\panels_breadcrumbs\Form
View source 
class PageVariantBreadcrumbsForm extends FormBase {
  use PageBreadcrumbsFormTrait;

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $page_variant = $cached_values['page_variant'];
    $variant_settings = $page_variant
      ->get('variant_settings');
    $breadcrumbs_settings = isset($variant_settings['panels_breadcrumbs']) ? $variant_settings['panels_breadcrumbs'] : [];
    $form['state'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable custom breadcrumb configuration.'),
      '#default_value' => isset($breadcrumbs_settings['state']) ? $breadcrumbs_settings['state'] : FALSE,
    ];
    $form['titles'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Breadcrumb titles'),
      '#description' => $this
        ->t('Enter one title per line.'),
      '#default_value' => isset($breadcrumbs_settings['titles']) ? $breadcrumbs_settings['titles'] : '',
    ];
    $form['paths'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Breadcrumb paths'),
      '#description' => $this
        ->t('Enter one path per line. You can use @front to link
      to the front page, or @nolink for no link.', [
        '@front' => '<front>',
        '@nolink' => '<nolink>',
      ]),
      '#default_value' => isset($breadcrumbs_settings['paths']) ? $breadcrumbs_settings['paths'] : '',
    ];
    $form['home'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Prepend Home Link to the Breadcrumb'),
      '#default_value' => isset($breadcrumbs_settings['home']) ? $breadcrumbs_settings['home'] : FALSE,
    ];
    $form['home_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Home link title'),
      '#description' => $this
        ->t('Text will be displayed as Home link title in the breadcrumb'),
      '#default_value' => isset($breadcrumbs_settings['home_text']) ? $breadcrumbs_settings['home_text'] : $this
        ->t('Home'),
      '#states' => [
        'visible' => [
          ':input[name="home"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if ($token_types = $this
      ->getTypesOfTokens($page_variant)) {
      $form['tokens'] = [
        '#theme' => 'token_tree_link',
        '#token_types' => $token_types,
        '#global_types' => FALSE,
        '#dialog' => TRUE,
        '#click_insert' => FALSE,
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $page_variant = $cached_values['page_variant'];
    $variant_settings = $page_variant
      ->get('variant_settings');
    $submitted_values = $form_state
      ->getValues();
    foreach ($this
      ->getSettingsKeys() as $name) {
      $variant_settings['panels_breadcrumbs'][$name] = $submitted_values[$name];
    }
    $page_variant
      ->set('variant_settings', $variant_settings);

    // Invalidate breadcrumbs block cache.
    $theme_name = \Drupal::config('system.theme')
      ->get('default');
    Cache::invalidateTags([
      "config:block.block.{$theme_name}_breadcrumbs",
    ]);
  }

}

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
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.
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.
PageBreadcrumbsFormTrait::getSettingsKeys public static function Get panels breadcrumbs settings keys.
PageBreadcrumbsFormTrait::getTypesOfTokens public static function Get types of tokens based on contexts.
PageVariantBreadcrumbsForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
PageVariantBreadcrumbsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PageVariantBreadcrumbsForm::submitForm public function Form submission handler. Overrides FormInterface::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.