diff options
Diffstat (limited to 'sites/all/modules/ctools/help/context-arguments.html')
| -rw-r--r-- | sites/all/modules/ctools/help/context-arguments.html | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/sites/all/modules/ctools/help/context-arguments.html b/sites/all/modules/ctools/help/context-arguments.html new file mode 100644 index 000000000..5c479ae65 --- /dev/null +++ b/sites/all/modules/ctools/help/context-arguments.html @@ -0,0 +1,14 @@ +<p>Arguments create a context from external input, which is assumed to be a string as though it came from a URL element.</p> + +<pre>'title' => title + 'description' => Description + 'keyword' => Default keyword for the context + 'context' => Callback to create the context. Params: $arg = NULL, $conf = NULL, $empty = FALSE + 'default' => either an array of default settings or a string which is a callback or null to not use. + 'settings form' => params: $form, $form_state, $conf -- gets the whole form. Should put anything it wants to keep automatically in $form['settings'] + 'settings form validate' => params: $form, $form_state + 'settings form submit' => params: $form, $form_state + '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. + + submit + validate + 'criteria select' => returns true if the selected criteria matches the context. params: $context, $conf +</pre> |