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           'ref' => 'crm-enable-disable',
  75           'title' => ts('Disable Payment Processor'),
  76         ),
  77         CRM_Core_Action::ENABLE => array(
  78           'name' => ts('Enable'),
  79           'ref' => 'crm-enable-disable',
  80           'title' => ts('Enable Payment Processor'),
  81         ),
  82         CRM_Core_Action::DELETE => array(
  83           'name' => ts('Delete'),
  84           'url' => 'civicrm/admin/paymentProcessor',
  85           'qs' => 'action=delete&id=%%id%%',
  86           'title' => ts('Delete Payment Processor'),
  87         ),
  88       );
  89     }
  90     return self::$_links;
  91   }
  92
  93   /**
  94    * Run the page.
  95    *
  96    * This method is called after the page is created. It checks for the
  97    * type of action and executes that action.
  98    * Finally it calls the parent's run method.
  99    *
 100    * @return void
 101    * @access public
 102    *
 103    */
 104   function run() {
 105     // set title and breadcrumb
 106     CRM_Utils_System::setTitle(ts('Settings - Payment Processor'));
 107     $breadCrumb = array(array('title' => ts('Administration'),
 108         'url' => CRM_Utils_System::url('civicrm/admin',
 109         'reset=1'
 110         ),
 111       ));
 112     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 113     return parent::run();
 114   }
 115
 116   /**
 117    * Browse all payment processors.
 118    *
 119    * @return void
 120    * @access public
 121    * @static
 122    */
 123   function browse($action = NULL) {
 124     // get all custom groups sorted by weight
 125     $paymentProcessor = array();
 126     $dao = new CRM_Financial_DAO_PaymentProcessor();
 127     $dao->is_test     = 0;
 128     $dao->domain_id   = CRM_Core_Config::domainID();
 129     $dao->orderBy('name');
 130     $dao->find();
 131
 132     while ($dao->fetch()) {
 133       $paymentProcessor[$dao->id] = array();
 134       CRM_Core_DAO::storeValues($dao, $paymentProcessor[$dao->id]);
 135       $paymentProcessor[$dao->id]['payment_processor_type'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
 136         $paymentProcessor[$dao->id]['payment_processor_type_id']);
 137
 138       // form all action links
 139       $action = array_sum(array_keys($this->links()));
 140
 141       // update enable/disable links.
 142       if ($dao->is_active) {
 143         $action -= CRM_Core_Action::ENABLE;
 144       }
 145       else {
 146         $action -= CRM_Core_Action::DISABLE;
 147       }
 148
 149       $paymentProcessor[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 150         array('id' => $dao->id),
 151         ts('more'),
 152         FALSE,
 153         'paymentProcessor.manage.action',
 154         'PaymentProcessor',
 155         $dao->id
 156       );
 157       $paymentProcessor[$dao->id]['financialAccount'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($dao->id, 'civicrm_payment_processor');
 158     }
 159
 160     $this->assign('rows', $paymentProcessor);
 161   }
 162
 163   /**
 164    * Get name of edit form
 165    *
 166    * @return string Classname of edit form.
 167    */
 168   function editForm() {
 169     return 'CRM_Admin_Form_PaymentProcessor';
 170   }
 171
 172   /**
 173    * Get edit form name
 174    *
 175    * @return string name of this page.
 176    */
 177   function editName() {
 178     return 'Payment Processors';
 179   }
 180
 181   /**
 182    * Get user context.
 183    *
 184    * @return string user context.
 185    */
 186   function userContext($mode = NULL) {
 187     return 'civicrm/admin/paymentProcessor';
 188   }
 189 }
 190