class Module in Drupal 9

Defines a class for updating modules using Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.

Hierarchy

• class \Drupal\Core\Updater\Updater
  • class \Drupal\Core\Updater\Module implements UpdaterInterface

6 string references to 'Module'

Action::fields in core/modules/action/src/Plugin/migrate/source/Action.php

Returns available fields on the source.

field.schema.yml in core/modules/field/config/schema/field.schema.yml

core/modules/field/config/schema/field.schema.yml

Field::fields in core/modules/field/src/Plugin/migrate/source/d6/Field.php

Returns available fields on the source.

FileViewsData::getViewsData in core/modules/file/src/FileViewsData.php

Returns views data for the entity type.

update_test.schema.yml in core/modules/update/tests/modules/update_test/config/schema/update_test.schema.yml

core/modules/update/tests/modules/update_test/config/schema/update_test.schema.yml

... See full list

File

core/lib/Drupal/Core/Updater/Module.php, line 11

Namespace

Drupal\Core\Updater

class Module extends Updater implements UpdaterInterface {

  /**
   * Returns the directory where a module should be installed.
   *
   * If the module is already installed, ModuleExtensionList::getPath() will
   * return a valid path and we should install it there. If we're installing a
   * new module, we always want it to go into /modules, since that's where all
   * the documentation recommends users install their modules, and there's no
   * way that can conflict on a multi-site installation, since the Update
   * manager won't let you install a new module 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.module')
      ->getPath($this->name))) {

      // The return value of ExtensionList::getPath() is always relative to the
      // site, so prepend DRUPAL_ROOT.
      return DRUPAL_ROOT . '/' . dirname($relative_path);
    }
    else {

      // When installing a new module, prepend the requested root directory.
      return $this->root . '/' . $this
        ->getRootDirectoryRelativePath();
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getRootDirectoryRelativePath() {
    return 'modules';
  }

  /**
   * {@inheritdoc}
   */
  public function isInstalled() {

    // Check if the module exists in the file system, regardless of whether it
    // is enabled or not.

    /** @var \Drupal\Core\Extension\ExtensionList $module_extension_list */
    $module_extension_list = \Drupal::service('extension.list.module');
    return $module_extension_list
      ->exists($this->name);
  }

  /**
   * {@inheritdoc}
   */
  public static function canUpdateDirectory($directory) {
    $info = static::getExtensionInfo($directory);
    return isset($info['type']) && $info['type'] == 'module';
  }

  /**
   * 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.module')
      ->getPath($project_name);
  }

  /**
   * Returns available database schema updates once a new version is installed.
   *
   * @return array
   */
  public function getSchemaUpdates() {
    require_once DRUPAL_ROOT . '/core/includes/install.inc';
    require_once DRUPAL_ROOT . '/core/includes/update.inc';
    if (!self::canUpdate($this->name)) {
      return [];
    }
    module_load_include('install', $this->name);
    if (!\Drupal::service('update.update_hook_registry')
      ->getAvailableUpdates($this->name)) {
      return [];
    }
    $modules_with_updates = update_get_update_list();
    if ($updates = $modules_with_updates[$this->name]) {
      if ($updates['start']) {
        return $updates['pending'];
      }
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function postInstallTasks() {

    // Since this is being called outside of the primary front controller,
    // the base_url needs to be set explicitly to ensure that links are
    // relative to the site root.
    // @todo Simplify with https://www.drupal.org/node/2548095
    $default_options = [
      '#type' => 'link',
      '#options' => [
        'absolute' => TRUE,
        'base_url' => $GLOBALS['base_url'],
      ],
    ];
    return [
      $default_options + [
        '#url' => Url::fromRoute('update.module_install'),
        '#title' => t('Add another module'),
      ],
      $default_options + [
        '#url' => Url::fromRoute('system.modules_list'),
        '#title' => t('Enable newly added modules'),
      ],
      $default_options + [
        '#url' => Url::fromRoute('system.admin'),
        '#title' => t('Administration pages'),
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function postUpdateTasks() {

    // We don't want to check for DB updates here, we do that once for all
    // updated modules on the landing page.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Module::canUpdate	public static	function	Determines whether this class can update the specified project.
Module::canUpdateDirectory	public static	function	Determines if the Updater can handle the project provided in $directory. Overrides UpdaterInterface::canUpdateDirectory
Module::getInstallDirectory	public	function	Returns the directory where a module should be installed. Overrides UpdaterInterface::getInstallDirectory
Module::getRootDirectoryRelativePath	public static	function	Returns the name of the root directory under which projects will be copied. Overrides UpdaterInterface::getRootDirectoryRelativePath
Module::getSchemaUpdates	public	function	Returns available database schema updates once a new version is installed.
Module::isInstalled	public	function	Checks if the project is installed. Overrides UpdaterInterface::isInstalled
Module::postInstallTasks	public	function	Returns an array of links to pages that should be visited post operation. Overrides Updater::postInstallTasks
Module::postUpdateTasks	public	function	Returns an array of links to pages that should be visited post operation. Overrides Updater::postUpdateTasks
Updater::$root	protected	property	The root directory under which new projects will be copied.
Updater::$source	public	property	Directory to install from.
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.	1
Updater::postUpdate	public	function	Performs actions after new code is updated.
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.