pay.trigger.inc in Pay 6

Implements hooks that are pertinent to the trigger module.

File

includes/pay.trigger.inc

<?php

// $Id$

/**
 * @file
 * Implements hooks that are pertinent to the trigger module.
 */

/**
 * Implementation of hook_hook_info().
 */
function pay_hook_info() {
  $hooks = array(
    'pay' => array(
      'pay' => array(),
    ),
  );
  foreach (pay_handlers('pay_form') as $name => $info) {
    $replace = array(
      '@type' => $info['title'],
    );
    $hooks['pay']['pay'][$name . '_transaction_create'] = array(
      'runs when' => t('@type: A new payment transaction is created but no payment activites have been attempted', $replace),
    );
    $hooks['pay']['pay'][$name . '_activity_create'] = array(
      'runs when' => t('@type: A payment activity has occurred, but the transaction is not yet complete', $replace),
    );
    $hooks['pay']['pay'][$name . '_transaction_complete'] = array(
      'runs when' => t('@type: A payment transaction has been completed', $replace),
    );
    $hooks['pay']['pay'][$name . '_goal'] = array(
      'runs when' => t('@type: The form has a goal amount and that goal has been reached', $replace),
    );
  }
  return $hooks;
}

/**
 * Implementation of hook_pay_transaction_create().
 */
function pay_pay_transaction_create(&$transaction) {
  $pay_form = $transaction
    ->pay_form();
  pay_actions_do($pay_form
    ->handler() . '_transaction_create', $transaction);
}

/**
 * Implementation of hook_pay_activity_create().
 */
function pay_pay_activity_create(&$activity) {

  // To respond by form, we must get the pfid of the transaction and then load
  $transaction = $activity
    ->pay_transaction();
  $pay_form = $transaction
    ->pay_form();
  pay_actions_do($pay_form
    ->handler() . '_activity_create', $transaction);
}

/**
 * Implementation of hook_pay_transaction_complete().
 */
function pay_pay_transaction_complete(&$transaction) {
  $pay_form = $transaction
    ->pay_form();
  pay_actions_do($pay_form
    ->handler() . '_transaction_complete', $transaction);
}

/**
 * Helper function to call 'actions_do'
 */
function pay_actions_do($hook, &$object) {
  if (module_exists('trigger')) {
    $context = array();
    foreach (_trigger_get_hook_aids('pay', $hook) as $aid => $action_info) {
      if ($aid) {
        actions_do($aid, $object, $context);
      }
    }
  }
}

Functions

Name	Description
pay_actions_do	Helper function to call 'actions_do'
pay_hook_info	Implementation of hook_hook_info().
pay_pay_activity_create	Implementation of hook_pay_activity_create().
pay_pay_transaction_complete	Implementation of hook_pay_transaction_complete().
pay_pay_transaction_create	Implementation of hook_pay_transaction_create().