3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * Create a page for displaying Custom Fields.
39 * Heart of this class is the run method which checks
40 * for action type and then displays the appropriate
44 class CRM_Custom_Page_Field
extends CRM_Core_Page
{
47 * The group id of the field
55 * The action links that we need to display for the browse screen
60 private static $_actionLinks;
63 * Get the action links for this page.
67 * @return array array of action links that we need to display for the browse screen
70 function &actionLinks() {
71 if (!isset(self
::$_actionLinks)) {
72 self
::$_actionLinks = array(
73 CRM_Core_Action
::UPDATE
=> array(
74 'name' => ts('Edit Field'),
75 'url' => 'civicrm/admin/custom/group/field/update',
76 'qs' => 'action=update&reset=1&gid=%%gid%%&id=%%id%%',
77 'title' => ts('Edit Custom Field'),
79 CRM_Core_Action
::BROWSE
=> array(
80 'name' => ts('Edit Multiple Choice Options'),
81 'url' => 'civicrm/admin/custom/group/field/option',
82 'qs' => 'reset=1&action=browse&gid=%%gid%%&fid=%%id%%',
83 'title' => ts('List Custom Options'),
85 CRM_Core_Action
::PREVIEW
=> array(
86 'name' => ts('Preview Field Display'),
87 'url' => 'civicrm/admin/custom/group/field',
88 'qs' => 'action=preview&reset=1&gid=%%gid%%&id=%%id%%',
89 'title' => ts('Preview Custom Field'),
91 CRM_Core_Action
::DISABLE
=> array(
92 'name' => ts('Disable'),
93 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_CustomField' . '\',\'' . 'enable-disable' . '\',0,\'CustomField\' );"',
94 'ref' => 'disable-action',
95 'title' => ts('Disable Custom Field'),
97 CRM_Core_Action
::ENABLE
=> array(
98 'name' => ts('Enable'),
99 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_CustomField' . '\',\'' . 'disable-enable' . '\',0,\'CustomField\' );"',
100 'ref' => 'enable-action',
101 'title' => ts('Enable Custom Field'),
103 CRM_Core_Action
::EXPORT
=> array(
104 'name' => ts('Move'),
105 'url' => 'civicrm/admin/custom/group/field/move',
106 'qs' => 'reset=1&fid=%%id%%',
107 'title' => ts('Move Custom Field'),
109 CRM_Core_Action
::DELETE
=> array(
110 'name' => ts('Delete'),
111 'url' => 'civicrm/admin/custom/group/field',
112 'qs' => 'action=delete&reset=1&gid=%%gid%%&id=%%id%%',
113 'title' => ts('Delete Custom Field'),
117 return self
::$_actionLinks;
121 * Browse all custom group fields.
129 $customField = array();
130 $customFieldBAO = new CRM_Core_BAO_CustomField();
133 $customFieldBAO->custom_group_id
= $this->_gid
;
134 $customFieldBAO->orderBy('weight, label');
135 $customFieldBAO->find();
137 while ($customFieldBAO->fetch()) {
138 $customField[$customFieldBAO->id
] = array();
139 CRM_Core_DAO
::storeValues($customFieldBAO, $customField[$customFieldBAO->id
]);
140 $action = array_sum(array_keys($this->actionLinks()));
141 if ($customFieldBAO->is_active
) {
142 $action -= CRM_Core_Action
::ENABLE
;
145 $action -= CRM_Core_Action
::DISABLE
;
148 switch ($customFieldBAO->data_type
) {
153 // if Multi Select field is selected in custom field
154 if ($customFieldBAO->html_type
== 'Text') {
155 $action -= CRM_Core_Action
::BROWSE
;
159 case "ContactReference":
163 case "StateProvince":
167 $action -= CRM_Core_Action
::BROWSE
;
171 $customFieldDataType = CRM_Core_BAO_CustomField
::dataType();
172 $customField[$customFieldBAO->id
]['data_type'] = $customFieldDataType[$customField[$customFieldBAO->id
]['data_type']];
173 $customField[$customFieldBAO->id
]['order'] = $customField[$customFieldBAO->id
]['weight'];
174 $customField[$customFieldBAO->id
]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(), $action,
176 'id' => $customFieldBAO->id
,
177 'gid' => $this->_gid
,
181 'customField.row.actions',
187 $returnURL = CRM_Utils_System
::url('civicrm/admin/custom/group/field', "reset=1&action=browse&gid={$this->_gid}");
188 $filter = "custom_group_id = {$this->_gid}";
189 CRM_Utils_Weight
::addOrder($customField, 'CRM_Core_DAO_CustomField',
190 'id', $returnURL, $filter
193 $this->assign('customField', $customField);
199 * editing would involved modifying existing fields + adding data to new fields.
201 * @param string $action the action to be invoked
206 function edit($action) {
207 // create a simple controller for editing custom dataCRM/Custom/Page/Field.php
208 $controller = new CRM_Core_Controller_Simple('CRM_Custom_Form_Field', ts('Custom Field'), $action);
210 // set the userContext stack
211 $session = CRM_Core_Session
::singleton();
212 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/custom/group/field', 'reset=1&action=browse&gid=' . $this->_gid
));
214 $controller->set('gid', $this->_gid
);
215 $controller->setEmbedded(TRUE);
216 $controller->process();
223 * This method is called after the page is created. It checks for the
224 * type of action and executes that action.
234 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
239 $values = civicrm_api3('custom_field', 'getsingle', array('id' => $id));
240 $this->_gid
= $values['custom_group_id'];
244 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive',
249 if ($isReserved = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_gid
, 'is_reserved', 'id')) {
250 CRM_Core_Error
::fatal("You cannot add or edit fields in a reserved custom field-set.");
253 $action = CRM_Utils_Request
::retrieve('action', 'String',
254 // default to 'browse'
255 $this, FALSE, 'browse'
258 if ($action & CRM_Core_Action
::DELETE
) {
260 $session = CRM_Core_Session
::singleton();
261 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/custom/group/field', 'reset=1&action=browse&gid=' . $this->_gid
));
262 $controller = new CRM_Core_Controller_Simple('CRM_Custom_Form_DeleteField', "Delete Custom Field", '');
263 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
266 $controller->set('id', $id);
267 $controller->setEmbedded(TRUE);
268 $controller->process();
270 $fieldValues = array('custom_group_id' => $this->_gid
);
271 $wt = CRM_Utils_Weight
::delWeight('CRM_Core_DAO_CustomField', $id, $fieldValues);
275 $groupTitle = CRM_Core_BAO_CustomGroup
::getTitle($this->_gid
);
276 $this->assign('gid', $this->_gid
);
277 $this->assign('groupTitle', $groupTitle);
278 CRM_Utils_System
::setTitle(ts('%1 - Custom Fields', array(1 => $groupTitle)));
281 // assign vars to templates
282 $this->assign('action', $action);
284 // what action to take ?
285 if ($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
)) {
286 // no browse for edit/update/view
287 $this->edit($action);
289 elseif ($action & CRM_Core_Action
::PREVIEW
) {
293 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'templates/CRM/Custom/Page/Field.js');
297 // Call the parents run method
298 return parent
::run();
302 * Preview custom field
304 * @param int $id custom field id
309 function preview($id) {
310 $controller = new CRM_Core_Controller_Simple('CRM_Custom_Form_Preview', ts('Preview Custom Data'), CRM_Core_Action
::PREVIEW
);
311 $session = CRM_Core_Session
::singleton();
312 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/custom/group/field', 'reset=1&action=browse&gid=' . $this->_gid
));
313 $controller->set('fieldId', $id);
314 $controller->set('groupId', $this->_gid
);
315 $controller->setEmbedded(TRUE);
316 $controller->process();