context-arguments.html 1.1 KB

1234567891011121314
  1. <p>Arguments create a context from external input, which is assumed to be a string as though it came from a URL element.</p>
  2. <pre>'title' => title
  3. 'description' => Description
  4. 'keyword' => Default keyword for the context
  5. 'context' => Callback to create the context. Params: $arg = NULL, $conf = NULL, $empty = FALSE
  6. 'default' => either an array of default settings or a string which is a callback or null to not use.
  7. 'settings form' => params: $form, $form_state, $conf -- gets the whole form. Should put anything it wants to keep automatically in $form['settings']
  8. 'settings form validate' => params: $form, $form_state
  9. 'settings form submit' => params: $form, $form_state
  10. '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.
  11. + submit + validate
  12. 'criteria select' => returns true if the selected criteria matches the context. params: $context, $conf
  13. </pre>