CRM/Financial/BAO/PaymentProcessorType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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 class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentProcessorType {
  36
  37   /**
  38    * Static holder for the default payment processor
  39    */
  40   static $_defaultPaymentProcessorType = NULL;
  41
  42   /**
  43    * Class constructor
  44    */
  45   public function __construct() {
  46     parent::__construct();
  47   }
  48
  49   /**
  50    * Fetch object based on array of properties
  51    *
  52    * @param array $params
  53    *   (reference ) an assoc array of name/value pairs.
  54    * @param array $defaults
  55    *   (reference ) an assoc array to hold the flattened values.
  56    *
  57    * @return CRM_Core_BAO_LocaationType|null
  58    *   object on success, null otherwise
  59    * @static
  60    */
  61   public static function retrieve(&$params, &$defaults) {
  62     $paymentProcessorType = new CRM_Financial_DAO_PaymentProcessorType();
  63     $paymentProcessorType->copyValues($params);
  64     if ($paymentProcessorType->find(TRUE)) {
  65       CRM_Core_DAO::storeValues($paymentProcessorType, $defaults);
  66       return $paymentProcessorType;
  67     }
  68     return NULL;
  69   }
  70
  71   /**
  72    * Update the is_active flag in the db
  73    *
  74    * @param int $id
  75    *   Id of the database record.
  76    * @param bool $is_active
  77    *   Value we want to set the is_active field.
  78    *
  79    * @return Object
  80    *   DAO object on sucess, null otherwise
  81    *
  82    * @static
  83    */
  84   public static function setIsActive($id, $is_active) {
  85     return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_PaymentProcessorType', $id, 'is_active', $is_active);
  86   }
  87
  88   /**
  89    * Retrieve the default payment processor
  90    *
  91    * @param NULL
  92    *
  93    * @return object
  94    *   The default payment processor object on success,
  95    *                          null otherwise
  96    * @static
  97    */
  98   public static function &getDefault() {
  99     if (self::$_defaultPaymentProcessorType == NULL) {
 100       $params = array('is_default' => 1);
 101       $defaults = array();
 102       self::$_defaultPaymentProcessorType = self::retrieve($params, $defaults);
 103     }
 104     return self::$_defaultPaymentProcessorType;
 105   }
 106
 107   /**
 108    * Add the payment-processor type in the db
 109    *
 110    * @param array $params
 111    *   (reference ) an assoc array of name/value pairs.
 112    *
 113    * @throws Exception
 114    * @return CRM_Financial_DAO_PaymentProcessorType
 115    * @static
 116    */
 117   public static function create(&$params) {
 118     $paymentProcessorType = new CRM_Financial_DAO_PaymentProcessorType();
 119     $paymentProcessorType->copyValues($params);
 120
 121     /*
 122     // adapted from CRM_Core_Extensions_Payment::install
 123     foreach (array(
 124       'class_name',
 125       'title',
 126       'name',
 127       'description',
 128       'user_name_label',
 129       'password_label',
 130       'signature_label',
 131       'subject_label',
 132       'url_site_default',
 133       'url_api_default',
 134       'url_recur_default',
 135       'url_site_test_default',
 136       'url_api_test_default',
 137       'url_recur_test_default',
 138       'url_button_default',
 139       'url_button_test_default',
 140       'billing_mode',
 141       'is_recur',
 142       'payment_type'
 143     ) as $trimmable) {
 144       if (isset($paymentProcessorType->{$trimmable})) {
 145         $paymentProcessorType->{$trimmable} = trim($paymentProcessorType->{$trimmable});
 146       }
 147     }
 148     */
 149
 150     if (isset($paymentProcessorType->billing_mode)) {
 151       // ugh unidirectional manipulation
 152       if (!is_numeric($paymentProcessorType->billing_mode)) {
 153         $billingModes = array_flip(self::buildOptions('billing_mode'));
 154         if (array_key_exists($paymentProcessorType->billing_mode, $billingModes)) {
 155           $paymentProcessorType->billing_mode = $billingModes[$paymentProcessorType->billing_mode];
 156         }
 157       }
 158       if (!array_key_exists($paymentProcessorType->billing_mode, self::buildOptions('billing_mode'))) {
 159         throw new Exception("Unrecognized billing_mode");
 160       }
 161     }
 162
 163     // FIXME handle is_default
 164     if (!empty($paymentProcessorType->id)) {
 165       $ppByName = self::getAllPaymentProcessorTypes('name');
 166       if (array_key_exists($paymentProcessorType->name, $ppByName)) {
 167         if ($ppByName[$paymentProcessorType->name] != $paymentProcessorType->id) {
 168           CRM_Core_Error::fatal('This payment processor type already exists.');
 169         }
 170       }
 171     }
 172
 173     return $paymentProcessorType->save();
 174   }
 175
 176   /**
 177    * Delete payment processor
 178    *
 179    * @param int $paymentProcessorTypeId
 180    *   ID of the processor to be deleted.
 181    *
 182    * @return bool
 183    * @static
 184    */
 185   public static function del($paymentProcessorTypeId) {
 186     $query = "
 187 SELECT pp.id processor_id
 188 FROM civicrm_payment_processor pp, civicrm_payment_processor_type ppt
 189 WHERE pp.payment_processor_type_id = ppt.id AND ppt.id = %1";
 190
 191     $params = array(1 => array($paymentProcessorTypeId, 'Integer'));
 192     $dao = CRM_Core_DAO::executeQuery($query, $params);
 193
 194     if ($dao->fetch()) {
 195       CRM_Core_Session::setStatus(ts('There is a Payment Processor associated with selected Payment Processor type, hence it can not be deleted.'), ts('Deletion Error'), 'error');
 196       return;
 197     }
 198
 199     $paymentProcessorType = new CRM_Financial_DAO_PaymentProcessorType();
 200     $paymentProcessorType->id = $paymentProcessorTypeId;
 201     if ($paymentProcessorType->delete()) {
 202       CRM_Core_Session::setStatus(ts('Selected Payment Processor type has been deleted.<br/>'), '', 'success');
 203       return TRUE;
 204     }
 205   }
 206
 207   /**
 208    * @param $attr
 209    *
 210    * @return array
 211    */
 212   static private function getAllPaymentProcessorTypes($attr) {
 213     $ppt = array();
 214     $dao = new CRM_Financial_DAO_PaymentProcessorType();
 215     $dao->find();
 216     while ($dao->fetch()) {
 217       $ppt[$dao->$attr] = $dao->id;
 218     }
 219     return $ppt;
 220   }
 221
 222 }