interface DrupalUpdaterInterface

Interface for a class which can update a Drupal project.

An Updater currently serves the following purposes:

  • It can take a given directory, and determine if it can operate on it.
  • It can move the contents of that directory into the appropriate place on the system using FileTransfer classes.
  • It can return a list of "next steps" after an update or install.
  • In the future, it will most likely perform some of those steps as well.

Hierarchy

Expanded class hierarchy of DrupalUpdaterInterface

All classes that implement DrupalUpdaterInterface

File

includes/updater.inc, line 21

View source 
interface DrupalUpdaterInterface {
    
    /**
     * Checks if the project is installed.
     *
     * @return bool
     */
    public function isInstalled();
    
    /**
     * Returns the system name of the project.
     *
     * @param string $directory
     *  A directory containing a project.
     */
    public static function getProjectName($directory);
    
    /**
     * @return string
     *   An absolute path to the default install location.
     */
    public function getInstallDirectory();
    
    /**
     * Determine if the Updater can handle the project provided in $directory.
     *
     * @todo: Provide something more rational here, like a project spec file.
     *
     * @param string $directory
     *
     * @return bool
     *   TRUE if the project is installed, FALSE if not.
     */
    public static function canUpdateDirectory($directory);
    
    /**
     * Actions to run after an install has occurred.
     */
    public function postInstall();
    
    /**
     * Actions to run after an update has occurred.
     */
    public function postUpdate();

}

Members

Title Modifiers Object type Summary Overrides
DrupalUpdaterInterface::canUpdateDirectory public static function Determine if the Updater can handle the project provided in $directory. 2
DrupalUpdaterInterface::getInstallDirectory public function 2
DrupalUpdaterInterface::getProjectName public static function Returns the system name of the project.
DrupalUpdaterInterface::isInstalled public function Checks if the project is installed. 2
DrupalUpdaterInterface::postInstall public function Actions to run after an install has occurred.
DrupalUpdaterInterface::postUpdate public function Actions to run after an update has occurred.

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