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