diff options
author | David Rothstein <drothstein@gmail.com> | 2015-10-14 15:37:30 -0400 |
---|---|---|
committer | David Rothstein <drothstein@gmail.com> | 2015-10-14 15:37:30 -0400 |
commit | 6df765676a35f8f7ed471ef29394d44233f6d61f (patch) | |
tree | b3d74bec1f4415bc5f0041445b45a90d7d94cb21 /modules/update | |
parent | 7933ac459dd752a07896aa7f8b8073020df7e0fc (diff) | |
download | brdo-6df765676a35f8f7ed471ef29394d44233f6d61f.tar.gz brdo-6df765676a35f8f7ed471ef29394d44233f6d61f.tar.bz2 |
Issue #2195183 by cleaver, zopa, elgordogrande, sandykadam, jhodgdon, joachim, Eda: document Batch API callbacks as callback implementations
Diffstat (limited to 'modules/update')
-rw-r--r-- | modules/update/update.authorize.inc | 12 | ||||
-rw-r--r-- | modules/update/update.fetch.inc | 8 | ||||
-rw-r--r-- | modules/update/update.manager.inc | 6 |
3 files changed, 20 insertions, 6 deletions
diff --git a/modules/update/update.authorize.inc b/modules/update/update.authorize.inc index 6ddd2c53a..03d370494 100644 --- a/modules/update/update.authorize.inc +++ b/modules/update/update.authorize.inc @@ -97,7 +97,9 @@ function update_authorize_run_install($filetransfer, $project, $updater_name, $l } /** - * Batch callback: Copies project to its proper place when authorized to do so. + * Implements callback_batch_operation(). + * + * Copies project to its proper place when authorized to do so. * * @param string $project * The canonical short name of the project being installed. @@ -168,7 +170,9 @@ function update_authorize_batch_copy_project($project, $updater_name, $local_url } /** - * Batch callback: Performs actions when the authorized update batch is done. + * Implements callback_batch_finished(). + * + * Performs actions when the authorized update batch is done. * * This processes the results and stashes them into SESSION such that * authorize.php will render a report. Also responsible for putting the site @@ -235,7 +239,9 @@ function update_authorize_update_batch_finished($success, $results) { } /** - * Batch callback: Performs actions when the authorized install batch is done. + * Implements callback_batch_finished(). + * + * Performs actions when the authorized install batch is done. * * This processes the results and stashes them into SESSION such that * authorize.php will render a report. Also responsible for putting the site diff --git a/modules/update/update.fetch.inc b/modules/update/update.fetch.inc index 9dd2f0ba4..428cace6b 100644 --- a/modules/update/update.fetch.inc +++ b/modules/update/update.fetch.inc @@ -29,7 +29,9 @@ function update_manual_status() { } /** - * Batch callback: Processes a step in batch for fetching available update data. + * Implements callback_batch_operation(). + * + * Processes a step in batch for fetching available update data. * * @param $context * Reference to an array used for Batch API storage. @@ -77,7 +79,9 @@ function update_fetch_data_batch(&$context) { } /** - * Batch callback: Performs actions when all fetch tasks have been completed. + * Implements callback_batch_finished(). + * + * Performs actions when all fetch tasks have been completed. * * @param $success * TRUE if the batch operation was successful; FALSE if there were errors. diff --git a/modules/update/update.manager.inc b/modules/update/update.manager.inc index 85b587de2..0b33a5f72 100644 --- a/modules/update/update.manager.inc +++ b/modules/update/update.manager.inc @@ -335,6 +335,8 @@ function update_manager_update_form_submit($form, &$form_state) { } /** + * Implements callback_batch_finished(). + * * Batch callback: Performs actions when the download batch is completed. * * @param $success @@ -847,7 +849,9 @@ function update_manager_file_get($url) { } /** - * Batch callback: Downloads, unpacks, and verifies a project. + * Implements callback_batch_operation(). + * + * Downloads, unpacks, and verifies a project. * * This function assumes that the provided URL points to a file archive of some * sort. The URL can have any scheme that we have a file stream wrapper to |