Drupal 7 Module Development

Chapter 12
• display_name: A human readable name to display for this task. This is used
in the user interface to inform a user as to the step they are on.
• display: tells the installer whether or not to display the task. This is used to
provide fine-grained control over the display of the task in the installer. It is
useful for tasks that may display only under certain conditions. The value is a
Boolean and the default value is whether or not the "display_name" key is set.
• type: Specifies the type of task to be run. There are three types of tasks the
installer can execute. The normal type of task will execute a callback function
and optionally return some html. The form type brings up a form using the
Form API. The batch type will return a Batch API definition.
• run: Tells the installer when to run the task. The default setting is
INSTALL_TASK_RUN_IF_NOT_COMPLETED, which tells the installer to run
the task once in the install process when reached in the list of install tasks.
Alternately, INSTALL_TASK_RUN_IF_REACHED tells the installer to run
the task on every page load if the task is reached in the list of tasks and
INSTALL_TASK_SKIP tells the installer to skip the task.
• function: An optional parameter to set a callback function other than the
key name. This is useful if you want to call the same callback function on
more than one step.
Creating a task
Let's create two tasks for the store profile. The tasks will create two content types
and fill in default settings for our site-wide contact form.
We start by defining the task to create the two content types. This will be done in
store_install_tasks(), the profiles implementation of hook_install_tasks()
which goes in store.profile:
/**
* Implements hook_install_tasks().
*/
function store_install_tasks() {
$tasks = array();
$tasks['store_create_content_types'] = array(
'type' => 'normal',
);
return $tasks;
}
[ 349 ]