You are here

Home » API reference » Role Theme Switcher 8 » AdminSettingsForm.php

class AdminSettingsForm in Role Theme Switcher 8

Provides the theme switcher configuration form.

Hierarchy

Expanded class hierarchy of AdminSettingsForm

1 string reference to 'AdminSettingsForm'
role_theme_switcher.routing.yml in ./role_theme_switcher.routing.yml
role_theme_switcher.routing.yml

File

src/Form/AdminSettingsForm.php, line 14

Namespace

Drupal\role_theme_switcher\Form
View source 
class AdminSettingsForm extends ConfigFormBase {

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

  /**
   * Constructs a new AdminSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   The theme handler.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ThemeHandlerInterface $theme_handler) {
    parent::__construct($config_factory);
    $this->themeHandler = $theme_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('theme_handler'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $themes = $this
      ->getThemeList();
    $form['role_theme_switcher'] = [
      '#type' => 'table',
      '#title' => $this
        ->t('Role processing order'),
      '#header' => [
        $this
          ->t('Role name'),
        $this
          ->t('Selected Theme'),
        $this
          ->t('Weight'),
      ],
      '#empty' => $this
        ->t('There are no items yet. Add roles.'),
      '#tabledrag' => [
        [
          'table_id' => 'edit-role-theme-switcher',
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'role-order-weight',
        ],
      ],
    ];
    $roles = $this
      ->getUserRoles();
    foreach ($roles as $rid => $role) {
      $form['role_theme_switcher'][$rid]['#attributes']['class'][] = 'draggable';
      $form['role_theme_switcher'][$rid]['#weight'] = $role['weight'];

      // Role name col.
      $form['role_theme_switcher'][$rid]['role'] = [
        '#plain_text' => $role['name'],
      ];

      // Theme col.
      $form['role_theme_switcher'][$rid]['theme'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Select Theme'),
        '#options' => $themes,
        '#empty_option' => $this
          ->t('Default theme'),
        '#empty_value' => '',
        '#default_value' => $role['theme'],
      ];

      // Weight col.
      $form['role_theme_switcher'][$rid]['weight'] = [
        '#type' => 'weight',
        '#title' => $this
          ->t('Weight for @title', [
          '@title' => $role['name'],
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $role['weight'],
        '#attributes' => [
          'class' => [
            'role-order-weight',
          ],
        ],
        '#delta' => 50,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $data = [];
    foreach (user_role_names() as $rid => $role) {
      $data[$rid] = $form_state
        ->getValue('role_theme_switcher')[$rid];
    }
    $this
      ->config('role_theme_switcher.settings')
      ->set('roles', $data)
      ->save();
  }

  /**
   * Generates a list of roles.
   *
   * @return array[]
   *   An array represent a list of roles ordered by weight.
   */
  private function getUserRoles() {
    $values = [];
    $config = $this
      ->config('role_theme_switcher.settings')
      ->get('roles');
    $roles = user_role_names();
    foreach ($roles as $rid => $name) {
      $values[$rid] = [
        'rid' => $rid,
        'name' => $name,
        'weight' => $config[$rid]['weight'] ? $config[$rid]['weight'] : 0,
        'theme' => $config[$rid]['theme'] ? $config[$rid]['theme'] : '',
      ];
    }

    // Properly order all rows by weight.
    uasort($values, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    return $values;
  }

  /**
   * Gets a list of active themes without hidden ones.
   *
   * @return array[]
   *   An array with all compatible active themes.
   */
  private function getThemeList() {
    $themes_list = [];
    $themes = $this->themeHandler
      ->listInfo();
    foreach ($themes as $theme) {
      if (!empty($theme->info['hidden'])) {
        continue;
      }
      $themes_list[$theme
        ->getName()] = $theme->info['name'];
    }
    return $themes_list;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdminSettingsForm::$themeHandler protected property The theme handler.
AdminSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AdminSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
AdminSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdminSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdminSettingsForm::getThemeList private function Gets a list of active themes without hidden ones.
AdminSettingsForm::getUserRoles private function Generates a list of roles.
AdminSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
AdminSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
AdminSettingsForm::__construct public function Constructs a new AdminSettingsForm object. Overrides ConfigFormBase::__construct
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.
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.
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.