class SystemAdminThemePreprocess

Hook implementations for system.

Hierarchy

Expanded class hierarchy of SystemAdminThemePreprocess

2 files declare their use of SystemAdminThemePreprocess
system.module in core/modules/system/system.module
SystemThemeHooks.php in core/modules/system/src/Hook/SystemThemeHooks.php
1 string reference to 'SystemAdminThemePreprocess'
system.services.yml in core/modules/system/system.services.yml
core/modules/system/system.services.yml
1 service uses SystemAdminThemePreprocess
Drupal\system\Theme\SystemAdminThemePreprocess in core/modules/system/system.services.yml
Drupal\system\Theme\SystemAdminThemePreprocess

File

core/modules/system/src/Theme/SystemAdminThemePreprocess.php, line 22

Namespace

Drupal\system\Theme
View source
class SystemAdminThemePreprocess {
  use StringTranslationTrait;
  public function __construct(protected ThemeExtensionList $themeExtensionList, protected ModuleExtensionList $moduleExtensionList, protected RendererInterface $renderer, protected ModuleHandlerInterface $moduleHandler, protected AccountInterface $currentUser) {
  }
  
  /**
   * Prepares variables for administrative content block templates.
   *
   * Default template: admin-block-content.html.twig.
   *
   * @param array $variables
   *   An associative array containing:
   *   - content: List of administrative menu items. Each menu item contains:
   *     - url: Path to the admin section.
   *     - title: Short name of the section.
   *     - description: Description of the administrative menu item.
   *     - options: URL options. See \Drupal\Core\Url::fromUri() for details.
   */
  public function preprocessAdminBlockContent(array &$variables) : void {
    if (!empty($variables['content'])) {
      $variables['compact'] = system_admin_compact_mode();
      foreach ($variables['content'] as $key => $item) {
        $variables['content'][$key]['link'] = Link::fromTextAndUrl($item['title'], $item['url'])->toString();
        if (!$variables['compact'] && !empty($item['description'])) {
          $variables['content'][$key]['description'] = [
            '#markup' => $item['description'],
          ];
        }
        else {
          $variables['content'][$key]['description'] = FALSE;
        }
      }
    }
  }
  
  /**
   * Prepares variables for administrative index page templates.
   *
   * Default template: admin-page.html.twig.
   *
   * @param array $variables
   *   An associative array containing:
   *   - blocks: An array of blocks to display. Each array should include a
   *     'title', a 'description', a formatted 'content' and a 'position' which
   *     will control which container it will be in. This is usually 'left' or
   *     'right'.
   */
  public function preprocessAdminPage(array &$variables) : void {
    $variables['system_compact_link'] = [
      '#type' => 'system_compact_link',
    ];
    $variables['containers'] = [];
    $stripe = 0;
    foreach ($variables['blocks'] as $block) {
      if (!empty($block['content']['#content'])) {
        if (empty($block['position'])) {
          // Perform automatic striping.
          $block['position'] = ++$stripe % 2 ? 'left' : 'right';
        }
        $variables['containers'][$block['position']]['blocks'][] = [
          '#theme' => 'admin_block',
          '#block' => $block,
        ];
      }
    }
  }
  
  /**
   * Prepares variables for admin index templates.
   *
   * Default template: system-admin-index.html.twig.
   *
   * @param array $variables
   *   An associative array containing:
   *   - menu_items: An array of modules to be displayed.
   */
  public function preprocessSystemAdminIndex(array &$variables) : void {
    $variables['system_compact_link'] = [
      '#type' => 'system_compact_link',
    ];
    $variables['containers'] = [];
    $stripe = 0;
    // Iterate over all modules.
    foreach ($variables['menu_items'] as $module => $block) {
      [$description, $items] = $block;
      $position = ++$stripe % 2 ? 'left' : 'right';
      // Output links.
      if (count($items)) {
        $variables['containers'][$position][] = [
          '#theme' => 'admin_block',
          '#block' => [
            'position' => $position,
            'title' => $module,
            'content' => [
              '#theme' => 'admin_block_content',
              '#content' => $items,
            ],
            // phpcs:ignore Drupal.Semantics.FunctionT.NotLiteralString
'description' => $this->t($description),
          ],
        ];
      }
    }
  }
  
  /**
   * Prepares variables for the module details templates.
   *
   * Default template: system-modules-details.html.twig.
   *
   * @param array $variables
   *   An associative array containing:
   *   - form: A render element representing the form. The main form element
   *     represents a package, and child elements of the form are individual
   *     projects. Each project (or module) is an associative array containing
   *     the following elements:
   *     - name: The name of the module.
   *     - enable: A checkbox for enabling the module.
   *     - description: A description of the module.
   *     - version: The version of the module.
   *     - links: Administration links provided by the module.
   *     - #requires: A list of modules that the project requires.
   *     - #required_by: A list of modules and themes that require the project.
   *     - #attributes: A list of attributes for the module wrapper.
   *
   * @see \Drupal\system\Form\ModulesListForm
   */
  public function preprocessSystemModulesDetails(array &$variables) : void {
    $form = $variables['form'];
    // Identify modules that are depended on by themes.
    // Added here instead of ModuleHandler to avoid recursion.
    $themes = $this->themeExtensionList
      ->getList();
    foreach ($themes as $theme) {
      foreach ($theme->info['dependencies'] as $dependency) {
        if (isset($form[$dependency])) {
          // Add themes to the module's required by list.
          $form[$dependency]['#required_by'][] = $theme->status ? $this->t('@theme', [
            '@theme (theme)' => $theme->info['name'],
          ]) : $this->t('@theme (theme) (<span class="admin-disabled">disabled</span>)', [
            '@theme' => $theme->info['name'],
          ]);
        }
      }
    }
    $variables['modules'] = [];
    // Iterate through all the modules, which are children of this element.
    foreach (Element::children($form) as $key) {
      // Stick the key into $module for easier access.
      $module = $form[$key];
      unset($module['enable']['#title']);
      $module['#requires'] = array_filter($module['#requires']);
      $module['#required_by'] = array_filter($module['#required_by']);
      // Add the checkbox to allow installing new modules and to show the
      // installation status of the module.
      $module['checkbox'] = $module['enable'];
      // Add the module label and expand/collapse functionality.
      $id = Html::getUniqueId('module-' . $key);
      $module['id'] = $id;
      $module['enable_id'] = $module['enable']['#id'];
      // @todo Remove early rendering and use safe_join in the Twig template once
      //   https://www.drupal.org/node/2579091 is fixed.
      $machine_name_render = [
        '#prefix' => '<span dir="ltr" class="table-filter-text-source">',
        '#plain_text' => $key,
        '#suffix' => '</span>',
      ];
      $module['machine_name'] = $this->renderer
        ->render($machine_name_render);
      if (!empty($module['#requires'])) {
        $requires = [
          '#theme' => 'item_list',
          '#items' => $module['#requires'],
          '#context' => [
            'list_style' => 'comma-list',
          ],
        ];
        $module['requires'] = $this->renderer
          ->render($requires);
      }
      if (!empty($module['#required_by'])) {
        $required_by = [
          '#theme' => 'item_list',
          '#items' => $module['#required_by'],
          '#context' => [
            'list_style' => 'comma-list',
          ],
        ];
        $module['required_by'] = $this->renderer
          ->render($required_by);
      }
      if (!empty($module['version'])) {
        $module['version'] = $this->renderer
          ->render($module['version']);
      }
      $module['attributes'] = new Attribute($module['#attributes']);
      $variables['modules'][] = $module;
    }
  }
  
  /**
   * Prepares variables for module uninstall templates.
   *
   * Default template: system-modules-uninstall.html.twig.
   *
   * @param array $variables
   *   An associative array containing:
   *   - form: A render element representing the form. Child elements of the
   *     form are individual modules. Each module is an associative array
   *     containing the following elements:
   *     - #module_name: The name of the module as a string.
   *     - name: The name of the module in a renderable array.
   *     - description: A description of the module.
   *     - #required_by: (optional) A list of modules that require the module.
   *     - #validation_reasons: (optional) Additional reasons why the module
   *       cannot be uninstalled.
   *     - #attributes: A list of attributes for the module wrapper.
   *
   * @ingroup themeable
   */
  public function preprocessSystemModulesUninstall(array &$variables) : void {
    $form = $variables['form'];
    $variables['modules'] = [];
    // Iterate through all the modules, which are children of this element.
    foreach (Element::children($form['modules']) as $key) {
      $module = $form['modules'][$key];
      $module['module_name'] = $module['#module_name'];
      $module['checkbox'] = $form['uninstall'][$key];
      $module['checkbox_id'] = $form['uninstall'][$key]['#id'];
      if (!empty($module['#validation_reasons'])) {
        $module['validation_reasons'] = $module['#validation_reasons'];
        $module['reasons_count'] = count($module['validation_reasons']);
      }
      else {
        $module['reasons_count'] = 0;
      }
      if (!empty($module['#required_by'])) {
        $module['required_by'] = $module['#required_by'];
        $module['reasons_count'] = $module['reasons_count'] + 1;
      }
      $module['attributes'] = new Attribute($module['#attributes']);
      $variables['modules'][] = $module;
    }
  }
  
  /**
   * Prepares variables for appearance page templates.
   *
   * Default template: system-themes-page.html.twig.
   *
   * @param array $variables
   *   An associative array containing:
   *   - theme_groups: An associative array containing groups of themes.
   *   - theme_group_titles: An associative array containing titles of themes.
   */
  public function preprocessSystemThemesPage(&$variables) : void {
    $groups = [];
    $theme_groups = $variables['theme_groups'];
    $variables['attributes']['id'] = 'system-themes-page';
    foreach ($variables['theme_group_titles'] as $state => $title) {
      if (!count($theme_groups[$state])) {
        // Skip this group of themes if no theme is there.
        continue;
      }
      // Start new theme group.
      $theme_group = [];
      $theme_group['state'] = $state;
      $theme_group['title'] = $title;
      $theme_group['themes'] = [];
      $theme_group['attributes'] = new Attribute();
      foreach ($theme_groups[$state] as $theme) {
        $current_theme = [];
        // Screenshot depicting the theme.
        if ($theme->screenshot) {
          $current_theme['screenshot'] = [
            '#theme' => 'image',
            '#uri' => $theme->screenshot['uri'],
            '#alt' => $theme->screenshot['alt'],
            '#title' => $theme->screenshot['title'],
            '#attributes' => $theme->screenshot['attributes'],
          ];
        }
        else {
          $current_theme['screenshot'] = [
            '#theme' => 'image',
            '#uri' => $this->moduleExtensionList
              ->getPath('system') . '/images/no_screenshot.png',
            '#alt' => $this->t('No screenshot'),
            '#title' => $this->t('No screenshot'),
            '#attributes' => new Attribute([
              'class' => [
                'no-screenshot',
              ],
            ]),
          ];
        }
        // Localize the theme description.
        // phpcs:ignore Drupal.Semantics.FunctionT.NotLiteralString
        $current_theme['description'] = Markup::create(Xss::filterAdmin($this->t($theme->info['description'])));
        $current_theme['attributes'] = new Attribute();
        $current_theme['name'] = $theme->info['name'];
        $current_theme['version'] = $theme->info['version'] ?? '';
        $current_theme['notes'] = $theme->notes;
        $current_theme['is_default'] = $theme->is_default;
        $current_theme['is_admin'] = $theme->is_admin;
        $current_theme['module_dependencies'] = !empty($theme->module_dependencies_list) ? [
          '#theme' => 'item_list',
          '#items' => $theme->module_dependencies_list,
          '#context' => [
            'list_style' => 'comma-list',
          ],
        ] : [];
        // Make sure to provide feedback on compatibility.
        $current_theme['incompatible'] = '';
        if (!empty($theme->info['core_incompatible'])) {
          $current_theme['incompatible'] = $this->t("This theme is not compatible with Drupal @core_version. Check that the .info.yml file contains a compatible 'core' or 'core_version_requirement' value.", [
            '@core_version' => \Drupal::VERSION,
          ]);
        }
        elseif (!empty($theme->incompatible_region)) {
          $current_theme['incompatible'] = $this->t("This theme is missing a 'content' region.");
        }
        elseif (!empty($theme->incompatible_php)) {
          if (substr_count($theme->info['php'], '.') < 2) {
            $theme->info['php'] .= '.*';
          }
          $current_theme['incompatible'] = $this->t('This theme requires PHP version @php_required and is incompatible with PHP version @php_version.', [
            '@php_required' => $theme->info['php'],
            '@php_version' => phpversion(),
          ]);
        }
        elseif (!empty($theme->incompatible_base)) {
          $current_theme['incompatible'] = $this->t('This theme requires the base theme @base_theme to operate correctly.', [
            '@base_theme' => $theme->info['base theme'],
          ]);
        }
        elseif (!empty($theme->incompatible_engine)) {
          $current_theme['incompatible'] = $this->t('This theme requires the theme engine @theme_engine to operate correctly.', [
            '@theme_engine' => $theme->info['engine'],
          ]);
        }
        elseif (!empty($theme->incompatible_module)) {
          $current_theme['incompatible'] = $this->t('This theme requires the listed modules to operate correctly.');
        }
        elseif (!empty($theme->module_dependencies_disabled)) {
          if (!empty($theme->insufficient_module_permissions)) {
            $current_theme['incompatible'] = $this->t('This theme requires the listed modules to operate correctly. They must first be installed by a user with permissions to do so.');
          }
          else {
            $modules_url = (string) Url::fromRoute('system.modules_list')->toString();
            $current_theme['incompatible'] = $this->t('This theme requires the listed modules to operate correctly. They must first be installed via the <a href=":modules_url">Extend page</a>.', [
              ':modules_url' => $modules_url,
            ]);
          }
        }
        // Build operation links.
        $current_theme['operations'] = [
          '#theme' => 'links',
          '#links' => $theme->operations,
          '#attributes' => [
            'class' => [
              'operations',
              'clearfix',
            ],
          ],
        ];
        $theme_group['themes'][] = $current_theme;
      }
      $groups[] = $theme_group;
    }
    $variables['theme_groups'] = $groups;
  }
  
  /**
   * Prepares variables for security advisories fetch error message templates.
   *
   * Default template: system-security-advisories-fetch-error-message.html.twig.
   *
   * @param array $variables
   *   An associative array of template variables.
   */
  public function preprocessSystemSecurityAdvisoriesFetchErrorMessage(array &$variables) : void {
    $variables['error_message'] = [
      'message' => [
        '#markup' => $this->t('Failed to fetch security advisory data:'),
      ],
      'items' => [
        '#theme' => 'item_list',
        '#items' => [
          'documentation_link' => $this->t('See <a href=":url">Troubleshooting the advisory feed</a> for possible causes and resolutions.', [
            ':url' => 'https://www.drupal.org/docs/updating-drupal/responding-to-critical-security-update-advisories#s-troubleshooting-the-advisory-feed',
          ]),
        ],
      ],
    ];
    if ($this->moduleHandler
      ->moduleExists('dblog') && $this->currentUser
      ->hasPermission('access site reports')) {
      $options = [
        'query' => [
          'type' => [
            'system',
          ],
        ],
      ];
      $dblog_url = Url::fromRoute('dblog.overview', [], $options);
      $variables['error_message']['items']['#items']['dblog'] = $this->t('Check <a href=":url">your local system logs</a> for additional error messages.', [
        ':url' => $dblog_url->toString(),
      ]);
    }
    else {
      $variables['error_message']['items']['#items']['logs'] = $this->t('Check your local system logs for additional error messages.');
    }
  }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1
SystemAdminThemePreprocess::preprocessAdminBlockContent public function Prepares variables for administrative content block templates.
SystemAdminThemePreprocess::preprocessAdminPage public function Prepares variables for administrative index page templates.
SystemAdminThemePreprocess::preprocessSystemAdminIndex public function Prepares variables for admin index templates.
SystemAdminThemePreprocess::preprocessSystemModulesDetails public function Prepares variables for the module details templates.
SystemAdminThemePreprocess::preprocessSystemModulesUninstall public function Prepares variables for module uninstall templates.
SystemAdminThemePreprocess::preprocessSystemSecurityAdvisoriesFetchErrorMessage public function Prepares variables for security advisories fetch error message templates.
SystemAdminThemePreprocess::preprocessSystemThemesPage public function Prepares variables for appearance page templates.
SystemAdminThemePreprocess::__construct public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.