Civi/Payment/System.php

   1 <?php
   2
   3 namespace Civi\Payment;
   4
   5 /**
   6  * Class System
   7  * @package Civi\Payment
   8  */
   9 class System {
  10
  11   /**
  12    * @var System
  13    */
  14   private static $singleton;
  15
  16   /**
  17    * @var array cache
  18    */
  19   private $cache = array();
  20
  21   /**
  22    * @return \Civi\Payment\System
  23    */
  24   public static function singleton() {
  25     if (!self::$singleton) {
  26       self::$singleton = new self();
  27     }
  28     return self::$singleton;
  29   }
  30
  31   /**
  32    * Starting from the processor as an array retrieve the processor as an object.
  33    *
  34    * If there is no valid configuration it will not be retrieved.
  35    *
  36    * @param array $processor
  37    * @param bool $force
  38    *   Override the config check. This is required in uninstall as no valid instances exist
  39    *   but will deliberately not work with any valid processors.
  40    *
  41    * @return \CRM_Core_Payment|NULL
  42    *
  43    * @throws \CRM_Core_Exception
  44    */
  45   public function getByProcessor($processor, $force = FALSE) {
  46     $id = $force ? 0 : $processor['id'];
  47
  48     if (!isset($this->cache[$id]) || $force) {
  49       $ext = \CRM_Extension_System::singleton()->getMapper();
  50       if ($ext->isExtensionKey($processor['class_name'])) {
  51         $paymentClass = $ext->keyToClass($processor['class_name'], 'payment');
  52         require_once $ext->classToPath($paymentClass);
  53       }
  54       else {
  55         $paymentClass = 'CRM_Core_' . $processor['class_name'];
  56         if (empty($paymentClass)) {
  57           throw new \CRM_Core_Exception('no class provided');
  58         }
  59         require_once str_replace('_', DIRECTORY_SEPARATOR, $paymentClass) . '.php';
  60       }
  61
  62       $processorObject = new $paymentClass(!empty($processor['is_test']) ? 'test' : 'live', $processor);
  63       if (!$force && $processorObject->checkConfig()) {
  64         $processorObject = NULL;
  65       }
  66       else {
  67         $processorObject->setPaymentProcessor($processor);
  68       }
  69       $this->cache[$id] = $processorObject;
  70     }
  71
  72     return $this->cache[$id];
  73   }
  74
  75   /**
  76    * Execute checkConfig() on the payment processor Object.
  77    * This function creates a new instance of the processor object and returns the output of checkConfig
  78    *
  79    * @param array $processor
  80    *
  81    * @return string|NULL
  82    *
  83    * @throws \CRM_Core_Exception
  84    */
  85   public function checkProcessorConfig($processor) {
  86     $ext = \CRM_Extension_System::singleton()->getMapper();
  87     if ($ext->isExtensionKey($processor['class_name'])) {
  88       $paymentClass = $ext->keyToClass($processor['class_name'], 'payment');
  89       require_once $ext->classToPath($paymentClass);
  90     }
  91     else {
  92       $paymentClass = 'CRM_Core_' . $processor['class_name'];
  93       if (empty($paymentClass)) {
  94         throw new \CRM_Core_Exception('no class provided');
  95       }
  96       require_once str_replace('_', DIRECTORY_SEPARATOR, $paymentClass) . '.php';
  97     }
  98
  99     $processorObject = new $paymentClass(!empty($processor['is_test']) ? 'test' : 'live', $processor);
 100     return $processorObject->checkConfig();
 101   }
 102
 103   /**
 104    * Get payment processor by it's ID.
 105    *
 106    * @param int $id
 107    *
 108    * @return \CRM_Core_Payment|NULL
 109    * @throws \CiviCRM_API3_Exception
 110    */
 111   public function getById($id) {
 112     if ($id == 0) {
 113       return new \CRM_Core_Payment_Manual();
 114     }
 115     $processor = civicrm_api3('payment_processor', 'getsingle', array('id' => $id, 'is_test' => NULL));
 116     return self::getByProcessor($processor);
 117   }
 118
 119   /**
 120    * @param string $name
 121    * @param bool $is_test
 122    *
 123    * @return \CRM_Core_Payment|NULL
 124    * @throws \CiviCRM_API3_Exception
 125    */
 126   public function getByName($name, $is_test) {
 127     $processor = civicrm_api3('payment_processor', 'getsingle', array('name' => $name, 'is_test' => $is_test));
 128     return self::getByProcessor($processor);
 129   }
 130
 131   /**
 132    * Flush processors from static cache.
 133    *
 134    * This is particularly used for tests.
 135    */
 136   public function flushProcessors() {
 137     $this->cache = array();
 138     \CRM_Financial_BAO_PaymentProcessor::getAllPaymentProcessors('all', TRUE);
 139     \CRM_Financial_BAO_PaymentProcessor::getAllPaymentProcessors('live', TRUE);
 140     \CRM_Financial_BAO_PaymentProcessor::getAllPaymentProcessors('test', TRUE);
 141   }
 142
 143   /**
 144    * Sometimes we want to instantiate a processor object when no valid instance exists (eg. when uninstalling a
 145    * processor).
 146    *
 147    * This function does not load instance specific details for the processor.
 148    *
 149    * @param string $className
 150    *
 151    * @return \Civi\Payment\CRM_Core_Payment|NULL
 152    * @throws \CiviCRM_API3_Exception
 153    */
 154   public function getByClass($className) {
 155     return $this->getByProcessor(array(
 156       'class_name' => $className,
 157       'id' => 0,
 158       'is_test' => 0,
 159     ),
 160     TRUE);
 161   }
 162
 163 }