/home/desid573/public_html/family
Edit: /home/desid573/public_html/family/eWay.php (42697B)
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Badcow\eWay;
use \ErrorException;
class eWay
{
/**
* The gateway to use.
*
* @var string
*/
protected $gateway;
/**
* The eWay customer ID.
*
* @var string
*/
protected $customerID;
/**
* Transaction amount in cents.
*
* @var int
*/
protected $paymentAmount;
/**
* The customer's first name.
*
* @var string
*/
protected $customerFirstName;
/**
* The customer's last name.
*
* @var string
*/
protected $customerLastName;
/**
* The customer's email address.
*
* @var string
*/
protected $customerEmail;
/**
* The customer's address.
*
* @var string
*/
protected $customerAddress;
/**
* The customer's postcode.
*
* @var string
*/
protected $customerPostcode;
/**
* The customer invoice description.
*
* @var string
*/
protected $customerInvoiceDescription;
/**
* The customer invoice reference.
*
* @var string
*/
protected $customerInvoiceRef;
/**
* The name on the credit card.
*
* @var string
*/
protected $cardHoldersName;
/**
* The credit card number.
*
* @var string
*/
protected $cardNumber;
/**
* The credit card card validation number (CVN).
*
* @var string
*/
protected $cvn;
/**
* The customer's IPv4 address.
*
* @var string
*/
protected $customerIP;
/**
* The customer's two character country code.
*
* @var string
*/
protected $customerCountry;
/**
* The two digit credit card expiry month.
*
* @var string
*/
protected $cardExpiryMonth;
/**
* The two digit credit card expiry year.
*
* @var string
*/
protected $cardExpiryYear;
/**
* The user-defined transaction number for the
* payment. This is returned by the gateway and
* assigned to the variable $transactionReference.
*
* @var string
*/
protected $customerTransactionReference;
/**
* eWay option 1.
*
* @var string
*/
protected $option1;
/**
* eWay option 2.
*
* @var string
*/
protected $option2;
/**
* eWay option 3.
*
* @var string
*/
protected $option3;
/**
* The eWay gateway URL.
*
* @var string
*/
protected $gatewayURL;
/**
* The response from the gateway in XML format.
*
* @var string
*/
protected $transactionResponse;
/**
* The transaction error message. This may
* also be a success message.
*
* @var string
*/
protected $transactionError;
/**
* The transaction status.
* For a successful transaction "True" is passed and
* for a failed transaction "False" is passed.
*
* @var string
*/
protected $transactionStatus;
/**
* The transaction number.
* This is a unique number assigned by eWay.
*
* @var string
*/
protected $transactionNumber;
/**
* The transaction reference returned by the gateway.
* This should be the same as $customerTransactionReference.
*
* @var string
*/
protected $transactionReference;
/**
* The transaction amount returned by the gateway.
* This will not necessarily be the same as the $paymentAmount.
*
* @var string
*/
protected $transactionAmount;
/**
* If the transaction is successful, this is the bank authorisation number.
*
* @var string
*/
protected $transactionAuthNumber;
/**
* The eWay option 1 returned by the gateway.
* This should be the same as $option1.
*
* @var string
*/
protected $transactionOption1;
/**
* The eWay option 2 returned by the gateway.
* This should be the same as $option2
*
* @var string
*/
protected $transactionOption2;
/**
* The eWay option 3 returned by the gateway.
* This should be the same as $option3
*
* @var string
*/
protected $transactionOption3;
/**
* @var string
*/
protected $transactionBeagleScore;
/**
* The two digit esponse code returned by the gateway.
*
* @var string
*/
protected $responseCode;
/**
* Response codes returned by the gateway.
* The list of codes is complete according to the
* {@link http://www.eway.com.au/Developer/payment-code/transaction-results-response-codes.aspx eWAY Payment Gateway Bank Response Codes}.
*
* @var array
*/
public static $responseCodes = array(
'00' => array('text' => 'Transaction Approved', 'approved' => TRUE),
'01' => array('text' => 'Refer to Issuer', 'approved' => FALSE),
'02' => array('text' => 'Refer to Issuer, special', 'approved' => FALSE),
'03' => array('text' => 'No Merchant', 'approved' => FALSE),
'04' => array('text' => 'Pick Up Card', 'approved' => FALSE),
'05' => array('text' => 'Do Not Honour', 'approved' => FALSE),
'06' => array('text' => 'Error', 'approved' => FALSE),
'07' => array('text' => 'Pick Up Card, Special', 'approved' => FALSE),
'08' => array('text' => 'Honour With Identification', 'approved' => TRUE),
'09' => array('text' => 'Request In Progress', 'approved' => FALSE),
'10' => array('text' => 'Approved For Partial Amount', 'approved' => TRUE),
'11' => array('text' => 'Approved, VIP', 'approved' => TRUE),
'12' => array('text' => 'Invalid Transaction', 'approved' => FALSE),
'13' => array('text' => 'Invalid Amount', 'approved' => FALSE),
'14' => array('text' => 'Invalid Card Number', 'approved' => FALSE),
'15' => array('text' => 'No Issuer', 'approved' => FALSE),
'16' => array('text' => 'Approved, Update Track 3', 'approved' => TRUE),
'19' => array('text' => 'Re-enter Last Transaction', 'approved' => FALSE),
'21' => array('text' => 'No Action Taken', 'approved' => FALSE),
'22' => array('text' => 'Suspected Malfunction', 'approved' => FALSE),
'23' => array('text' => 'Unacceptable Transaction Fee', 'approved' => FALSE),
'25' => array('text' => 'Unable to Locate Record On File', 'approved' => FALSE),
'30' => array('text' => 'Format Error', 'approved' => FALSE),
'31' => array('text' => 'Bank Not Supported By Switch', 'approved' => FALSE),
'33' => array('text' => 'Expired Card, Capture', 'approved' => FALSE),
'34' => array('text' => 'Suspected Fraud, Retain Card', 'approved' => FALSE),
'35' => array('text' => 'Card Acceptor, Contact Acquirer, Retain Card', 'approved' => FALSE),
'36' => array('text' => 'Restricted Card, Retain Card', 'approved' => FALSE),
'37' => array('text' => 'Contact Acquirer Security Department, Retain Card', 'approved' => FALSE),
'38' => array('text' => 'PIN Tries Exceeded, Capture', 'approved' => FALSE),
'39' => array('text' => 'No Credit Account', 'approved' => FALSE),
'40' => array('text' => 'Function Not Supported', 'approved' => FALSE),
'41' => array('text' => 'Lost Card', 'approved' => FALSE),
'42' => array('text' => 'No Universal Account', 'approved' => FALSE),
'43' => array('text' => 'Stolen Card', 'approved' => FALSE),
'44' => array('text' => 'No Investment Account', 'approved' => FALSE),
'51' => array('text' => 'Insufficient Funds', 'approved' => FALSE),
'52' => array('text' => 'No Cheque Account', 'approved' => FALSE),
'53' => array('text' => 'No Savings Account', 'approved' => FALSE),
'54' => array('text' => 'Expired Card', 'approved' => FALSE),
'55' => array('text' => 'Incorrect PIN', 'approved' => FALSE),
'56' => array('text' => 'No Card Record', 'approved' => FALSE),
'57' => array('text' => 'Function Not Permitted to Cardholder', 'approved' => FALSE),
'58' => array('text' => 'Function Not Permitted to Terminal', 'approved' => FALSE),
'59' => array('text' => 'Suspected Fraud', 'approved' => FALSE),
'60' => array('text' => 'Acceptor Contact Acquirer', 'approved' => FALSE),
'61' => array('text' => 'Exceeds Withdrawal Limit', 'approved' => FALSE),
'62' => array('text' => 'Restricted Card', 'approved' => FALSE),
'63' => array('text' => 'Security Violation', 'approved' => FALSE),
'64' => array('text' => 'Original Amount Incorrect', 'approved' => FALSE),
'66' => array('text' => 'Acceptor Contact Acquirer, Security', 'approved' => FALSE),
'67' => array('text' => 'Capture Card', 'approved' => FALSE),
'75' => array('text' => 'PIN Tries Exceeded', 'approved' => FALSE),
'82' => array('text' => 'CVV Validation Error', 'approved' => FALSE),
'90' => array('text' => 'Cutoff In Progress', 'approved' => FALSE),
'91' => array('text' => 'Card Issuer Unavailable', 'approved' => FALSE),
'92' => array('text' => 'Unable To Route Transaction', 'approved' => FALSE),
'93' => array('text' => 'Cannot Complete, Violation Of The Law', 'approved' => FALSE),
'94' => array('text' => 'Duplicate Transaction', 'approved' => FALSE),
'96' => array('text' => 'System Error', 'approved' => FALSE)
);
/**
* Two letter country codes and countries as defined by
* {@link http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2}.
*
* @var array
*/
public static $countryCodes = array(
'AD' => 'Andorra',
'AE' => 'United Arab Emirates',
'AF' => 'Afghanistan',
'AG' => 'Antigua and Barbuda',
'AI' => 'Anguilla',
'AL' => 'Albania',
'AM' => 'Armenia',
'AO' => 'Angola',
'AQ' => 'Antarctica',
'AR' => 'Argentina',
'AS' => 'American Samoa',
'AT' => 'Austria',
'AU' => 'Australia',
'AW' => 'Aruba',
'AX' => 'Åland Islands',
'AZ' => 'Azerbaijan',
'BA' => 'Bosnia and Herzegovina',
'BB' => 'Barbados',
'BD' => 'Bangladesh',
'BE' => 'Belgium',
'BF' => 'Burkina Faso',
'BG' => 'Bulgaria',
'BH' => 'Bahrain',
'BI' => 'Burundi',
'BJ' => 'Benin',
'BL' => 'Saint Barthélemy',
'BM' => 'Bermuda',
'BN' => 'Brunei Darussalam',
'BO' => 'Bolivia, Plurinational State of',
'BQ' => 'Bonaire, Sint Eustatius and Saba',
'BR' => 'Brazil',
'BS' => 'Bahamas',
'BT' => 'Bhutan',
'BV' => 'Bouvet Island',
'BW' => 'Botswana',
'BY' => 'Belarus',
'BZ' => 'Belize',
'CA' => 'Canada',
'CC' => 'Cocos (Keeling) Islands',
'CD' => 'Congo, the Democratic Republic of the',
'CF' => 'Central African Republic',
'CG' => 'Congo',
'CH' => 'Switzerland',
'CI' => 'Côte d\'Ivoire',
'CK' => 'Cook Islands',
'CL' => 'Chile',
'CM' => 'Cameroon',
'CN' => 'China',
'CO' => 'Colombia',
'CR' => 'Costa Rica',
'CU' => 'Cuba',
'CV' => 'Cape Verde',
'CW' => 'Curaçao',
'CX' => 'Christmas Island',
'CY' => 'Cyprus',
'CZ' => 'Czech Republic',
'DE' => 'Germany',
'DJ' => 'Djibouti',
'DK' => 'Denmark',
'DM' => 'Dominica',
'DO' => 'Dominican Republic',
'DZ' => 'Algeria',
'EC' => 'Ecuador',
'EE' => 'Estonia',
'EG' => 'Egypt',
'EH' => 'Western Sahara',
'ER' => 'Eritrea',
'ES' => 'Spain',
'ET' => 'Ethiopia',
'FI' => 'Finland',
'FJ' => 'Fiji',
'FK' => 'Falkland Islands (Malvinas)',
'FM' => 'Micronesia, Federated States of',
'FO' => 'Faroe Islands',
'FR' => 'France',
'GA' => 'Gabon',
'GB' => 'United Kingdom',
'GD' => 'Grenada',
'GE' => 'Georgia',
'GF' => 'French Guiana',
'GG' => 'Guernsey',
'GH' => 'Ghana',
'GI' => 'Gibraltar',
'GL' => 'Greenland',
'GM' => 'Gambia',
'GN' => 'Guinea',
'GP' => 'Guadeloupe',
'GQ' => 'Equatorial Guinea',
'GR' => 'Greece',
'GS' => 'South Georgia and the South Sandwich Islands',
'GT' => 'Guatemala',
'GU' => 'Guam',
'GW' => 'Guinea-Bissau',
'GY' => 'Guyana',
'HK' => 'Hong Kong',
'HM' => 'Heard Island and McDonald Islands',
'HN' => 'Honduras',
'HR' => 'Croatia',
'HT' => 'Haiti',
'HU' => 'Hungary',
'ID' => 'Indonesia',
'IE' => 'Ireland',
'IL' => 'Israel',
'IM' => 'Isle of Man',
'IN' => 'India',
'IO' => 'British Indian Ocean Territory',
'IQ' => 'Iraq',
'IR' => 'Iran, Islamic Republic of',
'IS' => 'Iceland',
'IT' => 'Italy',
'JE' => 'Jersey',
'JM' => 'Jamaica',
'JO' => 'Jordan',
'JP' => 'Japan',
'KE' => 'Kenya',
'KG' => 'Kyrgyzstan',
'KH' => 'Cambodia',
'KI' => 'Kiribati',
'KM' => 'Comoros',
'KN' => 'Saint Kitts and Nevis',
'KP' => 'Korea, Democratic People\'s Republic of',
'KR' => 'Korea, Republic of',
'KW' => 'Kuwait',
'KY' => 'Cayman Islands',
'KZ' => 'Kazakhstan',
'LA' => 'Lao People\'s Democratic Republic',
'LB' => 'Lebanon',
'LC' => 'Saint Lucia',
'LI' => 'Liechtenstein',
'LK' => 'Sri Lanka',
'LR' => 'Liberia',
'LS' => 'Lesotho',
'LT' => 'Lithuania',
'LU' => 'Luxembourg',
'LV' => 'Latvia',
'LY' => 'Libya',
'MA' => 'Morocco',
'MC' => 'Monaco',
'MD' => 'Moldova, Republic of',
'ME' => 'Montenegro',
'MF' => 'Saint Martin (French part)',
'MG' => 'Madagascar',
'MH' => 'Marshall Islands',
'MK' => 'Macedonia, the former Yugoslav Republic of',
'ML' => 'Mali',
'MM' => 'Myanmar',
'MN' => 'Mongolia',
'MO' => 'Macao',
'MP' => 'Northern Mariana Islands',
'MQ' => 'Martinique',
'MR' => 'Mauritania',
'MS' => 'Montserrat',
'MT' => 'Malta',
'MU' => 'Mauritius',
'MV' => 'Maldives',
'MW' => 'Malawi',
'MX' => 'Mexico',
'MY' => 'Malaysia',
'MZ' => 'Mozambique',
'NA' => 'Namibia',
'NC' => 'New Caledonia',
'NE' => 'Niger',
'NF' => 'Norfolk Island',
'NG' => 'Nigeria',
'NI' => 'Nicaragua',
'NL' => 'Netherlands',
'NO' => 'Norway',
'NP' => 'Nepal',
'NR' => 'Nauru',
'NU' => 'Niue',
'NZ' => 'New Zealand',
'OM' => 'Oman',
'PA' => 'Panama',
'PE' => 'Peru',
'PF' => 'French Polynesia',
'PG' => 'Papua New Guinea',
'PH' => 'Philippines',
'PK' => 'Pakistan',
'PL' => 'Poland',
'PM' => 'Saint Pierre and Miquelon',
'PN' => 'Pitcairn',
'PR' => 'Puerto Rico',
'PS' => 'Palestinian Territory, Occupied',
'PT' => 'Portugal',
'PW' => 'Palau',
'PY' => 'Paraguay',
'QA' => 'Qatar',
'RE' => 'Réunion',
'RO' => 'Romania',
'RS' => 'Serbia',
'RU' => 'Russian Federation',
'RW' => 'Rwanda',
'SA' => 'Saudi Arabia',
'SB' => 'Solomon Islands',
'SC' => 'Seychelles',
'SD' => 'Sudan',
'SE' => 'Sweden',
'SG' => 'Singapore',
'SH' => 'Saint Helena, Ascension and Tristan da Cunha',
'SI' => 'Slovenia',
'SJ' => 'Svalbard and Jan Mayen',
'SK' => 'Slovakia',
'SL' => 'Sierra Leone',
'SM' => 'San Marino',
'SN' => 'Senegal',
'SO' => 'Somalia',
'SR' => 'Suriname',
'SS' => 'South Sudan',
'ST' => 'Sao Tome and Principe',
'SV' => 'El Salvador',
'SX' => 'Sint Maarten (Dutch part)',
'SY' => 'Syrian Arab Republic',
'SZ' => 'Swaziland',
'TC' => 'Turks and Caicos Islands',
'TD' => 'Chad',
'TF' => 'French Southern Territories',
'TG' => 'Togo',
'TH' => 'Thailand',
'TJ' => 'Tajikistan',
'TK' => 'Tokelau',
'TL' => 'Timor-Leste',
'TM' => 'Turkmenistan',
'TN' => 'Tunisia',
'TO' => 'Tonga',
'TR' => 'Turkey',
'TT' => 'Trinidad and Tobago',
'TV' => 'Tuvalu',
'TW' => 'Taiwan, Province of China',
'TZ' => 'Tanzania, United Republic of',
'UA' => 'Ukraine',
'UG' => 'Uganda',
'UM' => 'United States Minor Outlying Islands',
'US' => 'United States',
'UY' => 'Uruguay',
'UZ' => 'Uzbekistan',
'VA' => 'Holy See (Vatican City State)',
'VC' => 'Saint Vincent and the Grenadines',
'VE' => 'Venezuela, Bolivarian Republic of',
'VG' => 'Virgin Islands, British',
'VI' => 'Virgin Islands, U.S.',
'VN' => 'Viet Nam',
'VU' => 'Vanuatu',
'WF' => 'Wallis and Futuna',
'WS' => 'Samoa',
'YE' => 'Yemen',
'YT' => 'Mayotte',
'ZA' => 'South Africa',
'ZM' => 'Zambia',
'ZW' => 'Zimbabwe'
);
/**
* The class constructor.
* Chooses the payment method and whether is is a test payment.
*
* @param string $gateway The type of gateway to use: 'REAL_TIME',
* 'REAL_TIME_CVN' or 'GEO_IP_ANTI_FRAUD'
* @param bool $test_gateway Use test gateway
* @throws ErrorException
*/
public function __construct($gateway = 'REAL_TIME_CVN', $test_gateway = FALSE)
{
$this->gateway = $gateway;
if($this->gateway == 'REAL_TIME')
{
if($test_gateway)
{
$this->gatewayURL = 'https://www.eway.com.au/gateway/xmltest/testpage.asp';
}
else
{
$this->gatewayURL = 'https://www.eway.com.au/gateway/xmlpayment.asp';
}
}
elseif($this->gateway == 'REAL_TIME_CVN')
{
if($test_gateway)
{
$this->gatewayURL = 'https://www.eway.com.au/gateway_cvn/xmltest/testpage.asp';
}
else
{
$this->gatewayURL = 'https://www.eway.com.au/gateway_cvn/xmlpayment.asp';
}
}
elseif($this->gateway == 'GEO_IP_ANTI_FRAUD')
{
if($test_gateway)
{
$this->gatewayURL = 'https://www.eway.com.au/gateway_cvn/xmltest/testpage.asp';
}
else
{
$this->gatewayURL = 'https://www.eway.com.au/gateway_cvn/xmlbeagle.asp';
}
}
else
{
throw new ErrorException('Gateway method is undefined, or invalid');
}
}
/**
* Sets the unique eWay customer ID.
*
* @param $id string
* @return eway
* @throws ErrorException
*/
public function setCustomerID($id)
{
if(preg_match('/[^A-Za-z0-9]/', $id))
{
throw new ErrorException('Customer ID has invalid characters');
}
elseif(strlen($id) > 8)
{
throw new ErrorException('Customer ID cannot be longer than eight (8) characters');
}
$this->customerID = $id;
return $this;
}
/**
* Get the customer ID.
*
* @return string
*/
public function getCustomerID()
{
return $this->customerID;
}
/**
* Sets the payment amount.
*
* @param $amount float Payment amount in decimal dollars
* @return eway
*/
public function setPaymentAmount($amount)
{
$this->paymentAmount = (int) round($amount*100);
return $this;
}
/**
* Get the payment amount.
*
* @return float The total amount in decimal dollars
*/
public function getPaymentAmount()
{
return round($this->paymentAmount/100, 2);
}
/**
* Sets the card holder's name.
*
* @param $name string
* @return eway
* @throws ErrorException
*/
public function setCardHoldersName($name)
{
if(preg_match('/[^A-Za-z\s\'-\.]/', $name))
{
throw new ErrorException('Card holder name has invalid chracters.');
}
elseif(strlen($name) > 50)
{
throw new ErrorException('Card holder name longer than fifty (50) characters');
}
$this->cardHoldersName = $name;
return $this;
}
/**
* Get the card holder's name.
*
* @return string
*/
public function getCardHoldersName()
{
return $this->cardHoldersName;
}
/**
* Sets the card number.
*
* @param $number string The card number
* @return eway
* @throws ErrorException
*/
public function setCardNumber($number)
{
$number = preg_replace('/[^\d]/', '', $number);
if(strlen($number) > 20)
{
throw new ErrorException('Card number longer than twenty (20) digits');
}
$this->cardNumber = $number;
return $this;
}
/**
* Gets the card number.
*
* @return string The card number
*/
public function getCardNumber()
{
return $this->cardNumber;
}
/**
* Sets the card expiry.
*
* @param $month string|int Two digit month.
* @param $year string|int Two digit year.
* @return eway
* @throws ErrorException
*/
public function setCardExpiry($month, $year)
{
if((intval($month) < 1) OR (intval($month) > 12))
{
throw new ErrorException('Card expiry month is invalid.');
}
elseif((intval($year) < 0) OR (intval($year) > 99))
{
throw new ErrorException('Card expiry year is invalid.');
}
$this->cardExpiryMonth = sprintf('%02d', intval($month));
$this->cardExpiryYear = sprintf('%02d', intval($year));
return $this;
}
/**
* Gets the card expiry month.
*
* @return string
*/
public function getCardExpiryMonth()
{
return $this->cardExpiryMonth;
}
/**
* Gets the card expiry year
*
* @return string
*/
public function getCardExpiryYear()
{
return $this->cardExpiryYear;
}
/**
* Sets the customer's CVN.
*
* This is only required if $gateway is set to
* "REAL_TIME_CVN"OR "GEO_IP_ANTI_FRAUD".
*
* @param $cvn string|int
* @return eway
* @throws ErrorException
*/
public function setCVN($cvn)
{
if(!preg_match('/^\d{3,4}$/', (string) $cvn))
{
throw new ErrorException('CVN is not valid.');
}
$this->cvn = $cvn;
return $this;
}
/**
* Get the card's CVN.
*
* @return string The card's CVN
*/
public function getCVN()
{
return $this->cvn;
}
/**
* Set the customer's two digit country code.
*
* This is only required if $gateway is set to "GEO_IP_ANTI_FRAUD".
*
* @param $country string The customer's country code
* @return eway
* @throws ErrorException
*/
public function setCustomerCountry($country)
{
$country = strtoupper($country);
if(!array_key_exists($country, self::$countryCodes))
{
throw new ErrorException('Invalid country code');
}
$this->customerCountry = $country;
return $this;
}
/**
* Get the customer's two digit country code.
*
* @return string The customer's country code
*/
public function getCustomerCountry()
{
return $this->customerCountry;
}
/**
* Set the customer's IPv4 address.
*
* This is only needed if $gateway is set to "GEO_IP_ANTI_FRAUD".
*
* @param $ip string The customer's IPv4 address
* @return eway
* @throws ErrorException
*/
public function setCustomerIP($ip)
{
if(!preg_match('/^\d{1,3}(\.\d{1,3}){3}$/', $ip))
{
throw new ErrorException('Not a valid IP address.');
}
$this->customerIP = $ip;
return $this;
}
/**
* Get the customer's IPv4 address.
*
* @return string The customer's IPv4 address
*/
public function getCustomerIP()
{
return $this->customerIP;
}
/**
* Sets the customer's first name.
*
* @param $name string The customer's first name
* @return eway
* @throws ErrorException
*/
public function setCustomerFirstName($name)
{
$name = preg_replace('/[^A-Za-z\s\'-]/', '', $name);
if(strlen($name) > 50)
{
throw new ErrorException('Customer name longer than fifty (50) characters');
}
$this->customerFirstName = $name;
return $this;
}
/**
* Get the customer's first name.
*
* @return string The customer's first name
*/
public function getCustomerFirstName()
{
return $this->customerFirstName;
}
/**
* Sets the customer's last name.
*
* @param $name string The customer's last name
* @return eway
* @throws ErrorException
*/
public function setCustomerLastName($name)
{
$name = preg_replace('/[^A-Za-z\s\'-]/', '', $name);
if(strlen($name) > 50)
{
throw new ErrorException('Customer name longer than fifty (50) characters');
}
$this->customerLastName = $name;
return $this;
}
/**
* Get the customer's last name.
*
* @return string The customer's last name
*/
public function getCustomerLastName()
{
return $this->customerLastName;
}
/**
* Sets the customer's email.
*
* @param $email string The customer's email
* @return eway
* @throws ErrorException
*/
public function setCustomerEmail($email)
{
if(!preg_match('/^\w+([-+.\']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$/', $email))
{
throw new ErrorException('Invalid email address.');
}
$this->customerEmail = $email;
return $this;
}
/**
* Get the customer's email address.
*
* @return string The customer's email address
*/
public function getCustomerEmail()
{
return $this->customerEmail;
}
/**
* Sets the customer's postal/residential address.
*
* @param $address string The customer's postal/residential address
* @return eway
*/
public function setCustomerAddress($address)
{
if(strlen($address) > 255)
{
$this->customerAddress = substr($address, 0, 254);
}
else
{
$this->customerAddress = $address;
}
return $this;
}
/**
* Get the customer's postal/residential address.
*
* @return string The customer's postal/residential address.
*/
public function getCustomerAddress()
{
return $this->customerAddress;
}
/**
* Sets the customer's postcode.
*
* @param $postcode string|int The customer's postcode
* @return eway
*/
public function setCustomerPostcode($postcode)
{
$this->customerPostcode = sprintf('%04d', intval($postcode));
return $this;
}
/**
* Sets the customer's postcode.
*
* @return string The customer's postcode
*/
public function getCustomerPostcode()
{
return $this->customerPostcode;
}
/**
* Sets the customer's invoice description.
*
* @param $description string The invoice description
* @return eway
*/
public function setCustomerInvoiceDescription($description)
{
if(strlen($description) > 255)
{
$this->customerInvoiceDescription = substr($description, 0, 244);
}
else
{
$this->customerInvoiceDescription = $description;
}
return $this;
}
/**
* Get the customer's invoice description.
*
* @return string The customer's invoice description
*/
public function getCustomerInvoiceDescription()
{
return $this->customerInvoiceDescription;
}
/**
* Sets the customer's invoice reference.
*
* @param $reference string The customer's invoice reference
* @return eway
* @throws ErrorException
*/
public function setCustomerInvoiceReference($reference)
{
if(strlen($reference) > 50)
{
throw new ErrorException('Customer invoice reference must not exceed fifty (50) characters in length');
}
$this->customerInvoiceRef = $reference;
return $this;
}
/**
* Get the customer's invoice reference.
*
* @return string The customer's invoice reference.
*/
public function getCustomerInvoiceReference()
{
return $this->customerInvoiceRef;
}
/**
* Sets the customer's transaction number.
*
* @param $number string
* @return eway
* @throws ErrorException The customer's transaction number
*/
public function setCustomerTransactionReference($number)
{
if(strlen($number) > 16)
{
throw new ErrorException('Transaction number must not exceed sixteen (16) characters in length');
}
$this->customerTransactionReference = $number;
return $this;
}
/**
* Get the customer's transaction number.
*
* @return string The customer's transaction number
*/
public function getCustomerTransactionReference()
{
return $this->customerTransactionReference;
}
/**
* Sets the eWay option 1.
*
* @param $text string eWay option 1
* @return eway
*/
public function setOption1($text)
{
if(strlen($text) > 255)
{
$this->option1 = substr($text, 0, 244);
}
else
{
$this->option1 = $text;
}
return $this;
}
/**
* Get the eWay option 1.
*
* @return string eWay option 1
*/
public function getOption1()
{
return $this->option1;
}
/**
* Sets the eWay option 2.
*
* @param $text string eWay option 2
* @return eway
*/
public function setOption2($text)
{
if(strlen($text) > 255)
{
$this->option2 = substr($text, 0, 244);
}
else
{
$this->option2 = $text;
}
return $this;
}
/**
* Get the eWay option 2.
*
* @return string eWay option 2
*/
public function getOption2()
{
return $this->option2;
}
/**
* Sets the eWay option 3.
*
* @param $text string eWay option 3
* @return eway
*/
public function setOption3($text)
{
if(strlen($text) > 255)
{
$this->option3 = substr($text, 0, 244);
}
else
{
$this->option3 = $text;
}
return $this;
}
/**
* Get the eWay option 3.
*
* @return string eWay option 3
*/
public function getOption3()
{
return $this->option3;
}
/**
* Get the transaction response from the gateway.
*
* @return string The transaction response in XML format
*/
public function getTransactionResponse()
{
return $this->transactionResponse;
}
/**
* Sets the XML packet used to make a payment.
*
* @return string The payment XML
*/
public function setPaymentXML()
{
$xml = new \SimpleXMLElement('
');
if(isset($this->customerID)) $xml->addChild('ewayCustomerID', $this->customerID);
if(isset($this->paymentAmount)) $xml->addChild('ewayTotalAmount', $this->paymentAmount);
if(isset($this->cardHoldersName)) $xml->addChild('ewayCardHoldersName', $this->cardHoldersName);
if(isset($this->cardNumber)) $xml->addChild('ewayCardNumber', $this->cardNumber);
if(isset($this->cardExpiryMonth)) $xml->addChild('ewayCardExpiryMonth', $this->cardExpiryMonth);
if(isset($this->cardExpiryYear)) $xml->addChild('ewayCardExpiryYear', $this->cardExpiryYear);
if(isset($this->cvn)) $xml->addChild('ewayCVN', $this->cvn);
if(isset($this->customerFirstName)) $xml->addChild('ewayCustomerFirstName', $this->customerFirstName);
if(isset($this->customerLastName)) $xml->addChild('ewayCustomerLastName', $this->customerLastName);
if(isset($this->customerEmail)) $xml->addChild('ewayCustomerEmail', $this->customerEmail);
if(isset($this->customerAddress)) $xml->addChild('ewayCustomerAddress', $this->customerAddress);
if(isset($this->customerPostcode)) $xml->addChild('ewayCustomerPostcode', $this->customerPostcode);
if(isset($this->customerInvoiceDescription)) $xml->addChild('ewayCustomerInvoiceDescription', $this->customerInvoiceDescription);
if(isset($this->customerInvoiceRef)) $xml->addChild('ewayCustomerInvoiceRef', $this->customerInvoiceRef);
if(isset($this->customerTransactionReference)) $xml->addChild('ewayTrxnNumber', $this->customerTransactionReference);
if(isset($this->option1)) $xml->addChild('ewayOption1', $this->option1);
if(isset($this->option2)) $xml->addChild('ewayOption2', $this->option2);
if(isset($this->option3)) $xml->addChild('ewayOption3', $this->option3);
if(isset($this->customerIP)) $xml->addChild('ewayCustomerIPAddress', $this->customerIP);
if(isset($this->customerCountry)) $xml->addChild('ewayCustomerBillingCountry', $this->customerCountry);
return $xml->asXML();
}
/**
* Sends an XML packet to the gateway and returns the gateway response.
*
* @param $xml string The XML string to be sent
* @return string The gateway's response
*/
protected function sendXML($xml)
{
$ch = curl_init($this->gatewayURL);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: text/xml'));
curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
return curl_exec($ch);
}
/**
* Runs the payment and returns True upon successful payment.
* If mandatory fields needed by the chosen gateway are not set,
* this function will throw an exception.
*
* @return bool Whether the payment has been successful or not
* @throws ErrorException
*/
public function pay()
{
if( !isset($this->customerID) OR
!isset($this->paymentAmount) OR
!isset($this->cardHoldersName) OR
!isset($this->cardNumber) OR
!isset($this->cardExpiryMonth) OR
!isset($this->cardExpiryYear) OR
(!isset($this->cvn) AND ($this->gateway == 'REAL_TIME_CVN' OR $this->gateway == 'GEO_IP_ANTI_FRAUD')) OR
(!isset($this->customerIP) AND $this->gateway == 'GEO_IP_ANTI_FRAUD') OR
(!isset($this->customerCountry) AND $this->gateway == 'GEO_IP_ANTI_FRAUD'))
{
throw new ErrorException('Not all mandatory fields have been set.');
}
$xml = $this->setPaymentXML();
$this->transactionResponse = $this->sendXML($xml);
$this->loadPaymentResponse($this->transactionResponse);
if($this->transactionStatus == 'True')
{
return TRUE;
}
else
{
return FALSE;
}
}
/**
* Takes XML from the payment response and loads into the
* response transaction variables.
*
* @param $response_string string The payment response in XML format
*/
public function loadPaymentResponse($response_string)
{
$response = simplexml_load_string($response_string);
$this->transactionError = (string) $response->{'ewayTrxnError'};
$this->transactionStatus = (string) $response->{'ewayTrxnStatus'};
$this->transactionNumber = (string) $response->{'ewayTrxnNumber'};
$this->transactionReference = (string) $response->{'ewayTrxnReference'};
$this->transactionAmount = (string) $response->{'ewayReturnAmount'};
$this->transactionAuthNumber = (string) $response->{'ewayAuthCode'};
$this->transactionOption1 = (string) $response->{'ewayTrxnOption1'};
$this->transactionOption2 = (string) $response->{'ewayTrxnOption2'};
$this->transactionOption3 = (string) $response->{'ewayTrxnOption3'};
$this->transactionBeagleScore = (string) $response->{'ewayBeagleScore'};
if(preg_match('/^\d{2}/', $this->transactionError, $code))
{
$this->responseCode = $code[0];
}
}
/**
* Get the transaction error message.
* This is also a success message.
*
* @return string The transaction error message
*/
public function getTransactionError()
{
return $this->transactionError;
}
/**
* Get the transaction status.
*
* @return string The transaction status
*/
public function getTransactionStatus()
{
return $this->transactionStatus;
}
/**
* Get the transaction number.
*
* @return string The transaction number
*/
public function getTransactionNumber()
{
return $this->transactionNumber;
}
/**
* Get the transaction reference.
*
* @return string The transaction reference
*/
public function getTransactionReference()
{
return $this->transactionReference;
}
/**
* Get the returned transaction amount. This is the
* amount returned by the gateway, and may not nessecarily
* be the same as the one sent to the gateway.
*
* @return string The returned transaction amount
*/
public function getTransactionAmount()
{
return $this->transactionAmount;
}
/**
* Get the transaction authorisation code.
*
* @return string The transaction authorisation code
*/
public function getTransactionAuthNumber()
{
return $this->transactionAuthNumber;
}
/**
* Get the eWay transaction option 1
*
* @return string The eWay transaction option 1
*/
public function getTransactionOption1()
{
return $this->transactionOption1;
}
/**
* Get the eWay transaction option 2
*
* @return string The eWay transaction option 2
*/
public function getTransactionOption2()
{
return $this->transactionOption2;
}
/**
* Get the eWay transaction option 3
*
* @return string The eWay transaction option 3
*/
public function getTransactionOption3()
{
return $this->transactionOption3;
}
/**
* Get the transaction's beagle anti-fraud score.
*
* @return string The beagle score
*/
public function getTransactionBeagleScore()
{
return $this->transactionBeagleScore;
}
/**
* Get the response code.
*
* @return string The response code
*/
public function getResponseCode()
{
return $this->responseCode;
}
/**
* Get the text corresponding to the response code.
*
* @return bool|string Returns false if the response
* codes are not set or the code is not known, or returns the text
*/
public function getResponseText()
{
if(!isset($this->responseCode))
{
return FALSE;
}
elseif(array_key_exists($this->responseCode, self::$responseCodes))
{
return self::$responseCodes[$this->responseCode]['text'];
}
else
{
return FALSE;
}
}
/**
* Check if the transaction was approved.
*
* @return bool Whether or not the transaction was approved
*/
public function getTransactionApproved()
{
if($this->transactionStatus != 'True')
{
return FALSE;
}
if(!isset($this->responseCode))
{
return FALSE;
}
elseif(array_key_exists($this->responseCode, self::$responseCodes))
{
return self::$responseCodes[$this->responseCode]['approved'];
}
else
{
return FALSE;
}
}
/**
* Check if a card number is valid.
*
* This function should be used to validate the
* card number before sending it to the gateway.
* This will cut down response time if the credit
* card has been entered incorrectly.
*
* This is based on ISO/IEC 7812-1:2006
* {@link http://en.wikipedia.org/wiki/ISO/IEC_7812 ISO/IEC 7812}.
*
* @param $cardNumber string
* @return bool Returns true if the card is valid
*/
public static function checkCardNumber($cardNumber)
{
$cardNumber = preg_replace('/[^\d]/', '', $cardNumber);
if((strlen($cardNumber) < 16) OR (strlen($cardNumber) > 20))
{
return FALSE;
}
$cardNumber = str_split($cardNumber);
$checkDigit = (int) end($cardNumber);
$sum = 0;
for($i = 1; $i < count($cardNumber); $i++)
{
if($i&1)
{
$digit = $cardNumber[$i-1];
}
else
{
$number = sprintf('%02d', 2*$cardNumber[$i-1]);
$digit = $number[0] + $number[1];
}
$sum += $digit;
}
return $checkDigit == $sum % 10;
}
}
