function SystemController::themesPage

Returns a theme listing which excludes obsolete themes.

@todo Move into ThemeController.

Return value

string An HTML string of the theme listing page.

File

core/modules/system/src/Controller/SystemController.php, line 205

Class

SystemController

Returns responses for System routes.

Namespace

Code

public function themesPage() {
    $config = $this->config('system.theme');
    // Get all available themes.
    $themes = $this->themeHandler
        ->rebuildThemeData();
    // Remove obsolete themes.
    $themes = array_filter($themes, function ($theme) {
        return !$theme->isObsolete();
    });
    uasort($themes, [
        ThemeExtensionList::class,
        'sortByName',
    ]);
    $theme_default = $config->get('default');
    $theme_groups = [
        'installed' => [],
        'uninstalled' => [],
    ];
    $admin_theme = $config->get('admin');
    $admin_theme_options = [];
    $incompatible_installed = FALSE;
    foreach ($themes as &$theme) {
        if (!empty($theme->info['hidden'])) {
            continue;
        }
        if (!$incompatible_installed && $theme->info['core_incompatible'] && $theme->status) {
            $incompatible_installed = TRUE;
            $this->messenger()
                ->addWarning($this->t('There are errors with some installed themes. Visit the <a href=":link">status report page</a> for more information.', [
                ':link' => Url::fromRoute('system.status')->toString(),
            ]));
        }
        $theme->is_default = $theme->getName() == $theme_default;
        $theme->is_admin = $theme->getName() == $admin_theme || $theme->is_default && empty($admin_theme);
        // Identify theme screenshot.
        $theme->screenshot = NULL;
        // Create a list which includes the current theme and all its base themes.
        if (isset($themes[$theme->getName()]->base_themes)) {
            $theme_keys = array_keys($themes[$theme->getName()]->base_themes);
            $theme_keys[] = $theme->getName();
        }
        else {
            $theme_keys = [
                $theme->getName(),
            ];
        }
        // Look for a screenshot in the current theme or in its closest ancestor.
        foreach (array_reverse($theme_keys) as $theme_key) {
            if (isset($themes[$theme_key]) && file_exists($themes[$theme_key]->info['screenshot'])) {
                $theme->screenshot = [
                    'uri' => $themes[$theme_key]->info['screenshot'],
                    'alt' => $this->t('Screenshot for @theme theme', [
                        '@theme' => $theme->info['name'],
                    ]),
                    'title' => $this->t('Screenshot for @theme theme', [
                        '@theme' => $theme->info['name'],
                    ]),
                    'attributes' => [
                        'class' => [
                            'screenshot',
                        ],
                    ],
                ];
                break;
            }
        }
        if (empty($theme->status)) {
            // Require the 'content' region to make sure the main page
            // content has a common place in all themes.
            $theme->incompatible_region = !isset($theme->info['regions']['content']);
            $theme->incompatible_php = version_compare(phpversion(), $theme->info['php']) < 0;
            // Confirm that all base themes are available.
            $theme->incompatible_base = isset($theme->info['base theme']) && !($theme->base_themes === array_filter($theme->base_themes));
            // Confirm that the theme engine is available.
            $theme->incompatible_engine = isset($theme->info['engine']) && !isset($theme->owner);
            // Confirm that module dependencies are available.
            $theme->incompatible_module = FALSE;
            // Confirm that the user has permission to enable modules.
            $theme->insufficient_module_permissions = FALSE;
        }
        // Check module dependencies.
        if ($theme->module_dependencies) {
            $modules = $this->moduleExtensionList
                ->getList();
            foreach ($theme->module_dependencies as $dependency => $dependency_object) {
                if ($incompatible = $this->checkDependencyMessage($modules, $dependency, $dependency_object)) {
                    $theme->module_dependencies_list[$dependency] = $incompatible;
                    $theme->incompatible_module = TRUE;
                    continue;
                }
                // @todo Add logic for not displaying hidden modules in
                //   https://drupal.org/node/3117829.
                $module_name = $modules[$dependency]->info['name'];
                $theme->module_dependencies_list[$dependency] = $modules[$dependency]->status ? $this->t('@module_name', [
                    '@module_name' => $module_name,
                ]) : $this->t('@module_name (<span class="admin-disabled">disabled</span>)', [
                    '@module_name' => $module_name,
                ]);
                // Create an additional property that contains only disabled module
                // dependencies. This will determine if it is possible to install the
                // theme, or if modules must first be enabled.
                if (!$modules[$dependency]->status) {
                    $theme->module_dependencies_disabled[$dependency] = $module_name;
                    if (!$this->currentUser()
                        ->hasPermission('administer modules')) {
                        $theme->insufficient_module_permissions = TRUE;
                    }
                }
            }
        }
        $theme->operations = [];
        if (!empty($theme->status) || !$theme->info['core_incompatible'] && !$theme->incompatible_php && !$theme->incompatible_base && !$theme->incompatible_engine && !$theme->incompatible_module && empty($theme->module_dependencies_disabled)) {
            // Create the operations links.
            $query['theme'] = $theme->getName();
            if ($this->themeAccess
                ->checkAccess($theme->getName())) {
                $theme->operations[] = [
                    'title' => $this->t('Settings'),
                    'url' => Url::fromRoute('system.theme_settings_theme', [
                        'theme' => $theme->getName(),
                    ]),
                    'attributes' => [
                        'title' => $this->t('Settings for @theme theme', [
                            '@theme' => $theme->info['name'],
                        ]),
                    ],
                ];
            }
            if (!empty($theme->status)) {
                if (!$theme->is_default) {
                    $theme_uninstallable = TRUE;
                    if ($theme->getName() == $admin_theme) {
                        $theme_uninstallable = FALSE;
                    }
                    // Check it isn't the base of theme of an installed theme.
                    foreach ($theme->required_by as $themename => $dependency) {
                        if (!empty($themes[$themename]->status)) {
                            $theme_uninstallable = FALSE;
                        }
                    }
                    if ($theme_uninstallable) {
                        $theme->operations[] = [
                            'title' => $this->t('Uninstall'),
                            'url' => Url::fromRoute('system.theme_uninstall'),
                            'query' => $query,
                            'attributes' => [
                                'title' => $this->t('Uninstall @theme theme', [
                                    '@theme' => $theme->info['name'],
                                ]),
                            ],
                        ];
                    }
                    $theme->operations[] = [
                        'title' => $this->t('Set as default'),
                        'url' => Url::fromRoute('system.theme_set_default'),
                        'query' => $query,
                        'attributes' => [
                            'title' => $this->t('Set @theme as default theme', [
                                '@theme' => $theme->info['name'],
                            ]),
                        ],
                    ];
                }
                $admin_theme_options[$theme->getName()] = $theme->info['name'] . ($theme->isExperimental() ? ' (' . t('Experimental') . ')' : '');
            }
            else {
                $theme->operations[] = [
                    'title' => $this->t('Install'),
                    'url' => Url::fromRoute('system.theme_install'),
                    'query' => $query,
                    'attributes' => [
                        'title' => $this->t('Install @theme theme', [
                            '@theme' => $theme->info['name'],
                        ]),
                    ],
                ];
                $theme->operations[] = [
                    'title' => $this->t('Install and set as default'),
                    'url' => Url::fromRoute('system.theme_set_default'),
                    'query' => $query,
                    'attributes' => [
                        'title' => $this->t('Install @theme as default theme', [
                            '@theme' => $theme->info['name'],
                        ]),
                    ],
                ];
            }
        }
        // Add notes to default theme, administration theme and non-stable themes.
        $theme->notes = [];
        if ($theme->is_default) {
            $theme->notes[] = $this->t('default theme');
        }
        if ($theme->is_admin) {
            $theme->notes[] = $this->t('administration theme');
        }
        $lifecycle = $theme->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER];
        if (!empty($theme->info[ExtensionLifecycle::LIFECYCLE_LINK_IDENTIFIER])) {
            $theme->notes[] = Link::fromTextAndUrl($this->t('@lifecycle', [
                '@lifecycle' => ucfirst($lifecycle),
            ]), Url::fromUri($theme->info[ExtensionLifecycle::LIFECYCLE_LINK_IDENTIFIER], [
                'attributes' => [
                    'class' => 'theme-link--non-stable',
                    'aria-label' => $this->t('View information on the @lifecycle status of the theme @theme', [
                        '@lifecycle' => ucfirst($lifecycle),
                        '@theme' => $theme->info['name'],
                    ]),
                ],
            ]))
                ->toString();
        }
        if ($theme->isExperimental() && empty($theme->info[ExtensionLifecycle::LIFECYCLE_LINK_IDENTIFIER])) {
            $theme->notes[] = $this->t('experimental theme');
        }
        // Sort installed and uninstalled themes into their own groups.
        $theme_groups[$theme->status ? 'installed' : 'uninstalled'][] = $theme;
    }
    // There are two possible theme groups.
    $theme_group_titles = [
        'installed' => $this->formatPlural(count($theme_groups['installed']), 'Installed theme', 'Installed themes'),
    ];
    if (!empty($theme_groups['uninstalled'])) {
        $theme_group_titles['uninstalled'] = $this->formatPlural(count($theme_groups['uninstalled']), 'Uninstalled theme', 'Uninstalled themes');
    }
    uasort($theme_groups['installed'], 'system_sort_themes');
    $this->moduleHandler()
        ->alter('system_themes_page', $theme_groups);
    $build = [];
    $build[] = [
        '#theme' => 'system_themes_page',
        '#theme_groups' => $theme_groups,
        '#theme_group_titles' => $theme_group_titles,
    ];
    $build[] = $this->formBuilder
        ->getForm('Drupal\\system\\Form\\ThemeAdminForm', $admin_theme_options);
    return $build;
}