3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Page for displaying list of Gender
39 class CRM_Admin_Page_Options
extends CRM_Core_Page_Basic
{
41 public $useLivePageJS = TRUE;
44 * The action links that we need to display for the browse screen
49 static $_links = NULL;
52 * The option group name
57 static $_gName = NULL;
60 * The option group name in display format (capitalized, without underscores...etc)
65 static $_gLabel = NULL;
76 * A boolean determining if you can add options to this group in the GUI
81 static $_isLocked = FALSE;
84 * Obtains the group name from url string or id from $_GET['gid'].
91 function preProcess() {
92 if (!self
::$_gName && !empty($this->urlPath
[3])) {
93 self
::$_gName = $this->urlPath
[3];
95 // If an id arg is passed instead of a group name in the path
96 elseif (!self
::$_gName && !empty($_GET['gid'])) {
97 self
::$_gId = $_GET['gid'];
98 self
::$_gName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gId, 'name');
99 self
::$_isLocked = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gId, 'is_locked');
101 'title' => ts('Option Groups'),
102 'url' => CRM_Utils_System
::url('civicrm/admin/options', 'reset=1'),
104 CRM_Utils_System
::appendBreadCrumb(array($breadCrumb));
106 if (!self
::$_gName) {
107 self
::$_gName = $this->get('gName');
109 // If we don't have a group we will browse all groups
110 if (!self
::$_gName) {
113 $this->set('gName', self
::$_gName);
115 self
::$_gId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gName, 'id', 'name');
118 self
::$_gLabel = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', self
::$_gId, 'title');
119 if (!self
::$_gLabel) {
120 self
::$_gLabel = ts('Option');
123 $this->assign('gName', self
::$_gName);
124 $this->assign('gLabel', self
::$_gLabel);
126 if (self
::$_gName == 'acl_role') {
127 CRM_Utils_System
::setTitle(ts('Manage ACL Roles'));
128 // set breadcrumb to append to admin/access
129 $breadCrumb = array(array('title' => ts('Access Control'),
130 'url' => CRM_Utils_System
::url('civicrm/admin/access',
134 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
137 CRM_Utils_System
::setTitle(ts("%1 Options", array(1 => self
::$_gLabel)));
139 if (in_array(self
::$_gName,
141 'from_email_address', 'email_greeting',
142 'postal_greeting', 'addressee',
143 'communication_style',
144 'case_status', 'encounter_medium',
145 'case_type', 'payment_instrument',
146 'soft_credit_type', 'website_type'
149 $this->assign('showIsDefault', TRUE);
151 if (self
::$_gName == 'participant_status') {
152 $this->assign('showCounted', TRUE);
153 $this->assign('showVisibility', TRUE);
156 if (self
::$_gName == 'participant_role') {
157 $this->assign('showCounted', TRUE);
159 $this->assign('isLocked', self
::$_isLocked);
160 $config = CRM_Core_Config
::singleton();
161 if (self
::$_gName == 'activity_type') {
162 $this->assign('showComponent', TRUE);
169 * @return string Classname of BAO.
171 function getBAOName() {
172 return self
::$_gName ?
'CRM_Core_BAO_OptionValue' : 'CRM_Core_BAO_OptionGroup';
178 * @return array (reference) of action links
181 if (!(self
::$_links)) {
182 self
::$_links = array(
183 CRM_Core_Action
::UPDATE
=> array(
184 'name' => ts('Edit'),
185 'url' => 'civicrm/admin/options/' . self
::$_gName,
186 'qs' => 'action=update&id=%%id%%&reset=1',
187 'title' => ts('Edit %1', array(1 => self
::$_gName)),
189 CRM_Core_Action
::DISABLE
=> array(
190 'name' => ts('Disable'),
191 'ref' => 'crm-enable-disable',
192 'title' => ts('Disable %1', array(1 => self
::$_gName)),
194 CRM_Core_Action
::ENABLE
=> array(
195 'name' => ts('Enable'),
196 'ref' => 'crm-enable-disable',
197 'title' => ts('Enable %1', array(1 => self
::$_gName)),
199 CRM_Core_Action
::DELETE
=> array(
200 'name' => ts('Delete'),
201 'url' => 'civicrm/admin/options/' . self
::$_gName,
202 'qs' => 'action=delete&id=%%id%%',
203 'title' => ts('Delete %1 Type', array(1 => self
::$_gName)),
207 if (self
::$_gName == 'custom_search') {
209 CRM_Core_Action
::FOLLOWUP
=> array(
211 'url' => 'civicrm/contact/search/custom',
212 'qs' => 'reset=1&csid=%%value%%',
213 'title' => ts('Run %1', array(1 => self
::$_gName)),
215 self
::$_links = $runLink + self
::$_links;
218 return self
::$_links;
222 * Run the basic page (run essentially starts execution for that page).
228 return parent
::run();
240 if (!self
::$_gName) {
241 return parent
::browse();
243 $groupParams = array('name' => self
::$_gName);
244 $optionValue = CRM_Core_OptionValue
::getRows($groupParams, $this->links(), 'component_id,weight');
245 $gName = self
::$_gName;
246 $returnURL = CRM_Utils_System
::url("civicrm/admin/options/$gName",
247 "reset=1&group=$gName"
249 $filter = "option_group_id = " . self
::$_gId;
250 CRM_Utils_Weight
::addOrder($optionValue, 'CRM_Core_DAO_OptionValue',
251 'id', $returnURL, $filter
254 // retrieve financial account name for the payment instrument page
255 if ($gName = "payment_instrument") {
256 foreach ($optionValue as $key => $option) {
257 $optionValue[$key]['financial_account'] = CRM_Financial_BAO_FinancialTypeAccount
::getFinancialAccount($key, 'civicrm_option_value');
260 $this->assign('rows', $optionValue);
264 * Get name of edit form
266 * @return string Classname of edit form.
268 function editForm() {
269 return self
::$_gName ?
'CRM_Admin_Form_Options' : 'CRM_Admin_Form_OptionGroup';
275 * @return string name of this page.
277 function editName() {
278 return self
::$_gLabel;
286 * @return string user context.
288 function userContext($mode = NULL) {
289 return 'civicrm/admin/options' . (self
::$_gName ?
'/' . self
::$_gName : '');