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