[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/ctools/includes/ -> context-task-handler.inc (summary)

(no description)

File Size: 436 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 16 functions

  ctools_context_handler_render()
  ctools_context_handler_pre_render()
  ctools_context_handler_select()
  ctools_context_handler_summary()
  ctools_context_handler_get_task_contexts()
  ctools_context_handler_get_handler_contexts()
  ctools_context_handler_get_all_contexts()
  ctools_context_handler_get_handler_object()
  ctools_context_handler_get_task_object()
  ctools_context_handler_get_base_contexts()
  ctools_context_handler_get_task_arguments()
  ctools_context_handler_set_access_restrictions()
  ctools_context_handler_edit_criteria()
  ctools_context_handler_edit_criteria_submit()
  ctools_context_handler_edit_context()
  ctools_context_handler_edit_context_submit()

Functions
Functions that are not part of a class:

ctools_context_handler_render($task, $subtask, $contexts, $args, $page = TRUE)   X-Ref
Render a context type task handler given a list of handlers
attached to a type.

param: $task
param: $subtask
param: $contexts
param: $args
param: $page
return:

ctools_context_handler_pre_render($handler, $contexts, $args)   X-Ref
Called to execute actions that should happen before a handler is rendered.


ctools_context_handler_select($handler, $contexts)   X-Ref
Compare arguments to contexts for selection purposes.

param: $handler
param: $contexts
return:

ctools_context_handler_summary($task, $subtask, $handler)   X-Ref
Get the array of summary strings for the arguments.

These summary strings are used to communicate to the user what
arguments the task handlers are selecting.

param: $task
param: $subtask
param: $handler

ctools_context_handler_get_task_contexts($task, $subtask, $args)   X-Ref
Load the contexts for a task, using arguments.

This creates the base array of contexts, loaded from arguments, suitable
for use in rendering.

ctools_context_handler_get_handler_contexts($contexts, $handler)   X-Ref
Load the contexts for a task handler.

This expands a base set of contexts passed in from a task with the
contexts defined on the task handler. The contexts from the task
must already have been loaded.

ctools_context_handler_get_all_contexts($task, $subtask, $handler)   X-Ref
Load the contexts for a task and task handler together.

This pulls the arguments from a task and everything else from a task
handler and loads them as a group. Since there is no data, this loads
the contexts as placeholders.

ctools_context_handler_get_handler_object($handler)   X-Ref
Create an object suitable for use with the context system that kind of
expects things in a certain, kind of clunky format.


ctools_context_handler_get_task_object($task, $subtask, $handler)   X-Ref
Create an object suitable for use with the context system that kind of
expects things in a certain, kind of clunky format. This one adds in
arguments from the task.


ctools_context_handler_get_base_contexts($task, $subtask, $placeholders = FALSE)   X-Ref
Get base contexts from a task, if it has any.

Tasks can get their contexts either from base contexts or arguments; base
contexts extract their information from the environment.

ctools_context_handler_get_task_arguments($task, $subtask)   X-Ref
Get the arguments from a task that are used to load contexts.


ctools_context_handler_set_access_restrictions($task, $subtask, $handler, &$contexts)   X-Ref
Set any access restrictions on the contexts for a handler.

Both the task and the handler could add restrictions to the contexts
based upon the access control. These restrictions might be useful
to limit what kind of content appears in the add content dialog;
for example, if we have an access item that limits a node context
to only 'story' and 'page' types, there is no need for content that
only applies to the 'poll' type to appear.

ctools_context_handler_edit_criteria(&$form, &$form_state)   X-Ref
Form to choose context based selection rules for a task handler.

The configuration will be assumed to go simply in $handler->conf and
will be keyed by the argument ID.

ctools_context_handler_edit_criteria_submit(&$form, &$form_state)   X-Ref
Submit handler for rules selection


ctools_context_handler_edit_context(&$form, &$form_state)   X-Ref
Edit contexts that go with this panel.


ctools_context_handler_edit_context_submit(&$form, &$form_state)   X-Ref
Process submission of the context edit form.




Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7