3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
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
35 class CRM_Case_XMLProcessor_Process
extends CRM_Case_XMLProcessor
{
36 function run($caseType, &$params) {
37 $xml = $this->retrieve($caseType);
40 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
41 CRM_Core_Error
::fatal(ts("Configuration file could not be retrieved for case type = '%1' %2.",
42 array(1 => $caseType, 2 => $docLink)
47 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
48 $this->_isMultiClient
= $xmlProcessorProcess->getAllowMultipleCaseClients();
50 $this->process($xml, $params);
53 function get($caseType, $fieldSet, $isLabel = FALSE, $maskAction = FALSE) {
54 $xml = $this->retrieve($caseType);
56 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
57 CRM_Core_Error
::fatal(ts("Unable to load configuration file for the referenced case type: '%1' %2.",
58 array(1 => $caseType, 2 => $docLink)
65 return $this->caseRoles($xml->CaseRoles
);
68 return $this->activitySets($xml->ActivitySets
);
71 return $this->activityTypes($xml->ActivityTypes
, FALSE, $isLabel, $maskAction);
75 function process($xml, &$params) {
76 $standardTimeline = CRM_Utils_Array
::value('standardTimeline', $params);
77 $activitySetName = CRM_Utils_Array
::value('activitySetName', $params);
78 $activityTypeName = CRM_Utils_Array
::value('activityTypeName', $params);
80 if ('Open Case' == CRM_Utils_Array
::value('activityTypeName', $params)) {
81 // create relationships for the ones that are required
82 foreach ($xml->CaseRoles
as $caseRoleXML) {
83 foreach ($caseRoleXML->RelationshipType
as $relationshipTypeXML) {
84 if ((int ) $relationshipTypeXML->creator
== 1) {
85 if (!$this->createRelationships((string ) $relationshipTypeXML->name
,
88 CRM_Core_Error
::fatal();
96 if ('Change Case Start Date' == CRM_Utils_Array
::value('activityTypeName', $params)) {
97 // delete all existing activities which are non-empty
98 $this->deleteEmptyActivity($params);
101 foreach ($xml->ActivitySets
as $activitySetsXML) {
102 foreach ($activitySetsXML->ActivitySet
as $activitySetXML) {
103 if ($standardTimeline) {
104 if ((boolean
) $activitySetXML->timeline
) {
105 return $this->processStandardTimeline($activitySetXML,
110 elseif ($activitySetName) {
111 $name = (string ) $activitySetXML->name
;
112 if ($name == $activitySetName) {
113 return $this->processActivitySet($activitySetXML,
122 function processStandardTimeline($activitySetXML, &$params) {
123 if ('Change Case Type' == CRM_Utils_Array
::value('activityTypeName', $params)) {
124 // delete all existing activities which are non-empty
125 $this->deleteEmptyActivity($params);
128 foreach ($activitySetXML->ActivityTypes
as $activityTypesXML) {
129 foreach ($activityTypesXML as $activityTypeXML) {
130 $this->createActivity($activityTypeXML, $params);
135 function processActivitySet($activitySetXML, &$params) {
136 foreach ($activitySetXML->ActivityTypes
as $activityTypesXML) {
137 foreach ($activityTypesXML as $activityTypeXML) {
138 $this->createActivity($activityTypeXML, $params);
143 function &caseRoles($caseRolesXML, $isCaseManager = FALSE) {
144 $relationshipTypes = &$this->allRelationshipTypes();
147 foreach ($caseRolesXML as $caseRoleXML) {
148 foreach ($caseRoleXML->RelationshipType
as $relationshipTypeXML) {
149 $relationshipTypeName = (string ) $relationshipTypeXML->name
;
150 $relationshipTypeID = array_search($relationshipTypeName,
153 if ($relationshipTypeID === FALSE) {
157 if (!$isCaseManager) {
158 $result[$relationshipTypeID] = $relationshipTypeName;
160 elseif ($relationshipTypeXML->manager
) {
161 return $relationshipTypeID;
168 function createRelationships($relationshipTypeName, &$params) {
169 $relationshipTypes = &$this->allRelationshipTypes();
170 // get the relationship id
171 $relationshipTypeID = array_search($relationshipTypeName, $relationshipTypes);
173 if ($relationshipTypeID === FALSE) {
174 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
175 CRM_Core_Error
::fatal(ts('Relationship type %1, found in case configuration file, is not present in the database %2',
176 array(1 => $relationshipTypeName, 2 => $docLink)
181 $client = $params['clientID'];
182 if (!is_array($client)) {
183 $client = array($client);
186 foreach ($client as $key => $clientId) {
187 $relationshipParams = array(
188 'relationship_type_id' => $relationshipTypeID,
189 'contact_id_a' => $clientId,
190 'contact_id_b' => $params['creatorID'],
192 'case_id' => $params['caseID'],
193 'start_date' => date("Ymd"),
196 if (!$this->createRelationship($relationshipParams)) {
197 CRM_Core_Error
::fatal();
204 function createRelationship(&$params) {
205 $dao = new CRM_Contact_DAO_Relationship();
206 $dao->copyValues($params);
207 // only create a relationship if it does not exist
208 if (!$dao->find(TRUE)) {
214 function activityTypes($activityTypesXML, $maxInst = FALSE, $isLabel = FALSE, $maskAction = FALSE) {
215 $activityTypes = &$this->allActivityTypes(TRUE, TRUE);
217 foreach ($activityTypesXML as $activityTypeXML) {
218 foreach ($activityTypeXML as $recordXML) {
219 $activityTypeName = (string ) $recordXML->name
;
220 $maxInstances = (string ) $recordXML->max_instances
;
221 $activityTypeInfo = CRM_Utils_Array
::value($activityTypeName, $activityTypes);
223 if ($activityTypeInfo['id']) {
225 if ($maskAction == 'edit' && '0' === (string ) $recordXML->editable
) {
226 $result[$maskAction][] = $activityTypeInfo['id'];
231 //if we want,labels of activities should be returned.
233 $result[$activityTypeInfo['id']] = $activityTypeInfo['label'];
236 $result[$activityTypeInfo['id']] = $activityTypeName;
241 $result[$activityTypeName] = $maxInstances;
249 // call option value hook
250 CRM_Utils_Hook
::optionValues($result, 'case_activity_type');
255 function deleteEmptyActivity(&$params) {
256 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
257 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
261 FROM civicrm_activity a
262 INNER JOIN civicrm_activity_contact t ON t.activity_id = a.id
263 WHERE t.contact_id = %1
264 AND t.record_type_id = $targetID
266 AND a.is_current_revision = 1
268 $sqlParams = array(1 => array($params['clientID'], 'Integer'));
269 CRM_Core_DAO
::executeQuery($query, $sqlParams);
272 function isActivityPresent(&$params) {
275 FROM civicrm_activity a
276 INNER JOIN civicrm_case_activity ca on ca.activity_id = a.id
277 WHERE a.activity_type_id = %1
282 $sqlParams = array(1 => array($params['activityTypeID'], 'Integer'),
283 2 => array($params['caseID'], 'Integer'),
285 $count = CRM_Core_DAO
::singleValueQuery($query, $sqlParams);
287 // check for max instance
288 $caseType = CRM_Case_BAO_Case
::getCaseType($params['caseID'], 'name');
289 $maxInstance = self
::getMaxInstance($caseType, $params['activityTypeName']);
291 return $maxInstance ?
($count < $maxInstance ?
FALSE : TRUE) : FALSE;
294 function createActivity($activityTypeXML, &$params) {
295 $activityTypeName = (string) $activityTypeXML->name
;
296 $activityTypes = &$this->allActivityTypes(TRUE, TRUE);
297 $activityTypeInfo = CRM_Utils_Array
::value($activityTypeName, $activityTypes);
299 if (!$activityTypeInfo) {
300 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
301 CRM_Core_Error
::fatal(ts('Activity type %1, found in case configuration file, is not present in the database %2',
302 array(1 => $activityTypeName, 2 => $docLink)
307 $activityTypeID = $activityTypeInfo['id'];
309 if (isset($activityTypeXML->status
)) {
310 $statusName = (string) $activityTypeXML->status
;
313 $statusName = 'Scheduled';
316 if ($this->_isMultiClient
) {
317 $client = $params['clientID'];
320 $client = array(1 => $params['clientID']);
325 if (isset($activityTypeXML->order
)) {
326 $orderVal = (string) $activityTypeXML->order
;
329 if ($activityTypeName == 'Open Case') {
330 $activityParams = array(
331 'activity_type_id' => $activityTypeID,
332 'source_contact_id' => $params['creatorID'],
334 'is_current_revision' => 1,
335 'subject' => CRM_Utils_Array
::value('subject', $params) ?
$params['subject'] : $activityTypeName,
336 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
340 'target_contact_id' => $client,
341 'medium_id' => CRM_Utils_Array
::value('medium_id', $params),
342 'location' => CRM_Utils_Array
::value('location', $params),
343 'details' => CRM_Utils_Array
::value('details', $params),
344 'duration' => CRM_Utils_Array
::value('duration', $params),
345 'weight' => $orderVal,
349 $activityParams = array(
350 'activity_type_id' => $activityTypeID,
351 'source_contact_id' => $params['creatorID'],
353 'is_current_revision' => 1,
354 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
358 'target_contact_id' => $client,
359 'weight' => $orderVal,
363 //parsing date to default preference format
364 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time']);
366 if ($activityTypeName == 'Open Case') {
367 // we don't set activity_date_time for auto generated
368 // activities, but we want it to be set for open case.
369 $activityParams['activity_date_time'] = $params['activity_date_time'];
370 if (array_key_exists('custom', $params) && is_array($params['custom'])) {
371 $activityParams['custom'] = $params['custom'];
374 // Add parameters for attachments
376 $numAttachments = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'max_attachments');
377 for ( $i = 1; $i <= $numAttachments; $i++
) {
378 $attachName = "attachFile_$i";
379 if ( isset( $params[$attachName] ) && !empty( $params[$attachName] ) ) {
380 $activityParams[$attachName] = $params[$attachName];
385 $activityDate = NULL;
386 //get date of reference activity if set.
387 if ($referenceActivityName = (string) $activityTypeXML->reference_activity
) {
389 //we skip open case as reference activity.CRM-4374.
390 if (CRM_Utils_Array
::value('resetTimeline', $params) && $referenceActivityName == 'Open Case') {
391 $activityDate = $params['activity_date_time'];
394 $referenceActivityInfo = CRM_Utils_Array
::value($referenceActivityName, $activityTypes);
395 if ($referenceActivityInfo['id']) {
396 $caseActivityParams = array('activity_type_id' => $referenceActivityInfo['id']);
398 //if reference_select is set take according activity.
399 if ($referenceSelect = (string) $activityTypeXML->reference_select
) {
400 $caseActivityParams[$referenceSelect] = 1;
403 $referenceActivity = CRM_Case_BAO_Case
::getCaseActivityDates($params['caseID'], $caseActivityParams, TRUE);
405 if (is_array($referenceActivity)) {
406 foreach ($referenceActivity as $aId => $details) {
407 $activityDate = CRM_Utils_Array
::value('activity_date', $details);
414 if (!$activityDate) {
415 $activityDate = $params['activity_date_time'];
417 list($activity_date, $activity_time) = CRM_Utils_Date
::setDateDefaults($activityDate);
418 $activityDateTime = CRM_Utils_Date
::processDate($activity_date, $activity_time);
419 //add reference offset to date.
420 if ((int) $activityTypeXML->reference_offset
) {
421 $activityDateTime = CRM_Utils_Date
::intervalAdd('day', (int) $activityTypeXML->reference_offset
,
426 $activityParams['activity_date_time'] = CRM_Utils_Date
::format($activityDateTime);
429 // if same activity is already there, skip and dont touch
430 $params['activityTypeID'] = $activityTypeID;
431 $params['activityTypeName'] = $activityTypeName;
432 if ($this->isActivityPresent($params)) {
435 $activityParams['case_id'] = $params['caseID'];
436 if (CRM_Utils_Array
::value('is_auto', $activityParams)) {
437 $activityParams['skipRecentView'] = TRUE;
440 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
443 CRM_Core_Error
::fatal();
447 // create case activity record
449 'activity_id' => $activity->id
,
450 'case_id' => $params['caseID'],
452 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
456 function activitySets($activitySetsXML) {
458 foreach ($activitySetsXML as $activitySetXML) {
459 foreach ($activitySetXML as $recordXML) {
460 $activitySetName = (string ) $recordXML->name
;
461 $activitySetLabel = (string ) $recordXML->label
;
462 $result[$activitySetName] = $activitySetLabel;
469 function getMaxInstance($caseType, $activityTypeName = NULL) {
470 $xml = $this->retrieve($caseType);
472 if ($xml === FALSE) {
473 CRM_Core_Error
::fatal();
477 $activityInstances = $this->activityTypes($xml->ActivityTypes
, TRUE);
478 return $activityTypeName ? CRM_Utils_Array
::value($activityTypeName, $activityInstances) : $activityInstances;
481 function getCaseManagerRoleId($caseType) {
482 $xml = $this->retrieve($caseType);
483 return $this->caseRoles($xml->CaseRoles
, TRUE);
486 function getRedactActivityEmail() {
487 $xml = $this->retrieve("Settings");
488 return ( string ) $xml->RedactActivityEmail ?
1 : 0;
492 * Retrieves AllowMultipleCaseClients setting
494 * @return string 1 if allowed, 0 if not
496 function getAllowMultipleCaseClients() {
497 $xml = $this->retrieve("Settings");
499 return ( string ) $xml->AllowMultipleCaseClients ?
1 : 0;
505 * Retrieves NaturalActivityTypeSort setting
507 * @return string 1 if natural, 0 if alphabetic
509 function getNaturalActivityTypeSort() {
510 $xml = $this->retrieve("Settings");
511 return ( string ) $xml->NaturalActivityTypeSort ?
1 : 0;