CRM/Financial/BAO/PaymentProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class contains payment processor related functions.
  38  */
  39 class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProcessor
  40 {
  41   /**
  42    * static holder for the default payment processor
  43    */
  44   static $_defaultPaymentProcessor = NULL;
  45
  46   /*
  47    * Create Payment Processor
  48    *
  49    * @params array parameters for Processor entity
  50    */
  51   static function create($params) {
  52     // FIXME Reconcile with CRM_Admin_Form_PaymentProcessor::updatePaymentProcessor
  53     $processor = new CRM_Financial_DAO_PaymentProcessor();
  54     $processor->copyValues($params);
  55
  56     $ppTypeDAO = new CRM_Financial_DAO_PaymentProcessorType();
  57     $ppTypeDAO->id = $params['payment_processor_type_id'];
  58     if (!$ppTypeDAO->find(TRUE)) {
  59       CRM_Core_Error::fatal(ts('Could not find payment processor meta information'));
  60     }
  61
  62     // also copy meta fields from the info DAO
  63     $processor->is_recur = $ppTypeDAO->is_recur;
  64     $processor->billing_mode = $ppTypeDAO->billing_mode;
  65     $processor->class_name = $ppTypeDAO->class_name;
  66     $processor->payment_type = $ppTypeDAO->payment_type;
  67
  68     $processor->save();
  69     // CRM-11826, add entry in civicrm_entity_financial_account
  70     // if financial_account_id is not NULL
  71     if (!empty($params['financial_account_id'])) {
  72       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
  73       $values = array(
  74         'entity_table' => 'civicrm_payment_processor',
  75         'entity_id' => $processor->id,
  76         'account_relationship' => $relationTypeId,
  77         'financial_account_id' => $params['financial_account_id']
  78       );
  79       CRM_Financial_BAO_FinancialTypeAccount::add($values);
  80     }
  81     return $processor;
  82   }
  83
  84   /**
  85    * class constructor
  86    */
  87   function __construct() {
  88     parent::__construct();
  89   }
  90
  91   /**
  92    * Takes a bunch of params that are needed to match certain criteria and
  93    * retrieves the relevant objects. It also stores all the retrieved
  94    * values in the default array
  95    *
  96    * @param array $params   (reference ) an assoc array of name/value pairs
  97    * @param array $defaults (reference ) an assoc array to hold the flattened values
  98    *
  99      * @return object CRM_Financial_DAO_PaymentProcessor object on success, null otherwise
 100    * @access public
 101    * @static
 102    */
 103   static function retrieve(&$params, &$defaults) {
 104     $paymentProcessor = new CRM_Financial_DAO_PaymentProcessor();
 105     $paymentProcessor->copyValues($params);
 106     if ($paymentProcessor->find(TRUE)) {
 107       CRM_Core_DAO::storeValues($paymentProcessor, $defaults);
 108       return $paymentProcessor;
 109     }
 110     return NULL;
 111   }
 112
 113   /**
 114    * update the is_active flag in the db
 115    *
 116    * @param int      $id        id of the database record
 117    * @param boolean  $is_active value we want to set the is_active field
 118    *
 119    * @return Object             DAO object on sucess, null otherwise
 120    *
 121    * @access public
 122    * @static
 123    */
 124   static function setIsActive($id, $is_active) {
 125     return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_PaymentProcessor', $id, 'is_active', $is_active);
 126   }
 127
 128   /**
 129    * retrieve the default payment processor
 130    *
 131    * @param NULL
 132    *
 133    * @return object           The default payment processor object on success,
 134    *                          null otherwise
 135    * @static
 136    * @access public
 137    */
 138   static function &getDefault() {
 139     if (self::$_defaultPaymentProcessor == NULL) {
 140       $params = array('is_default' => 1);
 141       $defaults = array();
 142       self::$_defaultPaymentProcessor = self::retrieve($params, $defaults);
 143     }
 144     return self::$_defaultPaymentProcessor;
 145   }
 146
 147   /**
 148    * Function  to delete payment processor
 149    *
 150    * @param $paymentProcessorID
 151    *
 152    * @return null
 153    * @internal param int $paymentProcessorId ID of the processor to be deleted.
 154    *
 155    * @access public
 156    * @static
 157    */
 158   static function del($paymentProcessorID) {
 159     if (!$paymentProcessorID) {
 160       CRM_Core_Error::fatal(ts('Invalid value passed to delete function'));
 161     }
 162
 163     $dao = new CRM_Financial_DAO_PaymentProcessor();
 164     $dao->id = $paymentProcessorID;
 165     if (!$dao->find(TRUE)) {
 166       return NULL;
 167     }
 168
 169     $testDAO = new CRM_Financial_DAO_PaymentProcessor();
 170     $testDAO->name = $dao->name;
 171     $testDAO->is_test = 1;
 172     $testDAO->delete();
 173
 174     $dao->delete();
 175   }
 176
 177   /**
 178    * Function to get the payment processor details
 179    *
 180    * @param  int    $paymentProcessorID payment processor id
 181    * @param  string $mode               payment mode ie test or live
 182    *
 183    * @return array  associated array with payment processor related fields
 184    * @static
 185    * @access public
 186    */
 187   static function getPayment($paymentProcessorID, $mode) {
 188     if (!$paymentProcessorID) {
 189       CRM_Core_Error::fatal(ts('Invalid value passed to getPayment function'));
 190     }
 191
 192     $dao            = new CRM_Financial_DAO_PaymentProcessor( );
 193     $dao->id        = $paymentProcessorID;
 194     $dao->is_active = 1;
 195     if (!$dao->find(TRUE)) {
 196       return NULL;
 197     }
 198
 199     if ($mode == 'test') {
 200       $testDAO = new CRM_Financial_DAO_PaymentProcessor( );
 201       $testDAO->name      = $dao->name;
 202       $testDAO->is_active = 1;
 203       $testDAO->is_test   = 1;
 204       if (!$testDAO->find(TRUE)) {
 205         CRM_Core_Error::fatal(ts('Could not retrieve payment processor details'));
 206       }
 207       return self::buildPayment($testDAO, $mode);
 208     }
 209     else {
 210       return self::buildPayment($dao, $mode);
 211     }
 212   }
 213
 214   static function getPayments($paymentProcessorIDs, $mode) {
 215     if (!$paymentProcessorIDs) {
 216       CRM_Core_Error::fatal(ts('Invalid value passed to getPayment function'));
 217     }
 218
 219     $payments = array( );
 220     foreach ($paymentProcessorIDs as $paymentProcessorID) {
 221       $payment = self::getPayment($paymentProcessorID, $mode);
 222       $payments[$payment['id']] = $payment;
 223     }
 224
 225     uasort($payments, 'self::defaultComparison');
 226     return $payments;
 227   }
 228
 229   /**
 230    * compare 2 payment processors to see which should go first based on is_default
 231    * (sort function for sortDefaultFirst)
 232    * @param array $processor1
 233    * @param array_type $processor2
 234    * @return number
 235    */
 236     static function defaultComparison($processor1, $processor2){
 237       $p1 = CRM_Utils_Array::value('is_default', $processor1);
 238       $p2 = CRM_Utils_Array::value('is_default', $processor2);
 239       if ($p1 == $p2) {
 240         return 0;
 241       }
 242       return ($p1 > $p2) ? -1 : 1;
 243     }
 244
 245   /**
 246    * Function to build payment processor details
 247    *
 248    * @param object $dao   payment processor object
 249    * @param  string $mode payment mode ie test or live
 250    *
 251    * @return array  associated array with payment processor related fields
 252    * @static
 253    * @access public
 254    */
 255   static function buildPayment($dao, $mode) {
 256     $fields = array(
 257       'id', 'name', 'payment_processor_type_id', 'user_name', 'password',
 258       'signature', 'url_site', 'url_api', 'url_recur', 'url_button',
 259       'subject', 'class_name', 'is_recur', 'billing_mode',
 260       'payment_type', 'is_default',
 261     );
 262     $result = array();
 263     foreach ($fields as $name) {
 264       $result[$name] = $dao->$name;
 265     }
 266     $result['payment_processor_type'] = CRM_Core_PseudoConstant::paymentProcessorType(FALSE, $dao->payment_processor_type_id, 'name');
 267
 268     $result['instance'] =& CRM_Core_Payment::singleton($mode, $result);
 269
 270     return $result;
 271   }
 272
 273   /**
 274    * Function to retrieve payment processor id / info/ object based on component-id.
 275    *
 276    * @param $entityID
 277    * @param string $component component
 278    * @param string $type type of payment information to be retrieved
 279    *
 280    * @internal param int $componentID id of a component
 281    * @return id / array / object based on type
 282    * @static
 283    * @access public
 284    */
 285   static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') {
 286     $result = NULL;
 287     if (!in_array($component, array(
 288       'membership', 'contribute', 'recur'))) {
 289       return $result;
 290     }
 291     //FIXME:
 292     if ($component == 'membership') {
 293       $sql = "
 294     SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
 295       FROM civicrm_membership mem
 296 INNER JOIN civicrm_membership_payment mp  ON ( mem.id = mp.membership_id )
 297 INNER JOIN civicrm_contribution       con ON ( mp.contribution_id = con.id )
 298  LEFT JOIN civicrm_contribution_recur cr  ON ( mem.contribution_recur_id = cr.id )
 299  LEFT JOIN civicrm_contribution_page  cp  ON ( con.contribution_page_id  = cp.id )
 300      WHERE mp.membership_id = %1";
 301     }
 302     elseif ($component == 'contribute') {
 303       $sql = "
 304     SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
 305       FROM civicrm_contribution       con
 306  LEFT JOIN civicrm_contribution_recur cr  ON ( con.contribution_recur_id = cr.id )
 307  LEFT JOIN civicrm_contribution_page  cp  ON ( con.contribution_page_id  = cp.id )
 308      WHERE con.id = %1";
 309     }
 310     elseif ($component == 'recur') {
 311       $sql = "
 312     SELECT cr.payment_processor_id as ppID1, NULL as ppID2, cr.is_test
 313       FROM civicrm_contribution_recur cr
 314      WHERE cr.id = %1";
 315     }
 316
 317     //we are interesting in single record.
 318     $sql .= ' LIMIT 1';
 319
 320     $params = array(1 => array($entityID, 'Integer'));
 321     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 322
 323     if (!$dao->fetch()) {
 324
 325       return $result;
 326
 327     }
 328
 329     $ppID = (isset($dao->ppID1) && $dao->ppID1) ? $dao->ppID1 : (isset($dao->ppID2) ? $dao->ppID2 : NULL);
 330     $mode = (isset($dao->is_test) && $dao->is_test) ? 'test' : 'live';
 331     if (!$ppID || $type == 'id') {
 332       $result = $ppID;
 333     }
 334     elseif ($type == 'info') {
 335       $result = self::getPayment($ppID, $mode);
 336     }
 337     elseif ($type == 'obj') {
 338       $payment = self::getPayment($ppID, $mode);
 339       $result = CRM_Core_Payment::singleton($mode, $payment);
 340     }
 341
 342     return $result;
 343   }
 344 }
 345