CRM/Admin/Page/PaymentProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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    * @static
  46    */
  47   static $_links = NULL;
  48
  49   /**
  50    * Get BAO Name
  51    *
  52    * @return string Classname of BAO.
  53    */
  54   function getBAOName() {
  55     return 'CRM_Financial_BAO_PaymentProcessor';
  56   }
  57
  58   /**
  59    * Get action Links
  60    *
  61    * @return array (reference) of action links
  62    */
  63   function &links() {
  64     if (!(self::$_links)) {
  65       self::$_links = array(
  66         CRM_Core_Action::UPDATE => array(
  67           'name' => ts('Edit'),
  68           'url' => 'civicrm/admin/paymentProcessor',
  69           'qs' => 'action=update&id=%%id%%&reset=1',
  70           'title' => ts('Edit Payment Processor'),
  71         ),
  72         CRM_Core_Action::DISABLE => array(
  73           'name' => ts('Disable'),
  74           'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Financial_BAO_PaymentProcessor' . '\',\'' . 'enable-disable' . '\' );"',
  75           'ref' => 'disable-action',
  76           'title' => ts('Disable Payment Processor'),
  77         ),
  78         CRM_Core_Action::ENABLE => array(
  79           'name' => ts('Enable'),
  80           'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Financial_BAO_PaymentProcessor' . '\',\'' . 'disable-enable' . '\' );"',
  81           'ref' => 'enable-action',
  82           'title' => ts('Enable Payment Processor'),
  83         ),
  84         CRM_Core_Action::DELETE => array(
  85           'name' => ts('Delete'),
  86           'url' => 'civicrm/admin/paymentProcessor',
  87           'qs' => 'action=delete&id=%%id%%',
  88           'title' => ts('Delete Payment Processor'),
  89         ),
  90       );
  91     }
  92     return self::$_links;
  93   }
  94
  95   /**
  96    * Run the page.
  97    *
  98    * This method is called after the page is created. It checks for the
  99    * type of action and executes that action.
 100    * Finally it calls the parent's run method.
 101    *
 102    * @return void
 103    * @access public
 104    *
 105    */
 106   function run() {
 107     // set title and breadcrumb
 108     CRM_Utils_System::setTitle(ts('Settings - Payment Processor'));
 109     $breadCrumb = array(array('title' => ts('Administration'),
 110         'url' => CRM_Utils_System::url('civicrm/admin',
 111         'reset=1'
 112         ),
 113       ));
 114     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 115     return parent::run();
 116   }
 117
 118   /**
 119    * Browse all payment processors.
 120    *
 121    * @return void
 122    * @access public
 123    * @static
 124    */
 125   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       );
 154       $paymentProcessor[$dao->id]['financialAccount'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($dao->id, 'civicrm_payment_processor');
 155     }
 156
 157     $this->assign('rows', $paymentProcessor);
 158   }
 159
 160   /**
 161    * Get name of edit form
 162    *
 163    * @return string Classname of edit form.
 164    */
 165   function editForm() {
 166     return 'CRM_Admin_Form_PaymentProcessor';
 167   }
 168
 169   /**
 170    * Get edit form name
 171    *
 172    * @return string name of this page.
 173    */
 174   function editName() {
 175     return 'Payment Processors';
 176   }
 177
 178   /**
 179    * Get user context.
 180    *
 181    * @return string user context.
 182    */
 183   function userContext($mode = NULL) {
 184     return 'civicrm/admin/paymentProcessor';
 185   }
 186 }
 187