You are here

Home » API reference » Theme Switcher Rules 8 » ThemeSwitcherRuleListBuilder.php

class ThemeSwitcherRuleListBuilder in Theme Switcher Rules 8

Provides a listing of theme_switcher_rule.

Hierarchy

Expanded class hierarchy of ThemeSwitcherRuleListBuilder

File

src/Controller/ThemeSwitcherRuleListBuilder.php, line 18

Namespace

Drupal\theme_switcher\Controller
View source 
class ThemeSwitcherRuleListBuilder extends DraggableListBuilder {

  /**
   * The current user object.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

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

  /**
   * Constructs a new EntityListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The active user account.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, AccountInterface $account, MessengerInterface $messenger) {
    parent::__construct($entity_type, $storage);
    $this->currentUser = $account;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('current_user'), $container
      ->get('messenger'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form[$this->entitiesKey]['#rules'] = $this->entities;
    $form['actions']['submit']['#value'] = $this
      ->t('Save configuration');

    // Only super-admins may sort switch theme rules.
    if (!$this->currentUser
      ->hasPermission('administer theme switcher rules')) {
      $form['actions']['submit']['#access'] = FALSE;
      unset($form['entities']['#tabledrag']);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this->messenger
      ->addMessage($this
      ->t('Configuration saved.'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Name');
    $header['machine_name'] = $this
      ->t('Machine name');
    $header['theme'] = $this
      ->t('Theme');
    $header['admin_theme'] = $this
      ->t('Admin Theme');
    $header['status'] = $this
      ->t('Status');
    $header += parent::buildHeader();

    // Only super-admins may sort theme_switcher_rule.
    if (!$this->currentUser
      ->hasPermission('administer theme switcher rules')) {
      unset($header['weight']);
    }
    return $header;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity
      ->label();
    $row['machine_name'] = [
      '#markup' => $entity
        ->id(),
    ];
    $not_set = '<i>- None -</i>';
    $row['theme'] = [
      '#markup' => empty($entity
        ->getTheme()) ? $not_set : $entity
        ->getTheme(),
    ];
    $row['admin_theme'] = [
      '#markup' => empty($entity
        ->getAdminTheme()) ? $not_set : $entity
        ->getAdminTheme(),
    ];
    $row['status'] = [
      '#markup' => $entity
        ->status() ? $this
        ->t('Active') : $this
        ->t('Inactive'),
      '#prefix' => $entity
        ->status() ? '<strong>' : '',
      '#suffix' => $entity
        ->status() ? '</strong>' : '',
    ];
    $row += parent::buildRow($entity);

    // Only super-admins may sort switch theme rules.
    if (!$this->currentUser
      ->hasPermission('administer theme switcher rules')) {
      unset($row['weight']);
    }
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations(EntityInterface $entity) {
    $operations = parent::getOperations($entity);

    // Only super-admins may access fast operations.
    if ($this->currentUser
      ->hasPermission('administer theme switcher rules')) {
      if ($entity
        ->status()) {
        $operations['disable'] = [
          'title' => $this
            ->t('Disable'),
          'url' => Url::fromRoute('theme_switcher.inline_action', [
            'op' => 'disable',
            'theme_switcher_rule' => $entity
              ->id(),
          ]),
          'weight' => 50,
        ];
      }
      else {
        $operations['enable'] = [
          'title' => $this
            ->t('Enable'),
          'url' => Url::fromRoute('theme_switcher.inline_action', [
            'op' => 'enable',
            'theme_switcher_rule' => $entity
              ->id(),
          ]),
          'weight' => 40,
        ];
      }
    }
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
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
DraggableListBuilder::$entities protected property The entities being listed. 1
DraggableListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render 1
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
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.
ThemeSwitcherRuleListBuilder::$currentUser protected property The current user object.
ThemeSwitcherRuleListBuilder::$messenger protected property The Messenger service. Overrides MessengerTrait::$messenger
ThemeSwitcherRuleListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
ThemeSwitcherRuleListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
ThemeSwitcherRuleListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
ThemeSwitcherRuleListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
ThemeSwitcherRuleListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ThemeSwitcherRuleListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
ThemeSwitcherRuleListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilder::submitForm
ThemeSwitcherRuleListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides DraggableListBuilder::__construct