You are here

Home » API reference » Switch Page Theme 8 » SwitchPageThemeSettingForm.php

class SwitchPageThemeSettingForm in Switch Page Theme 8

Same name and namespace in other branches
  1. 8.3 src/Form/SwitchPageThemeSettingForm.php \Drupal\switch_page_theme\Form\SwitchPageThemeSettingForm
  2. 8.2 src/Form/SwitchPageThemeSettingForm.php \Drupal\switch_page_theme\Form\SwitchPageThemeSettingForm

Configuration page for Switch page theme settings.

Hierarchy

Expanded class hierarchy of SwitchPageThemeSettingForm

1 string reference to 'SwitchPageThemeSettingForm'
switch_page_theme.routing.yml in ./switch_page_theme.routing.yml
switch_page_theme.routing.yml

File

src/Form/SwitchPageThemeSettingForm.php, line 17

Namespace

Drupal\switch_page_theme\Form
View source 
class SwitchPageThemeSettingForm extends ConfigFormBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The Domain storage service.
   *
   * @var \Drupal\domain\DomainStorageInterface
   */
  protected $domainStorage;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The theme handler.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * Construct function.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory load.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\domain\DomainLoader $domain_loader
   *   The domain loader.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager service.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   The theme handler.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler, DomainStorageInterface $domain_storage = NULL, LanguageManagerInterface $language_manager = NULL, ThemeHandlerInterface $theme_handler = NULL) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
    if ($domain_storage) {
      $this->domainStorage = $domain_storage;
    }
    if ($language_manager) {
      $this->languageManager = $language_manager;
    }
    $this->themeHandler = $theme_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $domainServices = NULL;
    $languageServices = NULL;
    if ($container
      ->has('domain.negotiator')) {
      $domainServices = $container
        ->get('entity_type.manager')
        ->getStorage('domain');
    }
    if ($container
      ->has('language_manager')) {
      $languageServices = $container
        ->get('language_manager');
    }
    return new static($container
      ->get('config.factory'), $container
      ->get('module_handler'), $domainServices, $languageServices, $container
      ->get('theme_handler'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'switch_page_theme.settings',
    ];
  }

  /**
   * {@inheritdoc}
   *
   * Implements admin settings form.
   *
   * @param array $form
   *   From render array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current state of form.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Fetch configurations if saved.
    $config = $this
      ->config('switch_page_theme.settings');

    // Instructions.
    $availableSettings = $this
      ->t('Roles');
    if ($this->moduleHandler
      ->moduleExists('domain')) {
      $availableSettings .= '/' . $this
        ->t('Domains');
    }
    if ($this->languageManager
      ->isMultilingual() || $this->moduleHandler
      ->moduleExists('language')) {
      $availableSettings .= '/' . $this
        ->t('Languages');
    }
    $form['desc'] = [
      '#type' => 'markup',
      '#markup' => $this
        ->t('<b>Enabled:</b> Rule will work only if checkbox is checked.<br><b>Pages:</b> Enter one path per line. The "*" character is a wildcard. Example paths are "/node/1" for an individual piece of content or "/node/*" for every piece of content. "@front" is the front page.<br><b>Theme key:</b> Enter the theme key value to access the selected theme, e.g. Pass AAABBBCCC in the theme key field to access the theme on URL?theme_key=AAABBBCCC.<br><b>@availableSettings:</b> Select none to allow all.<br><br>Theme with highest weight will be applied on the page.', [
        '@availableSettings' => $availableSettings,
        '@front' => '<front>',
      ]),
    ];

    // Create headers for table.
    $header = [
      $this
        ->t('Enabled'),
      $this
        ->t('pages'),
      $this
        ->t('Theme Key'),
      $this
        ->t('Themes'),
      $this
        ->t('Roles'),
    ];
    if ($this->moduleHandler
      ->moduleExists('domain')) {
      $header[] = $this
        ->t('Domain');
    }
    if ($this->languageManager
      ->isMultilingual() || $this->moduleHandler
      ->moduleExists('language')) {
      $header[] = $this
        ->t('Language');
    }
    array_push($header, $this
      ->t('Operation'), $this
      ->t('Weight'));

    // Multi value table form.
    $form['spt_table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#empty' => $this
        ->t('There are no items yet. Add an item.', []),
      '#prefix' => '<div id="spt-fieldset-wrapper">',
      '#suffix' => '</div>',
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'spt_table-order-weight',
        ],
      ],
    ];

    // Available themes.
    $themes = $this->themeHandler
      ->listInfo();
    $themeNames[''] = '--Select--';
    foreach ($themes as $key => $value) {
      $themeNames[$key] = $value->info['name'];
    }

    // Set table values on Add/Remove or on page load.
    $spt_table = $form_state
      ->get('spt_table');
    if (empty($spt_table)) {

      // Set data from configuration on page load.
      // Set empty element if no configurations are set.
      if (!empty($config
        ->get('spt_table'))) {
        $spt_table = $config
          ->get('spt_table');
        $form_state
          ->set('spt_table', $spt_table);
      }
      else {
        $spt_table = [
          '',
        ];
        $form_state
          ->set('spt_table', $spt_table);
      }
    }

    // Provide ability to remove first element.
    // Set Pages & Theme to required based on condition.
    $required = TRUE;
    if (isset($spt_table['removed']) && $spt_table['removed']) {

      // Not required if first element is empty.
      $first_element = reset($spt_table);
      $req_roles = FALSE;
      if ($first_element['pages'] == '' && $first_element['theme_key'] == '' && $first_element['theme'] == '' && $first_element['status'] == '') {
        foreach ($first_element['roles'] as $key => $value) {
          if ($value != 0) {
            $req_roles = TRUE;
          }
        }
        if (!$req_roles) {
          $required = FALSE;
        }
      }
      unset($spt_table['removed']);
    }

    // Don't allow to add multiple elements after all rows are removed.
    if (count($spt_table) > 1) {
      $required = TRUE;
    }

    // Create row for table.
    foreach ($spt_table as $i => $value) {
      $form['spt_table'][$i]['#attributes']['class'][] = 'draggable';
      $form['spt_table'][$i]['status'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Status'),
        '#title_display' => 'invisible',
        '#default_value' => isset($value['status']) ? $value['status'] : NULL,
      ];
      $form['spt_table'][$i]['pages'] = [
        '#type' => 'textarea',
        '#title' => $this
          ->t('Pages'),
        '#title_display' => 'invisible',
        '#required' => $required,
        '#cols' => '5',
        '#rows' => '5',
        '#default_value' => isset($value['pages']) ? $value['pages'] : [],
      ];
      $form['spt_table'][$i]['theme_key'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Theme Key'),
        '#title_display' => 'invisible',
        '#size' => 20,
        '#default_value' => isset($value['theme_key']) ? $value['theme_key'] : [],
      ];
      $form['spt_table'][$i]['theme'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Theme'),
        '#title_display' => 'invisible',
        '#options' => $themeNames,
        '#required' => $required,
        '#default_value' => isset($value['theme']) ? $value['theme'] : [],
      ];
      $form['spt_table'][$i]['roles'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Roles'),
        '#title_display' => 'invisible',
        '#options' => user_role_names(),
        '#default_value' => isset($value['roles']) ? $value['roles'] : [],
      ];

      // Add Domains if domain module is available.
      $domainNames = [];
      if ($this->moduleHandler
        ->moduleExists('domain')) {
        foreach ($this->domainStorage
          ->loadMultiple() as $domain_key => $domain) {
          $domainNames[$domain_key] = $domain
            ->getHostname();
        }
        $form['spt_table'][$i]['domain'] = [
          '#type' => 'checkboxes',
          '#title' => $this
            ->t('Domain'),
          '#title_display' => 'invisible',
          '#options' => $domainNames,
          '#default_value' => isset($value['domain']) ? $value['domain'] : [],
        ];
      }

      // Add Language if site is multilingual.
      if ($this->languageManager
        ->isMultilingual() || $this->moduleHandler
        ->moduleExists('language')) {
        $langNames = [];
        foreach ($this->languageManager
          ->getLanguages() as $langkey => $langvalue) {
          $langNames[$langkey] = $langvalue
            ->getName();
        }
        $form['spt_table'][$i]['language'] = [
          '#type' => 'checkboxes',
          '#title' => $this
            ->t('Language'),
          '#title_display' => 'invisible',
          '#options' => $langNames,
          '#default_value' => isset($value['language']) ? $value['language'] : [],
        ];
      }
      $form['spt_table'][$i]['remove'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Remove'),
        '#name' => "remove-" . $i,
        '#submit' => [
          '::removeElement',
        ],
        '#limit_validation_errors' => [],
        '#ajax' => [
          'callback' => '::removeCallback',
          'wrapper' => 'spt-fieldset-wrapper',
        ],
        '#index_position' => $i,
      ];

      // TableDrag: Weight column element.
      $form['spt_table'][$i]['weight'] = [
        '#type' => 'weight',
        '#title_display' => 'invisible',
        '#default_value' => isset($value['weight']) ? $value['weight'] : [],
        '#attributes' => [
          'class' => [
            'spt_table-order-weight',
          ],
        ],
      ];
    }
    $form['add_name'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add one more'),
      '#submit' => [
        '::addOne',
      ],
      '#ajax' => [
        'callback' => '::addmoreCallback',
        'wrapper' => 'spt-fieldset-wrapper',
      ],
    ];
    $form_state
      ->setCached(FALSE);
    return parent::buildForm($form, $form_state);
  }

  /**
   * Callback for ajax-enabled add buttons.
   *
   * Selects and returns the fieldset with the names in it.
   */
  public function addmoreCallback(array &$form, FormStateInterface $form_state) {
    return $form['spt_table'];
  }

  /**
   * Submit handler for the "Add one more" button.
   *
   * Add a blank element in table and causes a rebuild.
   */
  public function addOne(array &$form, FormStateInterface $form_state) {
    $spt_table = $form_state
      ->get('spt_table');
    array_push($spt_table, "");
    $form_state
      ->set('spt_table', $spt_table);
    $form_state
      ->setRebuild();
  }

  /**
   * Callback for ajax-enabled remove buttons.
   *
   * Selects and returns the fieldset with the names in it.
   */
  public function removeCallback(array &$form, FormStateInterface $form_state) {
    return $form['spt_table'];
  }

  /**
   * Submit handler for the "Remove" button(s).
   *
   * Remove the element from table and causes a form rebuild.
   */
  public function removeElement(array &$form, FormStateInterface $form_state) {

    // Get table.
    $spt_table = $form_state
      ->get('spt_table');

    // Get element to remove.
    $remove = key($form_state
      ->getValue('spt_table'));

    // Remove element.
    unset($spt_table[$remove]);

    // Set an empty element if no elements are left.
    if (empty($spt_table)) {
      array_push($spt_table, "");
    }

    // Set removed flag for removed item.
    $spt_table['removed'] = TRUE;
    $form_state
      ->set('spt_table', $spt_table);
    $form_state
      ->setRebuild();
  }

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

    // Retrieve the configuration.
    $this
      ->config('switch_page_theme.settings')
      ->set('spt_table', $form_state
      ->getValue('spt_table'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
SwitchPageThemeSettingForm::$domainStorage protected property The Domain storage service.
SwitchPageThemeSettingForm::$languageManager protected property The language manager.
SwitchPageThemeSettingForm::$moduleHandler protected property The module handler.
SwitchPageThemeSettingForm::$themeHandler protected property The theme handler.
SwitchPageThemeSettingForm::addmoreCallback public function Callback for ajax-enabled add buttons.
SwitchPageThemeSettingForm::addOne public function Submit handler for the "Add one more" button.
SwitchPageThemeSettingForm::buildForm public function Implements admin settings form. Overrides ConfigFormBase::buildForm
SwitchPageThemeSettingForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SwitchPageThemeSettingForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SwitchPageThemeSettingForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SwitchPageThemeSettingForm::removeCallback public function Callback for ajax-enabled remove buttons.
SwitchPageThemeSettingForm::removeElement public function Submit handler for the "Remove" button(s).
SwitchPageThemeSettingForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SwitchPageThemeSettingForm::__construct public function Construct function. Overrides ConfigFormBase::__construct
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.