[Summary view] [Print] [Text view]

   1  <!-- $Id: api-task.html,v 1.1 2009/07/09 00:07:04 merlinofchaos Exp $ -->
   2  task definition:
   3    title -- visible title of the task.
   4    description -- description of the task.
   5    hook menu -- function to delegate from hook_menu. Params: &$items, $task
   6    hook menu alter -- function to delegate from hook_menu_alter. Params: &$items, $task
   7    hook theme -- function to delegate from hook_theme. Params: &$items, $task
   8  
   9    admin name -- if set an admin menu will appear in the delegator UI
  10    admin description -- to describe the admin menu
  11    
  12    admin access callback -- if set, the callback to use to determine administrative 
  13      access to this task. Defaults to user_access. Note that this is required even
  14      if delegator isn't handling administration, since this gets used to on handler
  15      edit forms.
  16    admin access arguments -- If set, the arguments to use to determine administrative 
  17      access to this task. Defaults to array('administer delegator');  
  18  
  19    type -- The type of the task, used to determine which handlers can service it.
  20  
  21    subtasks -- can be TRUE in which case it supports subtasks with the default
  22      configuration or a string (array?) with callbacks to fetch subtask data.
  23    subtask callback -- A callback which returns just one subtask. Param: $task, $subtask_id
  24    subtasks callback -- A callback which returns an array of all subtasks. 
  25      This MUST return an array, even if it's empty.Param: $task
  26  
  27    default handlers -- If the task contains any default handlers, they can be included here.
  28  
  29  task names must not contain a - as that is used to separate the task name from the subtask ID.
  30  
  31  subtasks implement data very similar to their parent task. In particular, they
  32  implement the following items exactly like their task:
  33    hook menu
  34    hook menu alter
  35    description
  36    admin name
  37    admin description
  38    admin access callback
  39    admin access arguments