[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/includes/ -> actions.inc (summary)

(no description)

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

Defines 9 functions

  actions_do()
  actions_list()
  actions_get_all_actions()
  actions_actions_map()
  actions_function_lookup()
  actions_synchronize()
  actions_save()
  actions_load()
  actions_delete()

Functions
Functions that are not part of a class:

actions_do($action_ids, &$object, $context = NULL, $a1 = NULL, $a2 = NULL)   X-Ref
Perform a given list of actions by executing their callback functions.

Given the IDs of actions to perform, find out what the callbacks
for the actions are by querying the database. Then call each callback
using the function call $function($object, $context, $a1, $a2)
where $function is the name of a function written in compliance with
the action specification; that is, foo($object, $context).

param: $action_ids
param: $object
param: $context
param: $a1
param: $a2
return:

actions_list($reset = FALSE)   X-Ref
Discover all action functions by invoking hook_action_info().

param: $reset
return:

actions_get_all_actions()   X-Ref
Retrieves all action instances from the database.

Compare with actions_list(), which gathers actions by invoking
hook_action_info(). The actions returned by this function and the actions
returned by actions_list() are partially synchronized. Non-configurable
actions from hook_action_info() implementations are put into the database
when actions_synchronize() is called, which happens when
admin/settings/actions is visited. Configurable actions are not added to
the database until they are configured in the user interface, in which case
a database row is created for each configuration of each action.

return:

actions_actions_map($actions)   X-Ref
Create an associative array keyed by md5 hashes of function names.

Hashes are used to prevent actual function names from going out into
HTML forms and coming back.

param: $actions
return:

actions_function_lookup($hash)   X-Ref
Given an md5 hash of a function name, return the function name.

Faster than actions_actions_map() when you only need the function name.

param: $hash
return:

actions_synchronize($actions_in_code = array()   X-Ref
Synchronize actions that are provided by modules.

They are synchronized with actions that are stored in the actions table.
This is necessary so that actions that do not require configuration can
receive action IDs. This is not necessarily the best approach,
but it is the most straightforward.

actions_save($function, $type, $params, $desc, $aid = NULL)   X-Ref
Save an action and its associated user-supplied parameter values to the database.

param: $function
param: $type
param: $params
param: $desc
param: $aid
return:

actions_load($aid)   X-Ref
Retrieve a single action from the database.

param: $aid
return:

actions_delete($aid)   X-Ref
Delete a single action from the database.

param: $aid



Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7