* @link http://www.phpfour.com
*/
abstract class PaymentGateway
{
/**
* Holds the last error encountered
*
* @var string
*/
public $lastError;
/**
* Do we need to log IPN results ?
*
* @var boolean
*/
public $logIpn;
/**
* File to log IPN results
*
* @var string
*/
public $ipnLogFile;
/**
* Payment gateway IPN response
*
* @var string
*/
public $ipnResponse;
/**
* Are we in test mode ?
*
* @var boolean
*/
public $testMode;
/**
* Field array to submit to gateway
*
* @var array
*/
public $fields = array();
/**
* IPN post values as array
*
* @var array
*/
public $ipnData = array();
/**
* Payment gateway URL
*
* @var string
*/
public $gatewayUrl;
/**
* Initialization constructor
*
* @param none
* @return void
*/
public function __construct()
{
// Some default values of the class
$this->lastError = '';
$this->logIpn = TRUE;
$this->ipnResponse = '';
$this->testMode = FALSE;
}
/**
* Adds a key=>value pair to the fields array
*
* @param string key of field
* @param string value of field
* @return
*/
public function addField($field, $value)
{
$this->fields["$field"] = $value;
}
/**
* Submit Payment Request
*
* Generates a form with hidden elements from the fields array
* and submits it to the payment gateway URL. The user is presented
* a redirecting message along with a button to click.
*
* @param none
* @return void
*/
public function submitPayment()
{
$this->prepareSubmit();
echo "\n";
echo "Processing Payment...\n";
echo "\n";
echo "Please wait, your order is being processed and you";
echo " will be redirected to the payment website.
\n";
echo "\n";
echo "\n";
}
/**
* Perform any pre-posting actions
*
* @param none
* @return none
*/
protected function prepareSubmit()
{
// Fill if needed
}
/**
* Enables the test mode
*
* @param none
* @return none
*/
abstract protected function enableTestMode();
/**
* Validate the IPN notification
*
* @param none
* @return boolean
*/
abstract protected function validateIpn();
/**
* Logs the IPN results
*
* @param boolean IPN result
* @return void
*/
public function logResults($success)
{
if (!$this->logIpn) return;
// Timestamp
$text = '[' . date('m/d/Y g:i A').'] - ';
// Success or failure being logged?
$text .= ($success) ? "SUCCESS!\n" : 'FAIL: ' . $this->lastError . "\n";
// Log the POST variables
$text .= "IPN POST Vars from gateway:\n";
foreach ($this->ipnData as $key=>$value)
{
$text .= "$key=$value, ";
}
// Log the response from the paypal server
$text .= "\nIPN Response from gateway Server:\n " . $this->ipnResponse;
// Write to log
$fp = fopen($this->ipnLogFile,'a');
fwrite($fp, $text . "\n\n");
fclose($fp);
}
}