Projet

Général

Profil

Paste
Télécharger (1,75 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / ctools / page_manager / help / api-task.html @ 6e3ce7c2

1
task definition:
2
  title -- visible title of the task.
3
  description -- description of the task.
4
  hook menu -- function to delegate from hook_menu. Params: &$items, $task
5
  hook menu alter -- function to delegate from hook_menu_alter. Params: &$items, $task
6
  hook theme -- function to delegate from hook_theme. Params: &$items, $task
7

    
8
  admin name -- if set an admin menu will appear in the delegator UI
9
  admin description -- to describe the admin menu
10
  
11
  admin access callback -- if set, the callback to use to determine administrative 
12
    access to this task. Defaults to user_access. Note that this is required even
13
    if delegator isn't handling administration, since this gets used to on handler
14
    edit forms.
15
  admin access arguments -- If set, the arguments to use to determine administrative 
16
    access to this task. Defaults to array('administer delegator');  
17

    
18
  type -- The type of the task, used to determine which handlers can service it.
19

    
20
  subtasks -- can be TRUE in which case it supports subtasks with the default
21
    configuration or a string (array?) with callbacks to fetch subtask data.
22
  subtask callback -- A callback which returns just one subtask. Param: $task, $subtask_id
23
  subtasks callback -- A callback which returns an array of all subtasks. 
24
    This MUST return an array, even if it's empty.Param: $task
25

    
26
  default handlers -- If the task contains any default handlers, they can be included here.
27

    
28
task names must not contain a - as that is used to separate the task name from the subtask ID.
29

    
30
subtasks implement data very similar to their parent task. In particular, they
31
implement the following items exactly like their task:
32
  hook menu
33
  hook menu alter
34
  description
35
  admin name
36
  admin description
37
  admin access callback
38
  admin access arguments