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 | /** | |
ce064e4f | 35 | * Page for displaying list of Gender. |
6a488035 TO |
36 | */ |
37 | class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { | |
38 | ||
96f50de2 CW |
39 | public $useLivePageJS = TRUE; |
40 | ||
6a488035 | 41 | /** |
eceb18cc | 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 | /** | |
eceb18cc | 49 | * The option group name. |
6a488035 TO |
50 | * |
51 | * @var array | |
6a488035 TO |
52 | */ |
53 | static $_gName = NULL; | |
54 | ||
55 | /** | |
56 | * The option group name in display format (capitalized, without underscores...etc) | |
57 | * | |
58 | * @var array | |
6a488035 | 59 | */ |
6c2473d5 | 60 | static $_gLabel = NULL; |
6a488035 TO |
61 | |
62 | /** | |
eceb18cc | 63 | * The option group id. |
6a488035 TO |
64 | * |
65 | * @var array | |
6a488035 TO |
66 | */ |
67 | static $_gId = NULL; | |
68 | ||
cede6590 | 69 | /** |
eceb18cc | 70 | * A boolean determining if you can add options to this group in the GUI. |
cede6590 DG |
71 | * |
72 | * @var boolean | |
cede6590 DG |
73 | */ |
74 | static $_isLocked = FALSE; | |
75 | ||
6a488035 | 76 | /** |
6c2473d5 | 77 | * Obtains the group name from url string or id from $_GET['gid']. |
6a488035 | 78 | * |
ce064e4f | 79 | * Sets the title. |
6a488035 | 80 | */ |
00be9182 | 81 | public function preProcess() { |
6c2473d5 CW |
82 | if (!self::$_gName && !empty($this->urlPath[3])) { |
83 | self::$_gName = $this->urlPath[3]; | |
de8974c3 | 84 | self::$_isLocked = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gName, 'is_locked', 'name'); |
6a488035 | 85 | } |
6c2473d5 CW |
86 | // If an id arg is passed instead of a group name in the path |
87 | elseif (!self::$_gName && !empty($_GET['gid'])) { | |
88 | self::$_gId = $_GET['gid']; | |
89 | self::$_gName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gId, 'name'); | |
cede6590 | 90 | self::$_isLocked = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gId, 'is_locked'); |
6c2473d5 CW |
91 | $breadCrumb = array( |
92 | 'title' => ts('Option Groups'), | |
93 | 'url' => CRM_Utils_System::url('civicrm/admin/options', 'reset=1'), | |
94 | ); | |
95 | CRM_Utils_System::appendBreadCrumb(array($breadCrumb)); | |
6a488035 | 96 | } |
6c2473d5 | 97 | if (!self::$_gName) { |
6a488035 TO |
98 | self::$_gName = $this->get('gName'); |
99 | } | |
6c2473d5 CW |
100 | // If we don't have a group we will browse all groups |
101 | if (!self::$_gName) { | |
102 | return; | |
6a488035 | 103 | } |
6c2473d5 CW |
104 | $this->set('gName', self::$_gName); |
105 | if (!self::$_gId) { | |
106 | self::$_gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gName, 'id', 'name'); | |
6a488035 TO |
107 | } |
108 | ||
6c2473d5 CW |
109 | self::$_gLabel = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gId, 'title'); |
110 | if (!self::$_gLabel) { | |
111 | self::$_gLabel = ts('Option'); | |
112 | } | |
6a488035 TO |
113 | |
114 | $this->assign('gName', self::$_gName); | |
6c2473d5 | 115 | $this->assign('gLabel', self::$_gLabel); |
6a488035 TO |
116 | |
117 | if (self::$_gName == 'acl_role') { | |
118 | CRM_Utils_System::setTitle(ts('Manage ACL Roles')); | |
119 | // set breadcrumb to append to admin/access | |
353ffa53 TO |
120 | $breadCrumb = array( |
121 | array( | |
122 | 'title' => ts('Access Control'), | |
6a488035 TO |
123 | 'url' => CRM_Utils_System::url('civicrm/admin/access', |
124 | 'reset=1' | |
125 | ), | |
389bcebf | 126 | ), |
353ffa53 | 127 | ); |
6a488035 TO |
128 | CRM_Utils_System::appendBreadCrumb($breadCrumb); |
129 | } | |
130 | else { | |
6c2473d5 | 131 | CRM_Utils_System::setTitle(ts("%1 Options", array(1 => self::$_gLabel))); |
6a488035 TO |
132 | } |
133 | if (in_array(self::$_gName, | |
353ffa53 TO |
134 | array( |
135 | 'from_email_address', | |
136 | 'email_greeting', | |
137 | 'postal_greeting', | |
138 | 'addressee', | |
139 | 'communication_style', | |
140 | 'case_status', | |
141 | 'encounter_medium', | |
142 | 'case_type', | |
143 | 'payment_instrument', | |
144 | 'soft_credit_type', | |
145 | 'website_type', | |
146 | ) | |
147 | )) { | |
6a488035 TO |
148 | $this->assign('showIsDefault', TRUE); |
149 | } | |
6a488035 TO |
150 | |
151 | if (self::$_gName == 'participant_role') { | |
152 | $this->assign('showCounted', TRUE); | |
153 | } | |
cede6590 | 154 | $this->assign('isLocked', self::$_isLocked); |
46a41ec5 | 155 | $this->assign('allowLoggedIn', Civi::settings()->get('allow_mail_from_logged_in_contact')); |
6a488035 TO |
156 | $config = CRM_Core_Config::singleton(); |
157 | if (self::$_gName == 'activity_type') { | |
158 | $this->assign('showComponent', TRUE); | |
159 | } | |
160 | } | |
161 | ||
162 | /** | |
eceb18cc | 163 | * Get BAO Name. |
6a488035 | 164 | * |
a6c01b45 CW |
165 | * @return string |
166 | * Classname of BAO. | |
6a488035 | 167 | */ |
00be9182 | 168 | public function getBAOName() { |
6c2473d5 | 169 | return self::$_gName ? 'CRM_Core_BAO_OptionValue' : 'CRM_Core_BAO_OptionGroup'; |
6a488035 TO |
170 | } |
171 | ||
172 | /** | |
eceb18cc | 173 | * Get action Links. |
6a488035 | 174 | * |
a6c01b45 CW |
175 | * @return array |
176 | * (reference) of action links | |
6a488035 | 177 | */ |
00be9182 | 178 | public function &links() { |
6a488035 TO |
179 | if (!(self::$_links)) { |
180 | self::$_links = array( | |
181 | CRM_Core_Action::UPDATE => array( | |
182 | 'name' => ts('Edit'), | |
5c3522e8 | 183 | 'url' => 'civicrm/admin/options/' . self::$_gName, |
118e964e | 184 | 'qs' => 'action=update&id=%%id%%&reset=1', |
6a488035 TO |
185 | 'title' => ts('Edit %1', array(1 => self::$_gName)), |
186 | ), | |
187 | CRM_Core_Action::DISABLE => array( | |
188 | 'name' => ts('Disable'), | |
5e7dd082 | 189 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
190 | 'title' => ts('Disable %1', array(1 => self::$_gName)), |
191 | ), | |
192 | CRM_Core_Action::ENABLE => array( | |
193 | 'name' => ts('Enable'), | |
5e7dd082 | 194 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
195 | 'title' => ts('Enable %1', array(1 => self::$_gName)), |
196 | ), | |
197 | CRM_Core_Action::DELETE => array( | |
198 | 'name' => ts('Delete'), | |
5c3522e8 | 199 | 'url' => 'civicrm/admin/options/' . self::$_gName, |
118e964e | 200 | 'qs' => 'action=delete&id=%%id%%', |
6a488035 TO |
201 | 'title' => ts('Delete %1 Type', array(1 => self::$_gName)), |
202 | ), | |
203 | ); | |
204 | ||
205 | if (self::$_gName == 'custom_search') { | |
206 | $runLink = array( | |
207 | CRM_Core_Action::FOLLOWUP => array( | |
208 | 'name' => ts('Run'), | |
209 | 'url' => 'civicrm/contact/search/custom', | |
210 | 'qs' => 'reset=1&csid=%%value%%', | |
211 | 'title' => ts('Run %1', array(1 => self::$_gName)), | |
a9f247da | 212 | 'class' => 'no-popup', |
389bcebf | 213 | ), |
353ffa53 | 214 | ); |
6a488035 TO |
215 | self::$_links = $runLink + self::$_links; |
216 | } | |
217 | } | |
218 | return self::$_links; | |
219 | } | |
220 | ||
221 | /** | |
222 | * Run the basic page (run essentially starts execution for that page). | |
6a488035 | 223 | */ |
00be9182 | 224 | public function run() { |
6a488035 TO |
225 | $this->preProcess(); |
226 | return parent::run(); | |
227 | } | |
228 | ||
229 | /** | |
eceb18cc | 230 | * Browse all options. |
6a488035 | 231 | */ |
00be9182 | 232 | public function browse() { |
6c2473d5 CW |
233 | if (!self::$_gName) { |
234 | return parent::browse(); | |
235 | } | |
6a488035 TO |
236 | $groupParams = array('name' => self::$_gName); |
237 | $optionValue = CRM_Core_OptionValue::getRows($groupParams, $this->links(), 'component_id,weight'); | |
353ffa53 TO |
238 | $gName = self::$_gName; |
239 | $returnURL = CRM_Utils_System::url("civicrm/admin/options/$gName", | |
6a488035 TO |
240 | "reset=1&group=$gName" |
241 | ); | |
242 | $filter = "option_group_id = " . self::$_gId; | |
243 | CRM_Utils_Weight::addOrder($optionValue, 'CRM_Core_DAO_OptionValue', | |
244 | 'id', $returnURL, $filter | |
245 | ); | |
246 | ||
536f0e02 | 247 | // retrieve financial account name for the payment method page |
6a488035 | 248 | if ($gName = "payment_instrument") { |
02fc859b | 249 | foreach ($optionValue as $key => $option) { |
74afdc40 | 250 | $optionValue[$key]['financial_account'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($key, NULL, 'civicrm_option_value', 'financial_account_id.name'); |
6eafcb19 | 251 | } |
6a488035 | 252 | } |
6a488035 TO |
253 | $this->assign('rows', $optionValue); |
254 | } | |
255 | ||
256 | /** | |
eceb18cc | 257 | * Get name of edit form. |
6a488035 | 258 | * |
a6c01b45 CW |
259 | * @return string |
260 | * Classname of edit form. | |
6a488035 | 261 | */ |
00be9182 | 262 | public function editForm() { |
6c2473d5 | 263 | return self::$_gName ? 'CRM_Admin_Form_Options' : 'CRM_Admin_Form_OptionGroup'; |
6a488035 TO |
264 | } |
265 | ||
266 | /** | |
eceb18cc | 267 | * Get edit form name. |
6a488035 | 268 | * |
a6c01b45 CW |
269 | * @return string |
270 | * name of this page. | |
6a488035 | 271 | */ |
00be9182 | 272 | public function editName() { |
6c2473d5 | 273 | return self::$_gLabel; |
6a488035 TO |
274 | } |
275 | ||
276 | /** | |
277 | * Get user context. | |
278 | * | |
dd244018 EM |
279 | * @param null $mode |
280 | * | |
a6c01b45 CW |
281 | * @return string |
282 | * user context. | |
6a488035 | 283 | */ |
00be9182 | 284 | public function userContext($mode = NULL) { |
6c2473d5 | 285 | return 'civicrm/admin/options' . (self::$_gName ? '/' . self::$_gName : ''); |
6a488035 | 286 | } |
96025800 | 287 | |
6a488035 | 288 | } |