Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Page for displaying list of Providers | |
38 | */ | |
39 | class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic { | |
40 | ||
96f50de2 CW |
41 | public $useLivePageJS = TRUE; |
42 | ||
6a488035 TO |
43 | /** |
44 | * The action links that we need to display for the browse screen | |
45 | * | |
46 | * @var array | |
47 | * @static | |
48 | */ | |
49 | static $_links = NULL; | |
50 | ||
51 | /** | |
52 | * Get BAO Name | |
53 | * | |
54 | * @return string Classname of BAO. | |
55 | */ | |
00be9182 | 56 | public function getBAOName() { |
6a488035 TO |
57 | return 'CRM_SMS_BAO_Provider'; |
58 | } | |
59 | ||
60 | /** | |
61 | * Get action Links | |
62 | * | |
63 | * @return array (reference) of action links | |
64 | */ | |
00be9182 | 65 | public function &links() { |
6a488035 TO |
66 | if (!(self::$_links)) { |
67 | self::$_links = array( | |
68 | CRM_Core_Action::UPDATE => array( | |
69 | 'name' => ts('Edit'), | |
70 | 'url' => 'civicrm/admin/sms/provider', | |
71 | 'qs' => 'action=update&id=%%id%%&reset=1', | |
72 | 'title' => ts('Edit Provider'), | |
73 | ), | |
74 | CRM_Core_Action::DELETE => array( | |
75 | 'name' => ts('Delete'), | |
76 | 'url' => 'civicrm/admin/sms/provider', | |
77 | 'qs' => 'action=delete&id=%%id%%', | |
78 | 'title' => ts('Delete Provider'), | |
79 | ), | |
80 | CRM_Core_Action::ENABLE => array( | |
81 | 'name' => ts('Enable'), | |
4d17a233 | 82 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
83 | 'title' => ts('Enable Provider'), |
84 | ), | |
85 | CRM_Core_Action::DISABLE => array( | |
86 | 'name' => ts('Disable'), | |
4d17a233 | 87 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
88 | 'title' => ts('Disable Provider'), |
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 | |
6a488035 TO |
103 | * |
104 | */ | |
00be9182 | 105 | public function run() { |
6a488035 TO |
106 | // set title and breadcrumb |
107 | CRM_Utils_System::setTitle(ts('Settings - SMS Provider')); | |
108 | $breadCrumb = array(array('title' => ts('SMS Provider'), | |
109 | 'url' => CRM_Utils_System::url('civicrm/admin/sms/provider', | |
110 | 'reset=1' | |
111 | ), | |
112 | )); | |
113 | CRM_Utils_System::appendBreadCrumb($breadCrumb); | |
114 | ||
115 | $this->_id = CRM_Utils_Request::retrieve('id', 'String', | |
116 | $this, FALSE, 0 | |
117 | ); | |
118 | $this->_action = CRM_Utils_Request::retrieve('action', 'String', | |
119 | $this, FALSE, 0 | |
120 | ); | |
121 | ||
122 | return parent::run(); | |
123 | } | |
124 | ||
125 | /** | |
126 | * Browse all Providers. | |
127 | * | |
fd31fa4c EM |
128 | * @param null $action |
129 | * | |
6a488035 | 130 | * @return void |
6a488035 TO |
131 | * @static |
132 | */ | |
00be9182 | 133 | public function browse($action = NULL) { |
6a488035 TO |
134 | $providers = CRM_SMS_BAO_Provider::getProviders(); |
135 | $rows = array(); | |
136 | foreach ($providers as $provider) { | |
137 | $action = array_sum(array_keys($this->links())); | |
138 | // update enable/disable links. | |
139 | if ($provider['is_active']) { | |
140 | $action -= CRM_Core_Action::ENABLE; | |
141 | } | |
142 | else { | |
143 | $action -= CRM_Core_Action::DISABLE; | |
144 | } | |
145 | ||
146 | $apiTypes = CRM_Core_OptionGroup::values('sms_api_type', FALSE, FALSE, FALSE, NULL, 'label'); | |
147 | $provider['api_type'] = $apiTypes[$provider['api_type']]; | |
148 | ||
149 | $provider['action'] = CRM_Core_Action::formLink(self::links(), $action, | |
87dab4a4 AH |
150 | array('id' => $provider['id']), |
151 | ts('more'), | |
152 | FALSE, | |
153 | 'sms.provider.row', | |
154 | 'SMSProvider', | |
155 | $provider['id'] | |
6a488035 TO |
156 | ); |
157 | $rows[] = $provider; | |
158 | } | |
159 | $this->assign('rows', $rows); | |
160 | } | |
161 | ||
162 | /** | |
163 | * Get name of edit form | |
164 | * | |
165 | * @return string Classname of edit form. | |
166 | */ | |
00be9182 | 167 | public function editForm() { |
6a488035 TO |
168 | return 'CRM_SMS_Form_Provider'; |
169 | } | |
170 | ||
171 | /** | |
172 | * Get edit form name | |
173 | * | |
174 | * @return string name of this page. | |
175 | */ | |
00be9182 | 176 | public function editName() { |
6a488035 TO |
177 | return 'SMS Provider'; |
178 | } | |
179 | ||
180 | /** | |
181 | * Get user context. | |
182 | * | |
da6b46f4 EM |
183 | * @param null $mode |
184 | * | |
6a488035 TO |
185 | * @return string user context. |
186 | */ | |
00be9182 | 187 | public function userContext($mode = NULL) { |
6a488035 TO |
188 | return 'civicrm/admin/sms/provider'; |
189 | } | |
190 | } |