crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Admin/Page/PaymentProcessor.php

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