function pay_method::valid_action in Pay 6

Same name and namespace in other branches

1. 7 includes/handlers/pay_method.inc \pay_method::valid_action()

Determine whether an action is valid and appropraite for a transaction.

Parameters

$name: The name of the action, e.g. 'complete' , 'cancel', etc.

$transaction: The transaction that the suggested action will apply to.

$history: A history of all pay_activity entries that have already been handled by this payment method on this transaction. For example, an 'authorize' activity would allow us to initiate a 'capture' action.

File

includes/handlers/pay_method.inc, line 59

The base class for payment activities. All payment method classes should extend this class.

Class

pay_method

@file The base class for payment activities. All payment method classes should extend this class.

Code

function valid_action($action, $transaction, $history) {

  // Subclasses can implement this method in order to qualify its result.
  return TRUE;
}