[Summary view] [Print] [Text view]

   1  <!-- $Id: api-task-handler.html,v 1.1 2009/07/09 00:07:04 merlinofchaos Exp $ -->
   2  task handler definition:
   3    title -- visible title of the task handler.
   4    description -- description of the task handler.
   5    task type -- The type of the task this handler can service.
   6    render -- callback of the function to render the handler. The arguments to this callback are specific to the task type.
   7    admin title -- callback to render the admin title as this handler is listed.
   8      params: $handler, $task, $subtask_id
   9    admin summary -- callback to render what's in the collapsible info as the handler is listed. Optional.
  10      params: $handler, $task, $subtask_id
  11    default conf -- either an array() of default conf data or a callback that returns an array.
  12      params: $handler, $task, $subtask_id
  13    save -- callback to call just prior to the task handler being saved so it can adjust its data.
  14      params: &$handler, $update (as drupal_write_record would receive)
  15    export -- callback to call just prior to the task being exported. It should return text to append to the export if necessary. 
  16      params: &$handler, $indent
  17  
  18    forms => array(
  19      'id' => array(
  20         'form' => form callback (receives $form, $form_state)
  21         'submit' => submit callback
  22         'validate' => validate callback
  23         'include' => an optional file to include to get functionality for this form. Must include full path.
  24         'no return' => hide the 'return' button, meaning that the form requires extra steps if submitted
  25         'alternate next' => an alternate next form. Used for hidden edit forms that don't have tabs.
  26         'no blocks' => if TRUE, use Drupal's mechanism to not render blocks for this form.
  27       )
  28     )
  29    ),
  30  
  31   'add forms' => array(
  32    'form1', => t('form title'),
  33    'form2', => t('form title'),
  34    // ...etc.../
  35  ),
  36   'edit forms' => array(
  37     'id' => t('tab name'),
  38     'id2' => t('tab name'),
  39   ),
  40  
  41   If a form name is blank it is a 'hidden' form -- it has no tab but can still be reached.
  42  
  43  
  44  Notes: Because #required validation cannot be skipped when clicking cancel, please don't use it.