CRM/Financial/BAO/PaymentProcessorType.php

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