function actions_save

actions_save($function, $type, $params, $label, $aid = NULL)

Saves an action and its user-supplied parameter values to the database.

Parameters

$function: The name of the function to be called when this action is performed.

$type: The type of action, to describe grouping and/or context, e.g., 'node', 'user', 'comment', or 'system'.

$params: An associative array with parameter names as keys and parameter values as values.

$label: A user-supplied label of this particular action, e.g., 'Send e-mail to Jim'.

$aid: The ID of this action. If omitted, a new action is created.

Return value

The ID of the action.

File

includes/actions.inc, line 343

This is the actions engine for executing stored actions.

Code

function actions_save($function, $type, $params, $label, $aid = NULL) {
  // aid is the callback for singleton actions so we need to keep a separate
  // table for numeric aids.
  if (!$aid) {
    $aid = db_next_id();
  }

  db_merge('actions')
    ->key(array('aid' => $aid))
    ->fields(array(
      'callback' => $function,
      'type' => $type,
      'parameters' => serialize($params),
      'label' => $label,
    ))
    ->execute();

  watchdog('actions', 'Action %action saved.', array('%action' => $label));
  return $aid;
}