3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 * Create a page for displaying CiviCRM Profile Fields.
39 * Heart of this class is the run method which checks
40 * for action type and then displays the appropriate
44 class CRM_UF_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.
67 function &actionLinks() {
68 if (!isset(self
::$_actionLinks)) {
69 self
::$_actionLinks = array(
70 CRM_Core_Action
::UPDATE
=> array(
72 'url' => 'civicrm/admin/uf/group/field/update',
73 'qs' => 'reset=1&action=update&id=%%id%%&gid=%%gid%%',
74 'title' => ts('Edit CiviCRM Profile Field'),
76 CRM_Core_Action
::PREVIEW
=> array(
77 'name' => ts('Preview'),
78 'url' => 'civicrm/admin/uf/group/field',
79 'qs' => 'action=preview&id=%%id%%&field=1',
80 'title' => ts('Preview CiviCRM Profile Field'),
82 CRM_Core_Action
::DISABLE
=> array(
83 'name' => ts('Disable'),
84 'ref' => 'crm-enable-disable',
85 'title' => ts('Disable CiviCRM Profile Field'),
87 CRM_Core_Action
::ENABLE
=> array(
88 'name' => ts('Enable'),
89 'ref' => 'crm-enable-disable',
90 'title' => ts('Enable CiviCRM Profile Field'),
92 CRM_Core_Action
::DELETE
=> array(
93 'name' => ts('Delete'),
94 'url' => 'civicrm/admin/uf/group/field',
95 'qs' => 'action=delete&id=%%id%%',
96 'title' => ts('Enable CiviCRM Profile Field'),
100 return self
::$_actionLinks;
104 * Browse all CiviCRM Profile group fields.
109 public function browse() {
110 $resourceManager = CRM_Core_Resources
::singleton();
111 if (!empty($_GET['new']) && $resourceManager->ajaxPopupsEnabled
) {
112 $resourceManager->addScriptFile('civicrm', 'js/crm.addNew.js', 999, 'html-header');
116 $ufFieldBAO = new CRM_Core_BAO_UFField();
119 $ufFieldBAO->uf_group_id
= $this->_gid
;
120 $ufFieldBAO->orderBy('weight', 'field_name');
123 $otherModules = CRM_Core_BAO_UFGroup
::getUFJoinRecord($this->_gid
);
124 $this->assign('otherModules', $otherModules);
126 $isGroupReserved = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'is_reserved');
127 $this->assign('isGroupReserved', $isGroupReserved);
129 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
130 if ($profileType == 'Contribution' ||
$profileType == 'Membership' ||
$profileType == 'Activity' ||
$profileType == 'Participant') {
131 $this->assign('skipCreate', TRUE);
134 $locationType = array();
135 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
137 $fields = CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE);
138 $fields = array_merge(CRM_Contribute_BAO_Contribution
::getContributionFields(), $fields);
141 foreach ($fields as $name => $field) {
143 $select[$name] = $field['title'];
146 $select['group'] = ts('Group(s)');
147 $select['tag'] = ts('Tag(s)');
149 $visibility = CRM_Core_SelectValues
::ufVisibility();
150 while ($ufFieldBAO->fetch()) {
151 $ufField[$ufFieldBAO->id
] = array();
152 $phoneType = $locType = '';
153 CRM_Core_DAO
::storeValues($ufFieldBAO, $ufField[$ufFieldBAO->id
]);
154 $ufField[$ufFieldBAO->id
]['visibility_display'] = $visibility[$ufFieldBAO->visibility
];
156 $ufField[$ufFieldBAO->id
]['label'] = $ufFieldBAO->label
;
158 $action = array_sum(array_keys($this->actionLinks()));
159 if ($ufFieldBAO->is_active
) {
160 $action -= CRM_Core_Action
::ENABLE
;
163 $action -= CRM_Core_Action
::DISABLE
;
166 if ($ufFieldBAO->is_reserved
) {
167 $action -= CRM_Core_Action
::UPDATE
;
168 $action -= CRM_Core_Action
::DISABLE
;
169 $action -= CRM_Core_Action
::DELETE
;
171 $ufField[$ufFieldBAO->id
]['order'] = $ufField[$ufFieldBAO->id
]['weight'];
172 $ufField[$ufFieldBAO->id
]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(),
175 'id' => $ufFieldBAO->id
,
176 'gid' => $this->_gid
,
180 'ufField.row.actions',
186 $returnURL = CRM_Utils_System
::url('civicrm/admin/uf/group/field',
187 "reset=1&action=browse&gid={$this->_gid}"
189 $filter = "uf_group_id = {$this->_gid}";
190 CRM_Utils_Weight
::addOrder($ufField, 'CRM_Core_DAO_UFField',
191 'id', $returnURL, $filter
194 $this->assign('ufField', $ufField);
196 // retrieve showBestResult from session
197 $session = CRM_Core_Session
::singleton();
198 $showBestResult = $session->get('showBestResult');
199 $this->assign('showBestResult', $showBestResult);
200 $session->set('showBestResult', 0);
204 * Edit CiviCRM Profile data.
206 * editing would involved modifying existing fields + adding data to new fields.
208 * @param string $action
209 * The action to be invoked.
213 public function edit($action) {
214 // create a simple controller for editing CiviCRM Profile data
215 $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Field', ts('CiviCRM Profile Field'), $action);
217 // set the userContext stack
218 $session = CRM_Core_Session
::singleton();
219 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/uf/group/field',
220 'reset=1&action=browse&gid=' . $this->_gid
222 $controller->set('gid', $this->_gid
);
223 $controller->setEmbedded(TRUE);
224 $controller->process();
231 * This method is called after the page is created. It checks for the
232 * type of action and executes that action.
236 public function run() {
238 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive',
243 $groupTitle = CRM_Core_BAO_UFGroup
::getTitle($this->_gid
);
244 $this->assign('gid', $this->_gid
);
245 $this->assign('groupTitle', $groupTitle);
246 CRM_Utils_System
::setTitle(ts('%1 - CiviCRM Profile Fields', array(1 => $groupTitle)));
249 // get the requested action
250 $action = CRM_Utils_Request
::retrieve('action', 'String',
251 // default to 'browse'
252 $this, FALSE, 'browse'
255 // assign vars to templates
256 $this->assign('action', $action);
258 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
262 // what action to take ?
263 if ($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::VIEW | CRM_Core_Action
::DELETE
)) {
264 // no browse for edit/update/view/delete
265 $this->edit($action);
267 elseif ($action & CRM_Core_Action
::PREVIEW
) {
268 $this->preview($id, $this->_gid
);
274 // Call the parents run method
275 return parent
::run();
279 * Preview custom field
281 * @param int $fieldId
283 * @param int $groupId
287 public function preview($fieldId, $groupId) {
288 $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('Preview Custom Data'), CRM_Core_Action
::PREVIEW
);
289 $session = CRM_Core_Session
::singleton();
290 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/uf/group/field',
291 'reset=1&action=browse&gid=' . $this->_gid
293 $controller->set('fieldId', $fieldId);
294 $controller->set('id', $groupId);
295 $controller->setEmbedded(TRUE);
296 $controller->process();