3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
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 https://civicrm.org/licensing
35 * Create a page for displaying CiviCRM Profile Fields.
37 * Heart of this class is the run method which checks
38 * for action type and then displays the appropriate
42 class CRM_UF_Page_Field
extends CRM_Core_Page
{
44 public $useLivePageJS = TRUE;
47 * The group id of the field.
54 * The action links that we need to display for the browse screen.
58 private static $_actionLinks;
61 * Get the action links for this page.
65 public static function &actionLinks() {
66 if (!isset(self
::$_actionLinks)) {
67 self
::$_actionLinks = [
68 CRM_Core_Action
::UPDATE
=> [
70 'url' => 'civicrm/admin/uf/group/field/update',
71 'qs' => 'reset=1&action=update&id=%%id%%&gid=%%gid%%',
72 'title' => ts('Edit CiviCRM Profile Field'),
74 CRM_Core_Action
::PREVIEW
=> [
75 'name' => ts('Preview'),
76 'url' => 'civicrm/admin/uf/group/field',
77 'qs' => 'action=preview&id=%%id%%&field=1',
78 'title' => ts('Preview CiviCRM Profile Field'),
80 CRM_Core_Action
::DISABLE
=> [
81 'name' => ts('Disable'),
82 'ref' => 'crm-enable-disable',
83 'title' => ts('Disable CiviCRM Profile Field'),
85 CRM_Core_Action
::ENABLE
=> [
86 'name' => ts('Enable'),
87 'ref' => 'crm-enable-disable',
88 'title' => ts('Enable CiviCRM Profile Field'),
90 CRM_Core_Action
::DELETE
=> [
91 'name' => ts('Delete'),
92 'url' => 'civicrm/admin/uf/group/field',
93 'qs' => 'action=delete&id=%%id%%',
94 'title' => ts('Enable CiviCRM Profile Field'),
98 return self
::$_actionLinks;
102 * Browse all CiviCRM Profile group fields.
106 public function browse() {
107 $resourceManager = CRM_Core_Resources
::singleton();
108 if (!empty($_GET['new']) && $resourceManager->ajaxPopupsEnabled
) {
109 $resourceManager->addScriptFile('civicrm', 'js/crm.addNew.js', 999, 'html-header');
113 $ufFieldBAO = new CRM_Core_BAO_UFField();
116 $ufFieldBAO->uf_group_id
= $this->_gid
;
117 $ufFieldBAO->orderBy('weight', 'field_name');
120 $otherModules = CRM_Core_BAO_UFGroup
::getUFJoinRecord($this->_gid
);
121 $this->assign('otherModules', $otherModules);
123 $isGroupReserved = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'is_reserved');
124 $this->assign('isGroupReserved', $isGroupReserved);
126 $isMixedProfile = CRM_Core_BAO_UFField
::checkProfileType($this->_gid
);
127 if ($isMixedProfile) {
128 $this->assign('skipCreate', TRUE);
132 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
134 $fields = CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE);
135 $fields = array_merge(CRM_Contribute_BAO_Contribution
::getContributionFields(), $fields);
138 foreach ($fields as $name => $field) {
140 $select[$name] = $field['title'];
143 $select['group'] = ts('Group(s)');
144 $select['tag'] = ts('Tag(s)');
146 $visibility = CRM_Core_SelectValues
::ufVisibility();
147 while ($ufFieldBAO->fetch()) {
148 $ufField[$ufFieldBAO->id
] = [];
149 $phoneType = $locType = '';
150 CRM_Core_DAO
::storeValues($ufFieldBAO, $ufField[$ufFieldBAO->id
]);
151 $ufField[$ufFieldBAO->id
]['visibility_display'] = $visibility[$ufFieldBAO->visibility
];
153 $ufField[$ufFieldBAO->id
]['label'] = $ufFieldBAO->label
;
155 $action = array_sum(array_keys(self
::actionLinks()));
156 if ($ufFieldBAO->is_active
) {
157 $action -= CRM_Core_Action
::ENABLE
;
160 $action -= CRM_Core_Action
::DISABLE
;
163 if ($ufFieldBAO->is_reserved
) {
164 $action -= CRM_Core_Action
::UPDATE
;
165 $action -= CRM_Core_Action
::DISABLE
;
166 $action -= CRM_Core_Action
::DELETE
;
168 $ufField[$ufFieldBAO->id
]['order'] = $ufField[$ufFieldBAO->id
]['weight'];
169 $ufField[$ufFieldBAO->id
]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(),
172 'id' => $ufFieldBAO->id
,
173 'gid' => $this->_gid
,
177 'ufField.row.actions',
183 $returnURL = CRM_Utils_System
::url('civicrm/admin/uf/group/field',
184 "reset=1&action=browse&gid={$this->_gid}"
186 $filter = "uf_group_id = {$this->_gid}";
187 CRM_Utils_Weight
::addOrder($ufField, 'CRM_Core_DAO_UFField',
188 'id', $returnURL, $filter
191 $this->assign('ufField', $ufField);
193 // retrieve showBestResult from session
194 $session = CRM_Core_Session
::singleton();
195 $showBestResult = $session->get('showBestResult');
196 $this->assign('showBestResult', $showBestResult);
197 $session->set('showBestResult', 0);
201 * Edit CiviCRM Profile data.
203 * editing would involved modifying existing fields + adding data to new fields.
205 * @param string $action
206 * The action to be invoked.
210 public function edit($action) {
211 // create a simple controller for editing CiviCRM Profile data
212 $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Field', ts('CiviCRM Profile Field'), $action);
214 // set the userContext stack
215 $session = CRM_Core_Session
::singleton();
216 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/uf/group/field',
217 'reset=1&action=browse&gid=' . $this->_gid
219 $controller->set('gid', $this->_gid
);
220 $controller->setEmbedded(TRUE);
221 $controller->process();
228 * This method is called after the page is created. It checks for the
229 * type of action and executes that action.
233 public function run() {
235 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive',
240 $groupTitle = CRM_Core_BAO_UFGroup
::getTitle($this->_gid
);
241 $this->assign('gid', $this->_gid
);
242 $this->assign('groupTitle', $groupTitle);
243 CRM_Utils_System
::setTitle(ts('%1 - CiviCRM Profile Fields', [1 => $groupTitle]));
246 // get the requested action
247 $action = CRM_Utils_Request
::retrieve('action', 'String',
248 // default to 'browse'
249 $this, FALSE, 'browse'
252 // assign vars to templates
253 $this->assign('action', $action);
255 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
259 // what action to take ?
260 if ($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::VIEW | CRM_Core_Action
::DELETE
)) {
261 // no browse for edit/update/view/delete
262 $this->edit($action);
264 elseif ($action & CRM_Core_Action
::PREVIEW
) {
265 $this->preview($id, $this->_gid
);
271 // Call the parents run method
272 return parent
::run();
276 * Preview custom field.
278 * @param int $fieldId
280 * @param int $groupId
284 public function preview($fieldId, $groupId) {
285 $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('Preview Custom Data'), CRM_Core_Action
::PREVIEW
);
286 $session = CRM_Core_Session
::singleton();
287 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/uf/group/field',
288 'reset=1&action=browse&gid=' . $this->_gid
290 $controller->set('fieldId', $fieldId);
291 $controller->set('id', $groupId);
292 $controller->setEmbedded(TRUE);
293 $controller->process();