further comment fixes
[civicrm-core.git] / CRM / Admin / Page / PaymentProcessor.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
7e9e8871 4 | CiviCRM version 4.7 |
6a488035 5 +--------------------------------------------------------------------+
e7112fa7 6 | Copyright CiviCRM LLC (c) 2004-2015 |
6a488035
TO
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * @package CRM
e7112fa7 31 * @copyright CiviCRM LLC (c) 2004-2015
6a488035
TO
32 */
33
34/**
ce064e4f 35 * Page for displaying list of payment processors.
6a488035
TO
36 */
37class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic {
38
39 /**
eceb18cc 40 * The action links that we need to display for the browse screen.
6a488035
TO
41 *
42 * @var array
6a488035
TO
43 */
44 static $_links = NULL;
45
46 /**
eceb18cc 47 * Get BAO Name.
6a488035 48 *
a6c01b45
CW
49 * @return string
50 * Classname of BAO.
6a488035 51 */
00be9182 52 public function getBAOName() {
6a488035
TO
53 return 'CRM_Financial_BAO_PaymentProcessor';
54 }
55
56 /**
eceb18cc 57 * Get action Links.
6a488035 58 *
a6c01b45
CW
59 * @return array
60 * (reference) of action links
6a488035 61 */
00be9182 62 public function &links() {
6a488035
TO
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'),
4d17a233 73 'ref' => 'crm-enable-disable',
6a488035
TO
74 'title' => ts('Disable Payment Processor'),
75 ),
76 CRM_Core_Action::ENABLE => array(
77 'name' => ts('Enable'),
4d17a233 78 'ref' => 'crm-enable-disable',
6a488035
TO
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.
6a488035 98 */
00be9182 99 public function run() {
6a488035
TO
100 // set title and breadcrumb
101 CRM_Utils_System::setTitle(ts('Settings - Payment Processor'));
71d085fe 102 //CRM-15546
353ffa53
TO
103 $paymentProcessorTypes = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_PaymentProcessor', 'payment_processor_type_id', array(
104 'labelColumn' => 'name',
389bcebf 105 'flip' => 1,
353ffa53 106 ));
71d085fe 107 $this->assign('defaultPaymentProcessorType', $paymentProcessorTypes['PayPal']);
353ffa53
TO
108 $breadCrumb = array(
109 array(
110 'title' => ts('Administration'),
6a488035 111 'url' => CRM_Utils_System::url('civicrm/admin',
353ffa53 112 'reset=1'
6a488035 113 ),
389bcebf 114 ),
353ffa53 115 );
6a488035
TO
116 CRM_Utils_System::appendBreadCrumb($breadCrumb);
117 return parent::run();
118 }
119
120 /**
121 * Browse all payment processors.
122 *
77b97be7 123 * @param null $action
6a488035 124 */
00be9182 125 public function browse($action = NULL) {
6a488035
TO
126 // get all custom groups sorted by weight
127 $paymentProcessor = array();
128 $dao = new CRM_Financial_DAO_PaymentProcessor();
353ffa53
TO
129 $dao->is_test = 0;
130 $dao->domain_id = CRM_Core_Config::domainID();
6a488035
TO
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]);
8ef12e64 137 $paymentProcessor[$dao->id]['payment_processor_type'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
6a488035
TO
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,
87dab4a4
AH
152 array('id' => $dao->id),
153 ts('more'),
154 FALSE,
155 'paymentProcessor.manage.action',
156 'PaymentProcessor',
157 $dao->id
6a488035 158 );
8ef12e64 159 $paymentProcessor[$dao->id]['financialAccount'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($dao->id, 'civicrm_payment_processor');
6a488035
TO
160 }
161
162 $this->assign('rows', $paymentProcessor);
163 }
164
165 /**
eceb18cc 166 * Get name of edit form.
6a488035 167 *
a6c01b45
CW
168 * @return string
169 * Classname of edit form.
6a488035 170 */
00be9182 171 public function editForm() {
6a488035
TO
172 return 'CRM_Admin_Form_PaymentProcessor';
173 }
174
175 /**
eceb18cc 176 * Get edit form name.
6a488035 177 *
a6c01b45
CW
178 * @return string
179 * name of this page.
6a488035 180 */
00be9182 181 public function editName() {
6a488035
TO
182 return 'Payment Processors';
183 }
184
185 /**
186 * Get user context.
187 *
da6b46f4
EM
188 * @param null $mode
189 *
a6c01b45
CW
190 * @return string
191 * user context.
6a488035 192 */
00be9182 193 public function userContext($mode = NULL) {
6a488035
TO
194 return 'civicrm/admin/paymentProcessor';
195 }
96025800 196
6a488035 197}