From 66ba65ba15e56df725a3fb35330e5ff87f93308c Mon Sep 17 00:00:00 2001 From: Mark Pavlitski Date: Thu, 2 May 2013 20:27:46 +0100 Subject: [PATCH] Issue #1984190 by markpavlitski: Reformatted hook_install_tasks() documentation. --- core/modules/system/system.api.php | 84 +++++++++++++++++------------------- 1 file changed, 39 insertions(+), 45 deletions(-) diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php index 9d6922c..7b95cb5 100644 --- a/core/modules/system/system.api.php +++ b/core/modules/system/system.api.php @@ -2901,59 +2901,53 @@ function hook_disable() { * @param array $install_state * An array of information about the current installation state. * - * @return + * @return array * A keyed array of tasks the profile will perform during the final stage of * the installation. Each key represents the name of a function (usually a * function defined by this profile, although that is not strictly required) * that is called when that task is run. The values are associative arrays * containing the following key-value pairs (all of which are optional): - * - 'display_name' - * The human-readable name of the task. This will be displayed to the - * user while the installer is running, along with a list of other tasks - * that are being run. Leave this unset to prevent the task from - * appearing in the list. - * - 'display' - * This is a boolean which can be used to provide finer-grained control - * over whether or not the task will display. This is mostly useful for - * tasks that are intended to display only under certain conditions; for - * these tasks, you can set 'display_name' to the name that you want to - * display, but then use this boolean to hide the task only when certain - * conditions apply. - * - 'type' - * A string representing the type of task. This parameter has three + * - display_name: The human-readable name of the task. This will be + * displayed to the user while the installer is running, along with a + * list of other tasks that are being run. Leave this unset to prevent + * the task from appearing in the list. + * - display: This is a boolean which can be used to provide finer-grained + * control over whether or not the task will display. This is mostly + * useful for tasks that are intended to display only under certain + * conditions; for these tasks, you can set 'display_name' to the name + * that you want to display, but then use this boolean to hide the task + * only when certain conditions apply. + * - type: A string representing the type of task. This parameter has three * possible values: - * - 'normal': This indicates that the task will be treated as a regular - * callback function, which does its processing and optionally returns - * HTML output. This is the default behavior which is used when 'type' is - * not set. - * - 'batch': This indicates that the task function will return a batch - * API definition suitable for batch_set(). The installer will then take - * care of automatically running the task via batch processing. - * - 'form': This indicates that the task function will return a standard - * form API definition (and separately define validation and submit - * handlers, as appropriate). The installer will then take care of - * automatically directing the user through the form submission process. - * - 'run' - * A constant representing the manner in which the task will be run. This - * parameter has three possible values: - * - INSTALL_TASK_RUN_IF_NOT_COMPLETED: This indicates that the task will - * run once during the installation of the profile. This is the default - * behavior which is used when 'run' is not set. + * - normal: (default) This indicates that the task will be treated as a + * regular callback function, which does its processing and optionally + * returns HTML output. + * - batch: This indicates that the task function will return a batch + * API definition suitable for batch_set(). The installer will then + * take care of automatically running the task via batch processing. + * - form: This indicates that the task function will return a standard + * form API definition (and separately define validation and submit + * handlers, as appropriate). The installer will then take care of + * automatically directing the user through the form submission + * process. + * - run: A constant representing the manner in which the task will be run. + * This parameter has three possible values: + * - INSTALL_TASK_RUN_IF_NOT_COMPLETED: (default) This indicates that the + * task will run once during the installation of the profile. * - INSTALL_TASK_SKIP: This indicates that the task will not run during - * the current installation page request. It can be used to skip running - * an installation task when certain conditions are met, even though the - * task may still show on the list of installation tasks presented to the - * user. + * the current installation page request. It can be used to skip + * running an installation task when certain conditions are met, even + * though the task may still show on the list of installation tasks + * presented to the user. * - INSTALL_TASK_RUN_IF_REACHED: This indicates that the task will run - * on each installation page request that reaches it. This is rarely - * necessary for an installation profile to use; it is primarily used by - * the Drupal installer for bootstrap-related tasks. - * - 'function' - * Normally this does not need to be set, but it can be used to force the - * installer to call a different function when the task is run (rather - * than the function whose name is given by the array key). This could be - * used, for example, to allow the same function to be called by two - * different tasks. + * on each installation page request that reaches it. This is rarely + * necessary for an installation profile to use; it is primarily used + * by the Drupal installer for bootstrap-related tasks. + * - function: Normally this does not need to be set, but it can be used to + * force the installer to call a different function when the task is run + * (rather than the function whose name is given by the array key). This + * could be used, for example, to allow the same function to be called by + * two different tasks. * * @see install_state_defaults() * @see batch_set() -- 1.7.10.4