Commit 9d692bc2 authored by webchick's avatar webchick
Browse files

#605270 by jhodgdon, dww, heyrocker: Fixed Document new update manager hooks.

parent 9332e835
......@@ -3789,6 +3789,66 @@ function hook_token_info_alter(&$data) {
);
}
/**
* Provide information on Updaters (classes that can update Drupal).
*
* An Updater is a class that knows how to update various parts of the Drupal
* file system, for example to update modules that have newer releases, or to
* install a new theme.
*
* @return
* An associative array of information about the updater(s) being provided.
* This array is keyed by a unique identifier for each updater, and the
* values are subarrays that can contain the following keys:
* - class: The name of the PHP class which implements this updater.
* - name: Human-readable name of this updater.
* - weight: Controls what order the Updater classes are consulted to decide
* which one should handle a given task. When an update task is being run,
* the system will loop through all the Updater classes defined in this
* registry in weight order and let each class respond to the task and
* decide if each Updater wants to handle the task. In general, this
* doesn't matter, but if you need to override an existing Updater, make
* sure your Updater has a lighter weight so that it comes first.
*
* @see drupal_get_updaters()
* @see hook_updater_info_alter()
*/
function hook_updater_info() {
return array(
'module' => array(
'class' => 'ModuleUpdater',
'name' => t('Update modules'),
'weight' => 0,
),
'theme' => array(
'class' => 'ThemeUpdater',
'name' => t('Update themes'),
'weight' => 0,
),
);
}
/**
* Alter the Updater information array.
*
* An Updater is a class that knows how to update various parts of the Drupal
* file system, for example to update modules that have newer releases, or to
* install a new theme.
*
* @param array $updaters
* Associative array of updaters as defined through hook_updater_info().
* Alter this array directly.
*
* @see drupal_get_updaters()
* @see hook_updater_info()
*/
function hook_updater_info_alter(&$updaters) {
// Adjust weight so that the theme Updater gets a chance to handle a given
// update task before module updaters.
$updaters['theme']['weight'] = -1;
}
/**
* Alter the default country list.
*
......
......@@ -104,6 +104,29 @@ function hook_update_status_alter(&$projects) {
}
}
/**
* Verify an archive after it has been downloaded and extracted.
*
* @param string $project
* The short name of the project that has been downloaded.
* @param string $archive_file
* The filename of the unextracted archive.
* @param string $directory
* The directory that the archive was extracted into.
*
* @return
* If there is a problem, return any non-null value. If there is no problem,
* don't return anything (null).
*
* @see update_manager_archive_verify()
*/
function hook_verify_update_archive($project, $archive_file, $directory) {
if (!file_exists($directory)) {
return TRUE;
}
// Add other checks on the archive integrity here.
}
/**
* @} End of "addtogroup hooks".
*/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment