3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Page for displaying list of Gender.
21 class CRM_Admin_Page_Options
extends CRM_Core_Page_Basic
{
23 public $useLivePageJS = TRUE;
26 * The action links that we need to display for the browse screen.
30 public static $_links = NULL;
33 * The option group name.
37 public static $_gName = NULL;
40 * The option group name in display format (capitalized, without underscores...etc)
44 public static $_gLabel = NULL;
47 * The option group id.
51 public static $_gId = NULL;
54 * A boolean determining if you can add options to this group in the GUI.
58 public static $_isLocked = FALSE;
61 * Obtains the group name from url string or id from $_GET['gid'].
65 public function preProcess() {
66 if (!self
::$_gName && !empty($this->urlPath
[3])) {
67 self
::$_gName = $this->urlPath
[3];
68 self
::$_isLocked = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gName, 'is_locked', 'name');
70 // If an id arg is passed instead of a group name in the path
71 elseif (!self
::$_gName && !empty($_GET['gid'])) {
72 self
::$_gId = (int) $_GET['gid'];
73 self
::$_gName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gId, 'name');
74 self
::$_isLocked = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gId, 'is_locked');
76 'title' => ts('Option Groups'),
77 'url' => CRM_Utils_System
::url('civicrm/admin/options', 'reset=1'),
79 CRM_Utils_System
::appendBreadCrumb([$breadCrumb]);
82 self
::$_gName = $this->get('gName');
84 // If we don't have a group we will browse all groups
88 $this->set('gName', self
::$_gName);
90 self
::$_gId = (int) CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gName, 'id', 'name');
93 self
::$_gLabel = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gId, 'title');
94 if (!self
::$_gLabel) {
95 self
::$_gLabel = ts('Option');
98 if (self
::$_gName == 'acl_role') {
99 CRM_Utils_System
::setTitle(ts('Manage ACL Roles'));
100 // set breadcrumb to append to admin/access
103 'title' => ts('Access Control'),
104 'url' => CRM_Utils_System
::url('civicrm/admin/access', 'reset=1'),
107 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
110 CRM_Utils_System
::setTitle(ts("%1 Options", [1 => self
::$_gLabel]));
112 $this->assign('showIsDefault', in_array(self
::$_gName,
114 'from_email_address',
118 'communication_style',
122 'payment_instrument',
128 $this->assign('showCounted', self
::$_gName === 'participant_role');
129 $this->assign('isLocked', self
::$_isLocked);
130 $this->assign('allowLoggedIn', Civi
::settings()->get('allow_mail_from_logged_in_contact'));
131 $this->assign('showComponent', self
::$_gName === 'activity_type');
132 $this->assign('gName', self
::$_gName);
133 $this->assign('gLabel', self
::$_gLabel);
142 public function getBAOName() {
143 return self
::$_gName ?
'CRM_Core_BAO_OptionValue' : 'CRM_Core_BAO_OptionGroup';
150 * (reference) of action links
152 public function &links() {
153 if (!self
::$_links) {
155 CRM_Core_Action
::UPDATE
=> [
156 'name' => ts('Edit'),
157 'url' => 'civicrm/admin/options/' . self
::$_gName,
158 'qs' => 'action=update&id=%%id%%&reset=1',
159 'title' => ts('Edit %1', [1 => self
::$_gName]),
161 CRM_Core_Action
::DISABLE
=> [
162 'name' => ts('Disable'),
163 'ref' => 'crm-enable-disable',
164 'title' => ts('Disable %1', [1 => self
::$_gName]),
166 CRM_Core_Action
::ENABLE
=> [
167 'name' => ts('Enable'),
168 'ref' => 'crm-enable-disable',
169 'title' => ts('Enable %1', [1 => self
::$_gName]),
171 CRM_Core_Action
::DELETE
=> [
172 'name' => ts('Delete'),
173 'url' => 'civicrm/admin/options/' . self
::$_gName,
174 'qs' => 'action=delete&id=%%id%%',
175 'title' => ts('Delete %1 Type', [1 => self
::$_gName]),
179 if (self
::$_gName == 'custom_search') {
181 CRM_Core_Action
::FOLLOWUP
=> [
183 'url' => 'civicrm/contact/search/custom',
184 'qs' => 'reset=1&csid=%%value%%',
185 'title' => ts('Run %1', [1 => self
::$_gName]),
186 'class' => 'no-popup',
189 self
::$_links = $runLink + self
::$_links;
192 return self
::$_links;
196 * Run the basic page (run essentially starts execution for that page).
198 public function run() {
200 return parent
::run();
204 * Browse all options.
206 public function browse() {
207 if (!self
::$_gName) {
208 return parent
::browse();
210 $groupParams = ['name' => self
::$_gName];
211 $optionValue = CRM_Core_OptionValue
::getRows($groupParams, $this->links(), 'component_id,weight');
212 $gName = self
::$_gName;
213 $returnURL = CRM_Utils_System
::url("civicrm/admin/options/$gName",
214 "reset=1&group=$gName"
216 $filter = "option_group_id = " . self
::$_gId;
217 CRM_Utils_Weight
::addOrder($optionValue, 'CRM_Core_DAO_OptionValue',
218 'id', $returnURL, $filter
220 $this->assign('hasIcons', FALSE);
222 // retrieve financial account name for the payment method page
223 foreach ($optionValue as $key => $option) {
224 if ($gName === 'payment_instrument') {
225 $optionValue[$key]['financial_account'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($key, NULL, 'civicrm_option_value', 'financial_account_id.name');
227 foreach (['weight', 'description', 'value', 'color', 'label', 'is_default', 'icon'] as $expectedKey) {
228 if (!array_key_exists($expectedKey, $option)) {
229 $optionValue[$key][$expectedKey] = NULL;
232 if ($option['icon']) {
233 $this->assign('hasIcons', TRUE);
236 $this->assign('rows', $optionValue);
240 * Get name of edit form.
243 * Classname of edit form.
245 public function editForm() {
246 return self
::$_gName ?
'CRM_Admin_Form_Options' : 'CRM_Admin_Form_OptionGroup';
250 * Get edit form name.
255 public function editName() {
256 return self
::$_gLabel;
267 public function userContext($mode = NULL) {
268 return 'civicrm/admin/options' . (self
::$_gName ?
'/' . self
::$_gName : '');