Commit 345b122b authored by Steven Jones's avatar Steven Jones

Clean up the previous commit a little

parent 57845c74
......@@ -138,12 +138,10 @@ function hook_hosting_queues() {
* Add or change context options before a hosting task runs.
*
* This hook is invoked just before any task that has the 'provision_save' flag
* equal to TRUE. These include the 'install', 'verify' and 'import' tasks.
* equal to TRUE. These include the 'install', 'verify' and 'import' tasks.
*
* The TASK_OBJECT will be either: 'server', 'platform' or 'site'.
*
* @see hook_hosting_tasks()
*
* This gives other modules the chance to send data to the backend to be
* persisted by services there. The entire task is sent so that you have access
* to it, but you should avoid changing things outside of the
......@@ -166,6 +164,7 @@ function hook_hosting_queues() {
*
* @see drush_hosting_task()
* @see hook_drush_context_import()
* @see hook_hosting_tasks()
*/
function hook_hosting_TASK_OBJECT_context_options(&$task) {
// From hosting_hosting_platform_context_options().
......
......@@ -269,7 +269,7 @@ function hosting_site_hosting_tasks() {
'description' => t('Import an existing site into Aegir'),
'hidden' => TRUE,
'provision_save' => TRUE,
);
);
return $tasks;
}
......
......@@ -28,13 +28,12 @@
* task will still be available for execution by the front-end however.
* - 'access callback' (optional) An access callback to determine if the user
* can access the task, defaults to 'hosting_task_menu_access'.
* - 'provision_save' (optional, defaults to FALSE) A mostly internal flag
* that tells provision that a "provision-save" call needs to happen before
* this task can be run, for tasks like Verify, Install, and Migrate.
* If you implement this option, you should implement
* hook_hosting_TASK_OBJECT_context_options() in order to pass parameters to
* the provision-save command. See hosting_hosting_site_context_options() for
* an example of how a site context is saved
* - 'provision_save' (optional, defaults to FALSE) A flag that tells
* provision that a "provision-save" command needs to happen before this
* task can be run, used for tasks like Verify, Install, and Import.
* If you implement this option, you should implement
* hook_hosting_TASK_OBJECT_context_options() in order to pass parameters
* to the provision-save command.
*
* @see hosting_available_tasks()
*/
......
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