revisioning_triggers_actions.inc in Revisioning 6.3

Triggers and actions supported by the revisioning module.

File

revisioning_triggers_actions.inc

<?php

/**
 * @file
 *  Triggers and actions supported by the revisioning module.
 */

/**
 * Implementation of hook_hook_info().
 * Defines triggers available in this module.
 */
function revisioning_hook_info() {
  return array(
    // First key is name of tab on admin/build/trigger page that triggers appear on
    'revisioning' => array(
      'revisioning' => array(
        // trigger name must equal module name
        // List of trigger operations
        'publish' => array(
          'runs when' => t('When publishing a pending revision'),
        ),
        'revert' => array(
          'runs when' => t('When reverting to an archived revision'),
        ),
        'unpublish' => array(
          'runs when' => t('When unpublishing the current revision'),
        ),
      ),
    ),
  );
}

/**
 * Implementation of hook_<trigger_name>().
 *
 * Note the confusing name -- this due to fact that trigger name needs to equal
 * the module name.
 * @see revisioning_hook_info()
 *
 * @param $op
 *  trigger operation name, e.g 'publish', 'unpublish', 'revert' as passed in
 *  from revisioning_revisionapi()
 * @param $object
 *  typically the node object as passed in from revisioning_revisionapi();
 *  if omitted this function will try to load the node object based on the URL
 */
function revisioning_revisioning($op, $object = NULL, $args = NULL) {
  if (!module_exists('trigger')) {
    return;
  }
  $aids = _trigger_get_hook_aids('revisioning', $op);
  if (empty($aids)) {

    // no actions defined for this trigger
    return;
  }
  watchdog('revisioning', '%op trigger is actioning "@aids"', array(
    '%op' => $op,
    '@aids' => implode(', ', array_keys($aids)),
  ));
  global $user;
  $context = array(
    'hook' => 'revisioning',
    'op' => $op,
    'user' => $user,
  );
  foreach ($aids as $aid => $action_info) {
    if ($action_info['type'] == 'node') {
      $object = NULL;

      // @todo: sort out why we need this line i.e. enforce reload
      $nid = arg(1);
      if (!$object && !$node && arg(0) == 'node' && is_numeric($nid)) {

        // Clear the static node_load() cache to ensure we are passing the
        // updated object to the node actions.
        $node = node_load($nid, NULL, TRUE);
      }
      $obj = $object ? $object : $node;
    }
    else {

      // assume user object
      $obj = $object ? $object : $user;
    }

    // Include node in context so we can use node-related tokens in the action [#1035354]
    if (is_object($object) && $object->nid) {
      $context['node'] = $object;
    }
    actions_do($aid, $obj, $context, $args);
  }
}

/**
 * Implementation of hook_action_info().
 * Defines actions available in this module.
 */
function revisioning_action_info() {
  return array(
    'revisioning_delete_archived_action' => array(
      'type' => 'node',
      'description' => t('Delete archived revisions of the node'),
      'configurable' => FALSE,
      'hooks' => array(
        'nodeapi' => array(
          'update',
        ),
      ),
    ),
    'revisioning_create_pending_revision_action' => array(
      'description' => t('Create a new pending revision of a node'),
      'type' => 'node',
      'configurable' => FALSE,
      'hooks' => array(
        'nodeapi' => array(
          'presave',
        ),
      ),
    ),
    'revisioning_publish_latest_revision_action' => array(
      'type' => 'node',
      'description' => t('Publish the most recent pending revision'),
      'configurable' => FALSE,
      'hooks' => array(
        'nodeapi' => array(
          'presave',
        ),
      ),
    ),
  );
}

/**
 * Implementation of delete archived action.
 */
function revisioning_delete_archived_action(&$node, $context = array()) {
  if (empty($node->revision_moderation)) {

    // return;
  }
  $num_archived = revisioning_get_number_of_archived_revisions($node);
  if ($num_archived > 0) {
    $type = node_get_types('name', $node->type);
    watchdog('revisioning', 'Executing deleting archived revisions action for @type %title', array(
      '@type' => $type,
      '%title' => $node->title,
    ), WATCHDOG_NOTICE, l(t('view'), "node/{$node->nid}"));
    if (revisioning_delete_archived_revisions($node)) {
      drupal_set_message(format_plural($num_archived, '@type %title: one archived revision deleted.', '@type %title: @count archived revisions deleted.', array(
        '@type' => $type,
        '%title' => $node->title,
      )));
    }
  }
}

/**
 * Implementation of create_pending_revision_action.
 */
function revisioning_create_pending_revision_action(&$node, $context = array()) {
  if ($node->is_new || empty($node->nid)) {
    return;
  }
  $type = node_get_types('name', $node->type);
  watchdog('revisioning', 'Executing create_pending_revision_action for @type %title', array(
    '@type' => $type,
    '%title' => $node->title,
  ), WATCHDOG_NOTICE, l(t('view'), "node/{$node->nid}"));

  // Create a new revision upon saving and subject it to moderation (pending)
  $node->revision = TRUE;
  $node->revision_moderation = TRUE;
}

/**
 * Implementation of publish_latest_revision action
 */
function revisioning_publish_latest_revision_action(&$node, $context = array()) {
  $type = node_get_types('name', $node->type);
  watchdog('revisioning', 'Executing publish_latest_revision action for @type %title', array(
    '@type' => $type,
    '%title' => $node->title,
  ), WATCHDOG_NOTICE, l(t('view'), "node/{$node->nid}"));
  if (_revisioning_publish_latest_revision($node)) {
    drupal_set_message(t('Revision has been published.'));
  }
  else {
    drupal_set_message(t('"!title" has no pending revision to be published.', array(
      '!title' => check_plain($node->title),
    )), 'warning');
  }
}

Functions

Name	Description
revisioning_action_info	Implementation of hook_action_info(). Defines actions available in this module.
revisioning_create_pending_revision_action	Implementation of create_pending_revision_action.
revisioning_delete_archived_action	Implementation of delete archived action.
revisioning_hook_info	Implementation of hook_hook_info(). Defines triggers available in this module.
revisioning_publish_latest_revision_action	Implementation of publish_latest_revision action
revisioning_revisioning	Implementation of hook_<trigger_name>().