[Summary view] [Print] [Text view]

   1  <!-- $Id: context-arguments.html,v 1.3 2008/12/19 17:35:57 merlinofchaos Exp $ -->
   2  
   3  Arguments create a context from external input, which is assumed to be a
   4  string as though it came from a URL element.
   5  
   6      'title' => title
   7      'description' => Description
   8      'keyword' => Default keyword for the context
   9      'context' => Callback to create the context. Params: $arg = NULL, $conf = NULL, $empty = FALSE
  10  
  11      'default' => either an array of default settings or a string which is a callback or null to not use.
  12  
  13      'settings form' => params: $form, $form_state, $conf -- gets the whole form. Should put anything it wants to keep automatically in $form['settings']
  14      'settings form validate' => params: $form, $form_state
  15      'settings form submit' => params: $form, $form_state
  16  
  17      'criteria form' => params: $form, &$form_state, $conf, $argument, $id -- gets the whole argument. It should only put form widgets in $form[$id]. $conf may not be properly initialized so always guard against this due to arguments being changed and handlers not being updated to match.
  18      + submit + validate
  19  
  20      'criteria select' => returns true if the selected criteria matches the context. params: $context, $conf