CRM/Admin/Page/PaymentProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * Page for displaying list of payment processors.
  36  */
  37 class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic {
  38
  39   /**
  40    * The action links that we need to display for the browse screen.
  41    *
  42    * @var array
  43    */
  44   static $_links = NULL;
  45
  46   /**
  47    * Get BAO Name.
  48    *
  49    * @return string
  50    *   Classname of BAO.
  51    */
  52   public function getBAOName() {
  53     return 'CRM_Financial_BAO_PaymentProcessor';
  54   }
  55
  56   /**
  57    * Get action Links.
  58    *
  59    * @return array
  60    *   (reference) of action links
  61    */
  62   public function &links() {
  63     if (!(self::$_links)) {
  64       self::$_links = array(
  65         CRM_Core_Action::UPDATE => array(
  66           'name' => ts('Edit'),
  67           'url' => 'civicrm/admin/paymentProcessor',
  68           'qs' => 'action=update&id=%%id%%&reset=1',
  69           'title' => ts('Edit Payment Processor'),
  70         ),
  71         CRM_Core_Action::DISABLE => array(
  72           'name' => ts('Disable'),
  73           'ref' => 'crm-enable-disable',
  74           'title' => ts('Disable Payment Processor'),
  75         ),
  76         CRM_Core_Action::ENABLE => array(
  77           'name' => ts('Enable'),
  78           'ref' => 'crm-enable-disable',
  79           'title' => ts('Enable Payment Processor'),
  80         ),
  81         CRM_Core_Action::DELETE => array(
  82           'name' => ts('Delete'),
  83           'url' => 'civicrm/admin/paymentProcessor',
  84           'qs' => 'action=delete&id=%%id%%',
  85           'title' => ts('Delete Payment Processor'),
  86         ),
  87       );
  88     }
  89     return self::$_links;
  90   }
  91
  92   /**
  93    * Run the page.
  94    *
  95    * This method is called after the page is created. It checks for the
  96    * type of action and executes that action.
  97    * Finally it calls the parent's run method.
  98    */
  99   public function run() {
 100     // set title and breadcrumb
 101     CRM_Utils_System::setTitle(ts('Settings - Payment Processor'));
 102     //CRM-15546
 103     $paymentProcessorTypes = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_PaymentProcessor', 'payment_processor_type_id', array(
 104         'labelColumn' => 'name',
 105         'flip' => 1,
 106       ));
 107     $this->assign('defaultPaymentProcessorType', $paymentProcessorTypes['PayPal']);
 108     $breadCrumb = array(
 109       array(
 110         'title' => ts('Administration'),
 111         'url' => CRM_Utils_System::url('civicrm/admin',
 112           'reset=1'
 113         ),
 114       ),
 115     );
 116     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 117     return parent::run();
 118   }
 119
 120   /**
 121    * Browse all payment processors.
 122    *
 123    * @param null $action
 124    */
 125   public function browse($action = NULL) {
 126     // get all custom groups sorted by weight
 127     $paymentProcessor = array();
 128     $dao = new CRM_Financial_DAO_PaymentProcessor();
 129     $dao->is_test = 0;
 130     $dao->domain_id = CRM_Core_Config::domainID();
 131     $dao->orderBy('name');
 132     $dao->find();
 133
 134     while ($dao->fetch()) {
 135       $paymentProcessor[$dao->id] = array();
 136       CRM_Core_DAO::storeValues($dao, $paymentProcessor[$dao->id]);
 137       $paymentProcessor[$dao->id]['payment_processor_type'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
 138         $paymentProcessor[$dao->id]['payment_processor_type_id']);
 139
 140       // form all action links
 141       $action = array_sum(array_keys($this->links()));
 142
 143       // update enable/disable links.
 144       if ($dao->is_active) {
 145         $action -= CRM_Core_Action::ENABLE;
 146       }
 147       else {
 148         $action -= CRM_Core_Action::DISABLE;
 149       }
 150
 151       $paymentProcessor[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 152         array('id' => $dao->id),
 153         ts('more'),
 154         FALSE,
 155         'paymentProcessor.manage.action',
 156         'PaymentProcessor',
 157         $dao->id
 158       );
 159       $paymentProcessor[$dao->id]['financialAccount'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($dao->id, NULL, 'civicrm_payment_processor', 'financial_account_id.name');
 160     }
 161
 162     $this->assign('rows', $paymentProcessor);
 163   }
 164
 165   /**
 166    * Get name of edit form.
 167    *
 168    * @return string
 169    *   Classname of edit form.
 170    */
 171   public function editForm() {
 172     return 'CRM_Admin_Form_PaymentProcessor';
 173   }
 174
 175   /**
 176    * Get edit form name.
 177    *
 178    * @return string
 179    *   name of this page.
 180    */
 181   public function editName() {
 182     return 'Payment Processors';
 183   }
 184
 185   /**
 186    * Get user context.
 187    *
 188    * @param null $mode
 189    *
 190    * @return string
 191    *   user context.
 192    */
 193   public function userContext($mode = NULL) {
 194     return 'civicrm/admin/paymentProcessor';
 195   }
 196
 197 }