| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 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-2014 |
| 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 | public 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 | public 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 | * |
| 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('labelColumn' => 'name', 'flip' => 1)); |
| 108 | $this->assign('defaultPaymentProcessorType', $paymentProcessorTypes['PayPal']); |
| 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 | * @param null $action |
| 122 | * |
| 123 | * @return void |
| 124 | * @static |
| 125 | */ |
| 126 | public function browse($action = NULL) { |
| 127 | // get all custom groups sorted by weight |
| 128 | $paymentProcessor = array(); |
| 129 | $dao = new CRM_Financial_DAO_PaymentProcessor(); |
| 130 | $dao->is_test = 0; |
| 131 | $dao->domain_id = CRM_Core_Config::domainID(); |
| 132 | $dao->orderBy('name'); |
| 133 | $dao->find(); |
| 134 | |
| 135 | while ($dao->fetch()) { |
| 136 | $paymentProcessor[$dao->id] = array(); |
| 137 | CRM_Core_DAO::storeValues($dao, $paymentProcessor[$dao->id]); |
| 138 | $paymentProcessor[$dao->id]['payment_processor_type'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', |
| 139 | $paymentProcessor[$dao->id]['payment_processor_type_id']); |
| 140 | |
| 141 | // form all action links |
| 142 | $action = array_sum(array_keys($this->links())); |
| 143 | |
| 144 | // update enable/disable links. |
| 145 | if ($dao->is_active) { |
| 146 | $action -= CRM_Core_Action::ENABLE; |
| 147 | } |
| 148 | else { |
| 149 | $action -= CRM_Core_Action::DISABLE; |
| 150 | } |
| 151 | |
| 152 | $paymentProcessor[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action, |
| 153 | array('id' => $dao->id), |
| 154 | ts('more'), |
| 155 | FALSE, |
| 156 | 'paymentProcessor.manage.action', |
| 157 | 'PaymentProcessor', |
| 158 | $dao->id |
| 159 | ); |
| 160 | $paymentProcessor[$dao->id]['financialAccount'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($dao->id, 'civicrm_payment_processor'); |
| 161 | } |
| 162 | |
| 163 | $this->assign('rows', $paymentProcessor); |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Get name of edit form |
| 168 | * |
| 169 | * @return string 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 name of this page. |
| 179 | */ |
| 180 | public function editName() { |
| 181 | return 'Payment Processors'; |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Get user context. |
| 186 | * |
| 187 | * @param null $mode |
| 188 | * |
| 189 | * @return string user context. |
| 190 | */ |
| 191 | public function userContext($mode = NULL) { |
| 192 | return 'civicrm/admin/paymentProcessor'; |
| 193 | } |
| 194 | } |