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
35 class CRM_Profile_Page_MultipleRecordFieldsListing
extends CRM_Core_Page_Basic
{
38 * The action links that we need to display for the browse screen.
42 static $_links = NULL;
44 protected $_fields = NULL;
46 protected $_profileId = NULL;
48 protected $_contactId = NULL;
50 protected $_customGroupTitle = NULL;
52 protected $_pageViewType = NULL;
54 protected $_contactType = NULL;
62 public function getBAOName() {
70 * (reference) of action links
72 public function &links() {
73 if (!(self
::$_links[$this->_pageViewType
])) {
74 // helper variable for nicer formatting
77 $view = array_search(CRM_Core_Action
::VIEW
, CRM_Core_Action
::$_names);
78 $update = array_search(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::$_names);
79 $delete = array_search(CRM_Core_Action
::DELETE
, CRM_Core_Action
::$_names);
82 $links[CRM_Core_Action
::VIEW
] = array(
84 'title' => ts('View %1', array(1 => $this->_customGroupTitle
. ' record')),
87 $links[CRM_Core_Action
::UPDATE
] = array(
89 'title' => ts('Edit %1', array(1 => $this->_customGroupTitle
. ' record')),
92 $links[CRM_Core_Action
::DELETE
] = array(
93 'name' => ts('Delete'),
94 'title' => ts('Delete %1', array(1 => $this->_customGroupTitle
. ' record')),
97 // urls and queryStrings
98 if ($this->_pageViewType
== 'profileDataView') {
99 $links[CRM_Core_Action
::VIEW
]['url'] = 'civicrm/profile/view';
100 $links[CRM_Core_Action
::VIEW
]['qs'] = "reset=1&id=%%id%%&recordId=%%recordId%%&gid=%%gid%%&multiRecord={$view}";
102 $links[CRM_Core_Action
::UPDATE
]['url'] = 'civicrm/profile/edit';
103 $links[CRM_Core_Action
::UPDATE
]['qs'] = "reset=1&id=%%id%%&recordId=%%recordId%%&gid=%%gid%%&multiRecord={$update}";
105 $links[CRM_Core_Action
::DELETE
]['url'] = 'civicrm/profile/edit';
106 $links[CRM_Core_Action
::DELETE
]['qs'] = "reset=1&id=%%id%%&recordId=%%recordId%%&gid=%%gid%%&multiRecord={$delete}";
109 elseif ($this->_pageViewType
== 'customDataView') {
110 // custom data specific view links
111 $links[CRM_Core_Action
::VIEW
]['url'] = 'civicrm/contact/view/cd';
112 $links[CRM_Core_Action
::VIEW
]['qs'] = 'reset=1&gid=%%gid%%&cid=%%cid%%&recId=%%recId%%&multiRecordDisplay=single&mode=view';
114 // custom data specific update links
115 $links[CRM_Core_Action
::UPDATE
]['url'] = 'civicrm/contact/view/cd/edit';
116 $links[CRM_Core_Action
::UPDATE
]['qs'] = 'reset=1&type=%%type%%&groupID=%%groupID%%&entityID=%%entityID%%&cgcount=%%cgcount%%&multiRecordDisplay=single&mode=edit';
117 // NOTE : links for DELETE action for customDataView is handled in browse
120 $links[CRM_Core_Action
::COPY
] = array(
121 'name' => ts('Copy'),
122 'title' => ts('Copy %1', array(1 => $this->_customGroupTitle
. ' record')),
123 'url' => 'civicrm/contact/view/cd/edit',
124 'qs' => 'reset=1&type=%%type%%&groupID=%%groupID%%&entityID=%%entityID%%&cgcount=%%newCgCount%%&multiRecordDisplay=single©ValueId=%%cgcount%%&mode=copy',
128 self
::$_links[$this->_pageViewType
] = $links;
130 return self
::$_links[$this->_pageViewType
];
136 * This method is called after the page is created. It checks for the type
137 * of action and executes that action. Finally it calls the parent's run
142 public function run() {
143 // get the requested action, default to 'browse'
144 $action = CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, FALSE);
146 // assign vars to templates
147 $this->assign('action', $action);
148 $profileId = CRM_Utils_Request
::retrieve('profileId', 'Positive', $this, FALSE);
149 if (!is_array($profileId) && is_numeric($profileId)) {
150 $this->_profileId
= $profileId;
153 $this->_contactId
= CRM_Utils_Request
::retrieve('contactId', 'Positive', $this, FALSE);
154 $this->_pageViewType
= CRM_Utils_Request
::retrieve('pageViewType', 'Positive', $this, FALSE, 'profileDataView');
155 $this->_customGroupId
= CRM_Utils_Request
::retrieve('customGroupId', 'Positive', $this, FALSE, 0);
156 $this->_contactType
= CRM_Utils_Request
::retrieve('contactType', 'String', $this, FALSE);
157 if ($action & CRM_Core_Action
::BROWSE
) {
163 return parent
::run();
167 * Browse the listing.
171 public function browse() {
174 $attributes = array();
175 $dateFieldsVals = NULL;
176 if ($this->_pageViewType
== 'profileDataView' && $this->_profileId
) {
177 $fields = CRM_Core_BAO_UFGroup
::getFields($this->_profileId
, FALSE, NULL,
182 CRM_Core_Permission
::EDIT
184 $multiRecordFields = array();
187 $multiRecordFieldsWithSummaryListing = CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($fields, $multiRecordFields, TRUE);
189 $multiFieldId = CRM_Core_BAO_CustomField
::getKeyID(key($multiRecordFields));
190 $customGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $multiFieldId, 'custom_group_id');
191 $reached = CRM_Core_BAO_CustomGroup
::hasReachedMaxLimit($customGroupId, $this->_contactId
);
193 $this->assign('contactId', $this->_contactId
);
194 $this->assign('gid', $this->_profileId
);
196 $this->assign('reachedMax', $reached);
198 if ($multiRecordFieldsWithSummaryListing && !empty($multiRecordFieldsWithSummaryListing)) {
199 $fieldIDs = array_keys($multiRecordFieldsWithSummaryListing);
202 elseif ($this->_pageViewType
== 'customDataView') {
203 // require custom group id for _pageViewType of customDataView
204 $customGroupId = $this->_customGroupId
;
205 $reached = CRM_Core_BAO_CustomGroup
::hasReachedMaxLimit($customGroupId, $this->_contactId
);
207 $this->assign('contactId', $this->_contactId
);
208 $this->assign('customGroupId', $customGroupId);
209 $this->assign('ctype', $this->_contactType
);
211 $this->assign('reachedMax', $reached);
212 // custom group info : this consists of the field title of group fields
213 $groupDetail = CRM_Core_BAO_CustomGroup
::getGroupDetail($customGroupId, NULL, CRM_Core_DAO
::$_nullObject, TRUE);
214 // field ids of fields in_selector for the custom group id provided
215 $fieldIDs = array_keys($groupDetail[$customGroupId]['fields']);
216 // field labels for headers
217 $fieldLabels = $groupDetail[$customGroupId]['fields'];
219 // from the above customGroupInfo we can get $this->_customGroupTitle
220 $this->_customGroupTitle
= $groupDetail[$customGroupId]['title'];
222 if ($fieldIDs && !empty($fieldIDs) && $this->_contactId
) {
224 $returnProperities = array(
232 foreach ($fieldIDs as $key => $fieldID) {
233 $fieldIDs[$key] = !is_numeric($fieldID) ? CRM_Core_BAO_CustomField
::getKeyID($fieldID) : $fieldID;
234 $param = array('id' => $fieldIDs[$key]);
235 $returnValues = array();
236 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $param, $returnValues, $returnProperities);
237 if ($returnValues['data_type'] == 'Date') {
238 $dateFields[$fieldIDs[$key]] = 1;
239 $actualPHPFormats = CRM_Core_SelectValues
::datePluginToPHPFormats();
240 $dateFormat = (array) CRM_Utils_Array
::value($returnValues['date_format'], $actualPHPFormats);
241 $timeFormat = CRM_Utils_Array
::value('time_format', $returnValues);
244 $optionValuePairs = CRM_Core_BAO_CustomOption
::getCustomOption($fieldIDs[$key]);
245 if (!empty($optionValuePairs)) {
246 foreach ($optionValuePairs as $optionPairs) {
247 $options[$fieldIDs[$key]][$optionPairs['value']] = $optionPairs['label'];
251 $options[$fieldIDs[$key]]['attributes']['html_type'] = $returnValues['html_type'];
252 $options[$fieldIDs[$key]]['attributes']['data_type'] = $returnValues['data_type'];
253 $options[$fieldIDs[$key]]['attributes']['is_required'] = !empty($returnValues['is_required']);
254 $options[$fieldIDs[$key]]['attributes']['default_value'] = CRM_Utils_Array
::value('default_value', $returnValues);
256 $options[$fieldIDs[$key]]['attributes']['format']
257 = $options[$fieldIDs[$key]]['attributes']['date_format'] = CRM_Utils_Array
::value('date_format', $returnValues);
258 $options[$fieldIDs[$key]]['attributes']['time_format'] = CRM_Utils_Array
::value('time_format', $returnValues);
261 // commonly used for both views i.e profile listing view (profileDataView) and custom data listing view (customDataView)
262 $result = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_contactId
, NULL, $fieldIDs, TRUE);
264 if ($this->_pageViewType
== 'profileDataView') {
265 if (!empty($fieldIDs)) {
266 //get the group info of multi rec fields in listing view
267 $fieldInput = $fieldIDs;
268 $fieldIdInput = $fieldIDs[0];
271 //if no listing fields exist, take the group title for display
272 $nonListingFieldIds = array_keys($multiRecordFields);
273 $singleField = CRM_Core_BAO_CustomField
::getKeyID($nonListingFieldIds[0]);
274 $fieldIdInput = $singleField;
275 $singleField = array($singleField);
276 $fieldInput = $singleField;
278 $customGroupInfo = CRM_Core_BAO_CustomGroup
::getGroupTitles($fieldInput);
279 $this->_customGroupTitle
= $customGroupInfo[$fieldIdInput]['groupTitle'];
281 // $cgcount is defined before 'if' condition as enitiy may have no record
282 // and $cgcount is used to build new record url
284 if ($result && !empty($result)) {
285 $links = self
::links();
286 if ($this->_pageViewType
== 'profileDataView') {
287 $pageCheckSum = $this->get('pageCheckSum');
289 foreach ($links as $key => $link) {
290 $links[$key] = $link['qs'] . "&cs=%%cs%%";
294 $linkAction = array_sum(array_keys($this->links()));
297 unset($links[CRM_Core_Action
::COPY
]);
299 $newCgCount = (!$reached) ?
count($result) +
1 : NULL;
300 foreach ($result as $recId => &$value) {
301 foreach ($value as $fieldId => &$val) {
302 if (is_numeric($fieldId)) {
303 $customValue = &$val;
304 if (!empty($dateFields) && array_key_exists($fieldId, $dateFields)) {
305 // formatted date capture value capture
306 $dateFieldsVals[$fieldId][$recId] = CRM_Core_BAO_CustomField
::getDisplayValue($customValue, $fieldId, $options);
308 //set date and time format
309 switch ($timeFormat) {
311 $dateFormat[] = 'g:iA';
315 $dateFormat[] = 'G:i';
319 // if time is not selected remove time from value
320 $result[$recId][$fieldId] = substr($result[$recId][$fieldId], 0, 10);
322 $result[$recId][$fieldId] = CRM_Utils_Date
::processDate($result[$recId][$fieldId], NULL, FALSE, implode(" ", $dateFormat));
326 $customValue = CRM_Core_BAO_CustomField
::getDisplayValue($customValue, $fieldId, $options);
328 // FIXME: getDisplayValue should always return a string so why is this necessary?
329 if (!$customValue && $customValue !== '0') {
333 // Set field attributes to support crmEditable
334 // Note that $fieldAttributes[data-type] actually refers to the html type not the sql data type
335 // TODO: Not all widget types and validation rules are supported by crmEditable so some fields will not be in-place editable
336 $fieldAttributes = array('class' => "crmf-custom_{$fieldId}_$recId");
338 if ($linkAction & CRM_Core_Action
::UPDATE
) {
339 $spec = $options[$fieldId]['attributes'];
340 switch ($spec['html_type']) {
342 // Other data types like money would require some extra validation
343 // FIXME: crmEditable currently does not support any validation rules :(
344 $supportedDataTypes = array('Float', 'String', 'Int');
345 $editable = in_array($spec['data_type'], $supportedDataTypes);
350 $fieldAttributes['data-type'] = 'textarea';
355 case 'Select Country':
356 case 'Select State/Province':
358 $fieldAttributes['data-type'] = $spec['data_type'] == 'Boolean' ?
'boolean' : 'select';
359 if (!$spec['is_required']) {
360 $fieldAttributes['data-empty-option'] = ts('- none -');
366 $fieldAttributes['class'] .= ' crm-editable';
368 $attributes[$fieldId][$recId] = $fieldAttributes;
371 if ($this->_pageViewType
== 'profileDataView') {
372 $actionParams = array(
373 'recordId' => $recId,
374 'gid' => $this->_profileId
,
375 'id' => $this->_contactId
,
377 $op = 'profile.multiValue.row';
380 // different set of url params
381 $actionParams['gid'] = $actionParams['groupID'] = $this->_customGroupId
;
382 $actionParams['cid'] = $actionParams['entityID'] = $this->_contactId
;
383 $actionParams['recId'] = $recId;
384 $actionParams['type'] = $this->_contactType
;
385 $actionParams['cgcount'] = $cgcount;
386 $actionParams['newCgCount'] = $newCgCount;
388 // DELETE action links
391 'groupID' => $this->_customGroupId
,
392 'contactId' => $this->_contactId
,
393 'key' => CRM_Core_Key
::get('civicrm/ajax/customvalue'),
395 $links[CRM_Core_Action
::DELETE
]['url'] = '#';
396 $links[CRM_Core_Action
::DELETE
]['extra'] = ' data-delete_params="' . htmlspecialchars(json_encode($deleteData)) . '"';
397 $links[CRM_Core_Action
::DELETE
]['class'] = 'delete-custom-row';
399 if (!empty($pageCheckSum)) {
400 $actionParams['cs'] = $pageCheckSum;
403 $value['action'] = CRM_Core_Action
::formLink(
411 $fieldId // not ideal, but the one thing not sent in $actionParams
421 if (!empty($fieldIDs)) {
422 foreach ($fieldIDs as $fieldID) {
423 $headers[$fieldID] = ($this->_pageViewType
== 'profileDataView') ?
$customGroupInfo[$fieldID]['fieldLabel'] : $fieldLabels[$fieldID]['label'];
426 $this->assign('dateFields', $dateFields);
427 $this->assign('dateFieldsVals', $dateFieldsVals);
428 $this->assign('cgcount', $cgcount);
429 $this->assign('customGroupTitle', $this->_customGroupTitle
);
430 $this->assign('headers', $headers);
431 $this->assign('records', $result);
432 $this->assign('attributes', $attributes);
436 * Get name of edit form.
439 * classname of edit form
441 public function editForm() {
446 * Get edit form name.
451 public function editName() {
463 public function userContext($mode = NULL) {