class Module
Defines a class for updating modules.
Uses Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.
Hierarchy
- class \Drupal\Core\Updater\Updater uses \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Updater\Module implements \Drupal\Core\Updater\UpdaterInterface extends \Drupal\Core\Updater\Updater
 
 
Expanded class hierarchy of Module
Deprecated
in drupal:11.2.0 and is removed from drupal:12.0.0. There is no replacement. Use composer to manage the code for your site.
See also
https://www.drupal.org/node/3512364
795 string references to 'Module'
- aaa_hook_collector_test.info.yml in core/
modules/ system/ tests/ modules/ HookCollector/ aaa_hook_collector_test/ aaa_hook_collector_test.info.yml  - core/modules/system/tests/modules/HookCollector/aaa_hook_collector_test/aaa_hook_collector_test.info.yml
 - aaa_hook_order_test.info.yml in core/
modules/ system/ tests/ modules/ HookOrder/ aaa_hook_order_test/ aaa_hook_order_test.info.yml  - core/modules/system/tests/modules/HookOrder/aaa_hook_order_test/aaa_hook_order_test.info.yml
 - aaa_update_test.info.yml in core/
modules/ update/ tests/ modules/ aaa_update_test/ aaa_update_test.info.yml  - core/modules/update/tests/modules/aaa_update_test/aaa_update_test.info.yml
 - accept_header_routing_test.info.yml in core/
modules/ system/ tests/ modules/ accept_header_routing_test/ accept_header_routing_test.info.yml  - core/modules/system/tests/modules/accept_header_routing_test/accept_header_routing_test.info.yml
 - Action::fields in core/
modules/ system/ src/ Plugin/ migrate/ source/ Action.php  - Returns available fields on the source.
 
File
- 
              core/
lib/ Drupal/ Core/ Updater/ Module.php, line 15  
Namespace
Drupal\Core\UpdaterView source
class Module extends Updater implements UpdaterInterface {
  
  /**
   * {@inheritdoc}
   */
  public function __construct($source, $root) {
    @trigger_error('The ' . __NAMESPACE__ . '\\Module class is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. There is no replacement. Use composer to manage the code for your site. See https://www.drupal.org/node/3512364', E_USER_DEPRECATED);
    parent::__construct($source, $root);
  }
  
  /**
   * 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
   *   TRUE if the the project can be updated, FALSE otherwise.
   */
  public static function canUpdate($project_name) {
    return (bool) \Drupal::service('extension.list.module')->getPath($project_name);
  }
  
  /**
   * {@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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 Updater::getInstallDirectory | |
| Module::getRootDirectoryRelativePath | public static | function | Returns the name of the root directory under which projects will be copied. | Overrides UpdaterInterface::getRootDirectoryRelativePath | |
| Module::isInstalled | public | function | Checks if the project is installed. | Overrides UpdaterInterface::isInstalled | |
| Module::postUpdateTasks | public | function | Returns an array of links to pages that should be visited post operation. | Overrides Updater::postUpdateTasks | |
| Module::__construct | public | function | Constructs a new updater. | Overrides Updater::__construct | |
| 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 | |
| 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::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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.