5 * Licensed to CiviCRM under the Academic Free License version 3.0.
7 * Written and contributed by Phase2 Technology, LLC (http://www.phase2technology.com)
14 * @author Michael Morris and Gene Chi @ Phase2 Technology <mmorris@phase2technology.com>
18 class CRM_Core_Payment_PayJunction
extends CRM_Core_Payment
{
19 # (not used, implicit in the API, might need to convert?)
20 const CHARSET
= 'UFT-8';
23 * We only need one instance of this object. So we use the singleton
24 * pattern and cache the instance in this variable
28 static private $_singleton = NULL;
34 * The mode of operation: live or test.
36 * @param $paymentProcessor
38 * @return \CRM_Core_Payment_PayJunction
40 public function __construct($mode, &$paymentProcessor) {
41 //require PayJunction API library
42 require_once 'PayJunction/pjClasses.php';
45 $this->_paymentProcessor
= $paymentProcessor;
46 $this->_processorName
= ts('PayJunction');
50 * This function sends request and receives response from
51 * PayJunction payment process
53 * @param array $params
54 * Assoc array of input parameters for this transaction.
57 * the result in an nice formatted array (or an error object)
59 public function doDirectPayment(&$params) {
60 $logon = $this->_paymentProcessor
['user_name'];
61 $password = $this->_paymentProcessor
['password'];
62 $url_site = $this->_paymentProcessor
['url_site'];
64 // create pjpgCustInfo object
65 $pjpgCustInfo = new pjpgCustInfo();
67 $pjpgCustInfo->setEmail($params['email']);
71 "password" => $password,
72 "url_site" => $url_site,
73 "first_name" => $params['first_name'],
74 "last_name" => $params['last_name'],
75 "address" => $params['street_address'],
76 "city" => $params['city'],
77 "province" => $params['state_province'],
78 "postal_code" => $params['postal_code'],
79 "country" => $params['country'],
81 $pjpgCustInfo->setBilling($billing);
83 // create pjpgTransaction object
84 $my_orderid = $params['invoiceID'];
86 $expiry_string = sprintf('%04d%02d', $params['year'], $params['month']);
90 'order_id' => $my_orderid,
91 'amount' => sprintf('%01.2f', $params['amount']),
92 'pan' => $params['credit_card_number'],
93 'expdate' => $expiry_string,
95 'cavv' => $params['cvv2'],
96 'cust_id' => $params['contact_id'],
99 // Allow further manipulation of params via custom hooks
100 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $txnArray);
102 $pjpgTxn = new pjpgTransaction($txnArray);
104 // set customer info (level 3 data) for the transaction
105 $pjpgTxn->setCustInfo($pjpgCustInfo);
107 // empty installments convert to 999 because PayJunction do not allow open end donation
108 if ($params['installments'] == "") {
109 $params['installments'] = "999";
112 // create recurring object
113 if ($params['is_recur'] == TRUE && $params['installments'] > 1) {
114 // schedule start date as today
115 // format: YYYY-MM-DD
116 $params['dc_schedule_start'] = date("Y-m-d");
119 $dc_schedule_create = $params['is_recur'];
120 $recurUnit = $params['frequency_unit'];
121 $recurInterval = $params['frequency_interval'];
122 $dc_schedule_start = $params['dc_schedule_start'];
124 // next payment in moneris required format
125 $startDate = date("Y/m/d", $next);
127 $numRecurs = $params['installments'];
130 'dc_schedule_create' => $dc_schedule_create,
131 // (day | week | month)
132 'recur_unit' => $recurUnit,
134 'start_date' => $startDate,
135 'num_recurs' => $numRecurs,
136 'start_now' => 'false',
137 'period' => $recurInterval,
138 'dc_schedule_start' => $dc_schedule_start,
139 'amount' => sprintf('%01.2f', $params['amount']),
142 $pjpgRecur = new pjpgRecur($recurArray);
144 $pjpgTxn->setRecur($pjpgRecur);
147 // create a pjpgRequest object passing the transaction object
148 $pjpgRequest = new pjpgRequest($pjpgTxn);
150 $pjpgHttpPost = new pjpgHttpsPost($pjpgRequest);
152 // get an pjpgResponse object
153 $pjpgResponse = $pjpgHttpPost->getPJpgResponse();
155 if (self
::isError($pjpgResponse)) {
156 return self
::error($pjpgResponse);
159 /* Check for application errors */
161 $result = self
::checkResult($pjpgResponse);
162 if (is_a($result, 'CRM_Core_Error')) {
167 $params['trxn_result_code'] = $pjpgResponse['dc_response_code'];
168 $params['trxn_id'] = $pjpgResponse['dc_transaction_id'];
169 $params['gross_amount'] = $params['amount'];
173 // end function doDirectPayment
177 * This function checks the PayJunction response code.
181 public function isError(&$response) {
182 $responseCode = $response['dc_response_code'];
184 if ($responseCode == "00" ||
$responseCode == "85") {
194 * ignore for now, more elaborate error handling later.
199 public function &checkResult(&$response) {
204 * Get the value of a field if set.
206 * @param string $field
210 * value of the field, or empty string if the field is
213 public function _getParam($field) {
214 if (isset($this->_params
[$field])) {
215 return $this->_params
[$field];
227 public function &error($error = NULL) {
228 $e = CRM_Core_Error
::singleton();
230 $e->push($error['dc_response_code'],
232 $error['dc_response_message']
236 $e->push(9001, 0, NULL, "Unknown System Error.");
242 * Set a field to the specified value. Value must be a scalar (int,
243 * float, string, or boolean)
245 * @param string $field
246 * @param mixed $value
249 * false if value is not a scalar, true if successful
251 public function _setParam($field, $value) {
252 if (!is_scalar($value)) {
256 $this->_params
[$field] = $value;
261 * This function checks to see if we have the right config values.
264 * the error message if any
266 public function checkConfig() {
268 if (empty($this->_paymentProcessor
['user_name'])) {
269 $error[] = ts('Username is not set for this payment processor');
272 if (empty($this->_paymentProcessor
['password'])) {
273 $error[] = ts('Password is not set for this payment processor');
276 if (empty($this->_paymentProcessor
['url_site'])) {
277 $error[] = ts('Site URL is not set for this payment processor');
280 if (!empty($error)) {
281 return implode('<p>', $error);
289 // end class CRM_Core_Payment_PayJunction