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