class Module

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

Hierarchy

Expanded class hierarchy of Module

16 string references to 'Module'
block.schema.yml in drupal/core/modules/block/config/schema/block.schema.yml
drupal/core/modules/block/config/schema/block.schema.yml
ClassLoaderTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Module/ClassLoaderTest.php
DependencyTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Module/DependencyTest.php
EnableDisableTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Module/EnableDisableTest.php
field.schema.yml in drupal/core/modules/field/config/schema/field.schema.yml
drupal/core/modules/field/config/schema/field.schema.yml

... See full list

File

drupal/core/lib/Drupal/Core/Updater/Module.php, line 14
Definition of Drupal\Core\Updater\Module.

Namespace

Drupal\Core\Updater
View source
class Module extends Updater implements UpdaterInterface {

  /**
   * Returns the directory where a module should be installed.
   *
   * If the module is already installed, drupal_get_path() will return
   * a valid path and we should install it there (although we need to use an
   * absolute path, so we prepend DRUPAL_ROOT). 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
   *   A directory path.
   */
  public function getInstallDirectory() {
    if ($relative_path = drupal_get_path('module', $this->name)) {
      $relative_path = dirname($relative_path);
    }
    else {
      $relative_path = 'modules';
    }
    return DRUPAL_ROOT . '/' . $relative_path;
  }

  /**
   * Implements Drupal\Core\Updater\UpdaterInterface::isInstalled().
   */
  public function isInstalled() {
    return (bool) drupal_get_path('module', $this->name);
  }

  /**
   * Implements Drupal\Core\Updater\UpdaterInterface::canUpdateDirectory().
   */
  public static function canUpdateDirectory($directory) {
    if (file_scan_directory($directory, '/.*\\.module$/')) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * 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_get_path('module', $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 array();
    }
    module_load_include('install', $this->name);
    if (!($updates = drupal_get_schema_versions($this->name))) {
      return array();
    }
    $modules_with_updates = update_get_update_list();
    if ($updates = $modules_with_updates[$this->name]) {
      if ($updates['start']) {
        return $updates['pending'];
      }
    }
    return array();
  }

  /**
   * Overrides Drupal\Core\Updater\Updater::postInstallTasks().
   */
  public function postInstallTasks() {
    return array(
      l(t('Install another module'), 'admin/modules/install'),
      l(t('Enable newly added modules'), 'admin/modules'),
      l(t('Administration pages'), 'admin'),
    );
  }

  /**
   * Overrides Drupal\Core\Updater\Updater::postUpdateTasks().
   */
  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

Namesort descending Modifiers Type Description Overrides
Module::canUpdate public static function Determines whether this class can update the specified project.
Module::canUpdateDirectory public static function Implements Drupal\Core\Updater\UpdaterInterface::canUpdateDirectory(). Overrides UpdaterInterface::canUpdateDirectory
Module::getInstallDirectory public function Returns the directory where a module should be installed. Overrides UpdaterInterface::getInstallDirectory
Module::getSchemaUpdates public function Returns available database schema updates once a new version is installed.
Module::isInstalled public function Implements Drupal\Core\Updater\UpdaterInterface::isInstalled(). Overrides UpdaterInterface::isInstalled
Module::postInstallTasks public function Overrides Drupal\Core\Updater\Updater::postInstallTasks(). Overrides Updater::postInstallTasks
Module::postUpdateTasks public function Overrides Drupal\Core\Updater\Updater::postUpdateTasks(). Overrides Updater::postUpdateTasks
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::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.