interface BackdropUpdaterInterface

Interface for a class which can update a Backdrop 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.

Implemented by

Updater

Hierarchy

interface BackdropUpdaterInterface

Expanded class hierarchy of BackdropUpdaterInterface

1 string reference to 'BackdropUpdaterInterface'

backdrop_class_list in core/includes/bootstrap.classes.inc: Lists all the classes used by Backdrop core.

File

core/includes/updater.inc, line 20: Classes used for updating various files in the Backdrop webroot. These classes use a FileTransfer object to actually perform the operations. Normally, the FileTransfer is provided when the site owner is redirected to authorize.php as part of a…

View source

interface BackdropUpdaterInterface {

  /**
   * 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.
   *
   * @param string $directory
   *   The full path to the package directory.
   *
   * @return bool
   *   TRUE if the project within the directory is supported by this updater.
   */
  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

Name	Modifiers	Type	Description
BackdropUpdaterInterface::canUpdateDirectory	public static	function	Determine if the Updater can handle the project provided in $directory.
BackdropUpdaterInterface::getInstallDirectory	public	function
BackdropUpdaterInterface::getProjectName	public static	function	Returns the system name of the project.
BackdropUpdaterInterface::isInstalled	public	function	Checks if the project is installed.
BackdropUpdaterInterface::postInstall	public	function	Actions to run after an install has occurred.
BackdropUpdaterInterface::postUpdate	public	function	Actions to run after an update has occurred.