class Theme

Same name in other branches
  1. 9 core/lib/Drupal/Core/Updater/Theme.php \Drupal\Core\Updater\Theme
  2. 8.9.x core/lib/Drupal/Core/Updater/Theme.php \Drupal\Core\Updater\Theme
  3. 10 core/lib/Drupal/Core/Updater/Theme.php \Drupal\Core\Updater\Theme

Defines a class for updating themes.

Uses Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.

Hierarchy

Expanded class hierarchy of Theme

240 string references to 'Theme'
AdminDemoNegotiator::determineActiveTheme in core/modules/block/src/Theme/AdminDemoNegotiator.php
Determine the active theme for the request.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts in core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php
Ensures that some cache contexts are present in the current response.
AssetControllerBase::deliver in core/modules/system/src/Controller/AssetControllerBase.php
Generates an aggregate, given a filename.
big_pipe_test_theme.info.yml in core/modules/big_pipe/tests/themes/big_pipe_test_theme/big_pipe_test_theme.info.yml
core/modules/big_pipe/tests/themes/big_pipe_test_theme/big_pipe_test_theme.info.yml
block.schema.yml in core/modules/block/config/schema/block.schema.yml
core/modules/block/config/schema/block.schema.yml

... See full list

File

core/lib/Drupal/Core/Updater/Theme.php, line 10

Namespace

Drupal\Core\Updater
View source
class Theme extends Updater implements UpdaterInterface {
    
    /**
     * Returns the directory where a theme should be installed.
     *
     * If the theme is already installed,
     * \Drupal::service('extension.list.theme')->getPath() will return a valid
     * path and we should install it there. If we're installing a new theme, we
     * always want it to go into /themes, since that's where all the
     * documentation recommends users install their themes, and there's no way
     * that can conflict on a multi-site installation, since the Update manager
     * won't let you install a new theme if it's already found on your system,
     * and if there was a copy in the top-level we'd see it.
     *
     * @return string
     *   The absolute path of the directory.
     */
    public function getInstallDirectory() {
        if ($this->isInstalled() && ($relative_path = \Drupal::service('extension.list.theme')->getPath($this->name))) {
            // The return value of
            // \Drupal::service('extension.list.theme')->getPath() is always relative
            // to the site, so prepend DRUPAL_ROOT.
            return DRUPAL_ROOT . '/' . dirname($relative_path);
        }
        else {
            // When installing a new theme, prepend the requested root directory.
            return $this->root . '/' . $this->getRootDirectoryRelativePath();
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getRootDirectoryRelativePath() {
        return 'themes';
    }
    
    /**
     * {@inheritdoc}
     */
    public function isInstalled() {
        // Check if the theme exists in the file system, regardless of whether it
        // is enabled or not.
        $themes = \Drupal::state()->get('system.theme.files', []);
        return isset($themes[$this->name]);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function canUpdateDirectory($directory) {
        $info = static::getExtensionInfo($directory);
        return isset($info['type']) && $info['type'] == 'theme';
    }
    
    /**
     * Determines whether this class can update the specified project.
     *
     * @param string $project_name
     *   The project to check.
     *
     * @return bool
     */
    public static function canUpdate($project_name) {
        return (bool) \Drupal::service('extension.list.theme')->getPath($project_name);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Theme::canUpdate public static function Determines whether this class can update the specified project.
Theme::canUpdateDirectory public static function Determines if the Updater can handle the project provided in $directory. Overrides UpdaterInterface::canUpdateDirectory
Theme::getInstallDirectory public function Returns the directory where a theme should be installed. Overrides Updater::getInstallDirectory
Theme::getRootDirectoryRelativePath public static function Returns the name of the root directory under which projects will be copied. Overrides UpdaterInterface::getRootDirectoryRelativePath
Theme::isInstalled public function Checks if the project is installed. Overrides UpdaterInterface::isInstalled
Updater::$name protected property The name of the project directory (basename).
Updater::$root protected property The root directory under which new projects will be copied.
Updater::$source public property Directory to install from.
Updater::$title protected property The title of the project.
Updater::factory public static function Returns an Updater of the appropriate type depending on the source.
Updater::findInfoFile public static function Determines what the most important (or only) info file is in a directory.
Updater::getBackupDir public function Returns the full path to a directory where backups should be written.
Updater::getExtensionInfo protected static function Get Extension information from directory.
Updater::getInstallArgs protected function Stores the default parameters for the Updater.
Updater::getProjectName public static function Gets the name of the project directory (basename).
Updater::getProjectTitle public static function Returns the project name from a Drupal info file.
Updater::getUpdaterFromDirectory public static function Determines which Updater class can operate on the given directory.
Updater::install public function Installs a Drupal project, returns a list of next actions.
Updater::makeBackup public function Performs a backup.
Updater::makeWorldReadable public function Ensures that a given directory is world readable.
Updater::postInstall public function Performs actions after installation.
Updater::postInstallTasks public function Returns an array of links to pages that should be visited post operation.
Updater::postUpdate public function Performs actions after new code is updated.
Updater::postUpdateTasks public function Returns an array of links to pages that should be visited post operation. 1
Updater::prepareInstallDirectory public function Makes sure the installation parent directory exists and is writable.
Updater::update public function Updates a Drupal project and returns a list of next actions.
Updater::__construct public function Constructs a new updater.

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