3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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
{
46 public $useLivePageJS = TRUE;
49 * The group id of the field.
56 * The action links that we need to display for the browse screen.
60 private static $_actionLinks;
63 * Get the action links for this page.
66 * array of action links that we need to display for the browse screen
68 public function &actionLinks() {
69 if (!isset(self
::$_actionLinks)) {
70 self
::$_actionLinks = array(
71 CRM_Core_Action
::UPDATE
=> array(
72 'name' => ts('Edit Field'),
73 'url' => 'civicrm/admin/custom/group/field/update',
74 'qs' => 'action=update&reset=1&gid=%%gid%%&id=%%id%%',
75 'title' => ts('Edit Custom Field'),
77 CRM_Core_Action
::BROWSE
=> array(
78 'name' => ts('Edit Multiple Choice Options'),
79 'url' => 'civicrm/admin/custom/group/field/option',
80 'qs' => 'reset=1&action=browse&gid=%%gid%%&fid=%%id%%',
81 'title' => ts('List Custom Options'),
83 CRM_Core_Action
::PREVIEW
=> array(
84 'name' => ts('Preview Field Display'),
85 'url' => 'civicrm/admin/custom/group/field',
86 'qs' => 'action=preview&reset=1&gid=%%gid%%&id=%%id%%',
87 'title' => ts('Preview Custom Field'),
89 CRM_Core_Action
::DISABLE
=> array(
90 'name' => ts('Disable'),
91 'ref' => 'crm-enable-disable',
92 'title' => ts('Disable Custom Field'),
94 CRM_Core_Action
::ENABLE
=> array(
95 'name' => ts('Enable'),
96 'ref' => 'crm-enable-disable',
97 'title' => ts('Enable Custom Field'),
99 CRM_Core_Action
::EXPORT
=> array(
100 'name' => ts('Move'),
101 'url' => 'civicrm/admin/custom/group/field/move',
102 'class' => 'small-popup',
103 'qs' => 'reset=1&fid=%%id%%',
104 'title' => ts('Move Custom Field'),
106 CRM_Core_Action
::DELETE
=> array(
107 'name' => ts('Delete'),
108 'url' => 'civicrm/admin/custom/group/field',
109 'qs' => 'action=delete&reset=1&gid=%%gid%%&id=%%id%%',
110 'title' => ts('Delete Custom Field'),
114 return self
::$_actionLinks;
118 * Browse all custom group fields.
122 public function browse() {
123 $resourceManager = CRM_Core_Resources
::singleton();
124 if (!empty($_GET['new']) && $resourceManager->ajaxPopupsEnabled
) {
125 $resourceManager->addScriptFile('civicrm', 'js/crm.addNew.js', 999, 'html-header');
128 $customField = array();
129 $customFieldBAO = new CRM_Core_BAO_CustomField();
132 $customFieldBAO->custom_group_id
= $this->_gid
;
133 $customFieldBAO->orderBy('weight, label');
134 $customFieldBAO->find();
136 while ($customFieldBAO->fetch()) {
137 $customField[$customFieldBAO->id
] = array();
138 CRM_Core_DAO
::storeValues($customFieldBAO, $customField[$customFieldBAO->id
]);
139 $action = array_sum(array_keys($this->actionLinks()));
140 if ($customFieldBAO->is_active
) {
141 $action -= CRM_Core_Action
::ENABLE
;
144 $action -= CRM_Core_Action
::DISABLE
;
147 switch ($customFieldBAO->data_type
) {
152 // if Multi Select field is selected in custom field
153 if ($customFieldBAO->html_type
== 'Text') {
154 $action -= CRM_Core_Action
::BROWSE
;
158 case "ContactReference":
162 case "StateProvince":
166 $action -= CRM_Core_Action
::BROWSE
;
170 $customFieldDataType = CRM_Core_BAO_CustomField
::dataType();
171 $customField[$customFieldBAO->id
]['data_type'] = $customFieldDataType[$customField[$customFieldBAO->id
]['data_type']];
172 $customField[$customFieldBAO->id
]['order'] = $customField[$customFieldBAO->id
]['weight'];
173 $customField[$customFieldBAO->id
]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(), $action,
175 'id' => $customFieldBAO->id
,
176 'gid' => $this->_gid
,
180 'customField.row.actions',
186 $returnURL = CRM_Utils_System
::url('civicrm/admin/custom/group/field', "reset=1&action=browse&gid={$this->_gid}");
187 $filter = "custom_group_id = {$this->_gid}";
188 CRM_Utils_Weight
::addOrder($customField, 'CRM_Core_DAO_CustomField',
189 'id', $returnURL, $filter
192 $this->assign('customField', $customField);
198 * editing would involved modifying existing fields + adding data to new fields.
200 * @param string $action
201 * The action to be invoked.
205 public function edit($action) {
206 // create a simple controller for editing custom dataCRM/Custom/Page/Field.php
207 $controller = new CRM_Core_Controller_Simple('CRM_Custom_Form_Field', ts('Custom Field'), $action);
209 // set the userContext stack
210 $session = CRM_Core_Session
::singleton();
211 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/custom/group/field', 'reset=1&action=browse&gid=' . $this->_gid
));
213 $controller->set('gid', $this->_gid
);
214 $controller->setEmbedded(TRUE);
215 $controller->process();
222 * This method is called after the page is created. It checks for the
223 * type of action and executes that action.
227 public function run() {
229 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
234 $values = civicrm_api3('custom_field', 'getsingle', array('id' => $id));
235 $this->_gid
= $values['custom_group_id'];
239 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive',
244 if ($isReserved = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_gid
, 'is_reserved', 'id')) {
245 CRM_Core_Error
::fatal("You cannot add or edit fields in a reserved custom field-set.");
248 $action = CRM_Utils_Request
::retrieve('action', 'String',
249 // default to 'browse'
250 $this, FALSE, 'browse'
253 if ($action & CRM_Core_Action
::DELETE
) {
255 $session = CRM_Core_Session
::singleton();
256 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/custom/group/field', 'reset=1&action=browse&gid=' . $this->_gid
));
257 $controller = new CRM_Core_Controller_Simple('CRM_Custom_Form_DeleteField', "Delete Custom Field", '');
258 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
261 $controller->set('id', $id);
262 $controller->setEmbedded(TRUE);
263 $controller->process();
265 $fieldValues = array('custom_group_id' => $this->_gid
);
266 $wt = CRM_Utils_Weight
::delWeight('CRM_Core_DAO_CustomField', $id, $fieldValues);
270 $groupTitle = CRM_Core_BAO_CustomGroup
::getTitle($this->_gid
);
271 $this->assign('gid', $this->_gid
);
272 $this->assign('groupTitle', $groupTitle);
273 if ($action & CRM_Core_Action
::BROWSE
) {
274 CRM_Utils_System
::setTitle(ts('%1 - Custom Fields', array(1 => $groupTitle)));
278 // assign vars to templates
279 $this->assign('action', $action);
281 // what action to take ?
282 if ($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
)) {
283 // no browse for edit/update/view
284 $this->edit($action);
286 elseif ($action & CRM_Core_Action
::PREVIEW
) {
293 // Call the parents run method
294 return parent
::run();
298 * Preview custom field.
305 public function preview($id) {
306 $controller = new CRM_Core_Controller_Simple('CRM_Custom_Form_Preview', ts('Preview Custom Data'), CRM_Core_Action
::PREVIEW
);
307 $session = CRM_Core_Session
::singleton();
308 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/custom/group/field', 'reset=1&action=browse&gid=' . $this->_gid
));
309 $controller->set('fieldId', $id);
310 $controller->set('groupId', $this->_gid
);
311 $controller->setEmbedded(TRUE);
312 $controller->process();