/[drupal]/contributions/modules/signit/README_API.txt
ViewVC logotype

Diff of /contributions/modules/signit/README_API.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.1.2.3, Tue Oct 16 16:05:24 2007 UTC revision 1.1.2.4, Fri Jan 4 15:41:51 2008 UTC
# Line 1  Line 1 
1  ; $Id: README_API.txt,v 1.1.2.2 2007/10/11 22:22:36 arthuregg Exp $  ; $Id: README_API.txt,v 1.1.2.3 2007/10/16 16:05:24 arthuregg Exp $
2    
3  This covers some aspects of SignIt's Hooks  This covers some aspects of SignIt's Hooks
4    
# Line 14  This is used to modifiy how data is coll Line 14  This is used to modifiy how data is coll
14            Shown when signatures are being collected, probably matches 'create'            Shown when signatures are being collected, probably matches 'create'
15    
16     'save' $form_values, $signit config array     'save' $form_values, $signit config array
17            Used to store additional data, can return additional data for the $data option       Used to store additional data, can return additional data for the $data option.
18         This can also be used to fire actions when a signit is signed
19    
20     'view'     'view'
21            Shows on the petition signature display. Return an array(array('#title'=> $title, '#value' => $value))            Shows on the petition signature display. Return an array(array('#title'=> $title, '#value' => $value))
# Line 33  $op = Line 34  $op =
34    'create' Shown on the node edit page (create & edit) returns a form    'create' Shown on the node edit page (create & edit) returns a form
35    
36    'send' Called when SignIt wants to send something    'send' Called when SignIt wants to send something
37    
38    
39    ------------------------------------------
40    hook_signit_sign($op, $data, $config)
41    This is called when a SignIt is signed by a user
42    
43    $op =
44      'validate'
45          Called to validate signature data. form_set_error() if false, else do nothing
46    
47      'sign' Called when signature is being saved
48          Called to perform actions when a SignIt is signed. Modules are responsible for saving their data an other actions that take place.
49    
Legend:
Removed from v.1.1.2.3  
changed lines
  Added in v.1.1.2.4
  ViewVC Help
Powered by ViewVC 1.1.2