3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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
35 class CRM_Case_XMLProcessor_Process
extends CRM_Case_XMLProcessor
{
42 function run($caseType, &$params) {
43 $xml = $this->retrieve($caseType);
46 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
47 CRM_Core_Error
::fatal(ts("Configuration file could not be retrieved for case type = '%1' %2.",
48 array(1 => $caseType, 2 => $docLink)
53 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
54 $this->_isMultiClient
= $xmlProcessorProcess->getAllowMultipleCaseClients();
56 $this->process($xml, $params);
62 * @param bool $isLabel
63 * @param bool $maskAction
65 * @return array|bool|mixed
68 function get($caseType, $fieldSet, $isLabel = FALSE, $maskAction = FALSE) {
69 $xml = $this->retrieve($caseType);
71 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
72 CRM_Core_Error
::fatal(ts("Unable to load configuration file for the referenced case type: '%1' %2.",
73 array(1 => $caseType, 2 => $docLink)
80 return $this->caseRoles($xml->CaseRoles
);
83 return $this->activitySets($xml->ActivitySets
);
86 return $this->activityTypes($xml->ActivityTypes
, FALSE, $isLabel, $maskAction);
96 function process($xml, &$params) {
97 $standardTimeline = CRM_Utils_Array
::value('standardTimeline', $params);
98 $activitySetName = CRM_Utils_Array
::value('activitySetName', $params);
99 $activityTypeName = CRM_Utils_Array
::value('activityTypeName', $params);
101 if ('Open Case' == CRM_Utils_Array
::value('activityTypeName', $params)) {
102 // create relationships for the ones that are required
103 foreach ($xml->CaseRoles
as $caseRoleXML) {
104 foreach ($caseRoleXML->RelationshipType
as $relationshipTypeXML) {
105 if ((int ) $relationshipTypeXML->creator
== 1) {
106 if (!$this->createRelationships((string ) $relationshipTypeXML->name
,
109 CRM_Core_Error
::fatal();
117 if ('Change Case Start Date' == CRM_Utils_Array
::value('activityTypeName', $params)) {
118 // delete all existing activities which are non-empty
119 $this->deleteEmptyActivity($params);
122 foreach ($xml->ActivitySets
as $activitySetsXML) {
123 foreach ($activitySetsXML->ActivitySet
as $activitySetXML) {
124 if ($standardTimeline) {
125 if ((boolean
) $activitySetXML->timeline
) {
126 return $this->processStandardTimeline($activitySetXML,
131 elseif ($activitySetName) {
132 $name = (string ) $activitySetXML->name
;
133 if ($name == $activitySetName) {
134 return $this->processActivitySet($activitySetXML,
144 * @param $activitySetXML
147 function processStandardTimeline($activitySetXML, &$params) {
148 if ('Change Case Type' == CRM_Utils_Array
::value('activityTypeName', $params)
149 && CRM_Utils_Array
::value('resetTimeline', $params, TRUE)) {
150 // delete all existing activities which are non-empty
151 $this->deleteEmptyActivity($params);
154 foreach ($activitySetXML->ActivityTypes
as $activityTypesXML) {
155 foreach ($activityTypesXML as $activityTypeXML) {
156 $this->createActivity($activityTypeXML, $params);
162 * @param $activitySetXML
165 function processActivitySet($activitySetXML, &$params) {
166 foreach ($activitySetXML->ActivityTypes
as $activityTypesXML) {
167 foreach ($activityTypesXML as $activityTypeXML) {
168 $this->createActivity($activityTypeXML, $params);
174 * @param $caseRolesXML
175 * @param bool $isCaseManager
177 * @return array|mixed
179 function &caseRoles($caseRolesXML, $isCaseManager = FALSE) {
180 $relationshipTypes = &$this->allRelationshipTypes();
183 foreach ($caseRolesXML as $caseRoleXML) {
184 foreach ($caseRoleXML->RelationshipType
as $relationshipTypeXML) {
185 $relationshipTypeName = (string ) $relationshipTypeXML->name
;
186 $relationshipTypeID = array_search($relationshipTypeName,
189 if ($relationshipTypeID === FALSE) {
193 if (!$isCaseManager) {
194 $result[$relationshipTypeID] = $relationshipTypeName;
196 elseif ($relationshipTypeXML->manager
) {
197 return $relationshipTypeID;
205 * @param $relationshipTypeName
211 function createRelationships($relationshipTypeName, &$params) {
212 $relationshipTypes = &$this->allRelationshipTypes();
213 // get the relationship id
214 $relationshipTypeID = array_search($relationshipTypeName, $relationshipTypes);
216 if ($relationshipTypeID === FALSE) {
217 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
218 CRM_Core_Error
::fatal(ts('Relationship type %1, found in case configuration file, is not present in the database %2',
219 array(1 => $relationshipTypeName, 2 => $docLink)
224 $client = $params['clientID'];
225 if (!is_array($client)) {
226 $client = array($client);
229 foreach ($client as $key => $clientId) {
230 $relationshipParams = array(
231 'relationship_type_id' => $relationshipTypeID,
232 'contact_id_a' => $clientId,
233 'contact_id_b' => $params['creatorID'],
235 'case_id' => $params['caseID'],
236 'start_date' => date("Ymd"),
239 if (!$this->createRelationship($relationshipParams)) {
240 CRM_Core_Error
::fatal();
252 function createRelationship(&$params) {
253 $dao = new CRM_Contact_DAO_Relationship();
254 $dao->copyValues($params);
255 // only create a relationship if it does not exist
256 if (!$dao->find(TRUE)) {
263 * @param $activityTypesXML
264 * @param bool $maxInst
265 * @param bool $isLabel
266 * @param bool $maskAction
270 function activityTypes($activityTypesXML, $maxInst = FALSE, $isLabel = FALSE, $maskAction = FALSE) {
271 $activityTypes = &$this->allActivityTypes(TRUE, TRUE);
273 foreach ($activityTypesXML as $activityTypeXML) {
274 foreach ($activityTypeXML as $recordXML) {
275 $activityTypeName = (string ) $recordXML->name
;
276 $maxInstances = (string ) $recordXML->max_instances
;
277 $activityTypeInfo = CRM_Utils_Array
::value($activityTypeName, $activityTypes);
279 if ($activityTypeInfo['id']) {
281 if ($maskAction == 'edit' && '0' === (string ) $recordXML->editable
) {
282 $result[$maskAction][] = $activityTypeInfo['id'];
287 //if we want,labels of activities should be returned.
289 $result[$activityTypeInfo['id']] = $activityTypeInfo['label'];
292 $result[$activityTypeInfo['id']] = $activityTypeName;
297 $result[$activityTypeName] = $maxInstances;
305 // call option value hook
306 CRM_Utils_Hook
::optionValues($result, 'case_activity_type');
312 * @param SimpleXMLElement $caseTypeXML
313 * @return array<string> symbolic activity-type names
315 function getDeclaredActivityTypes($caseTypeXML) {
318 if (!empty($caseTypeXML->ActivityTypes
) && $caseTypeXML->ActivityTypes
->ActivityType
) {
319 foreach ($caseTypeXML->ActivityTypes
->ActivityType
as $activityTypeXML) {
320 $result[] = (string) $activityTypeXML->name
;
324 if (!empty($caseTypeXML->ActivitySets
) && $caseTypeXML->ActivitySets
->ActivitySet
) {
325 foreach ($caseTypeXML->ActivitySets
->ActivitySet
as $activitySetXML) {
326 if ($activitySetXML->ActivityTypes
&& $activitySetXML->ActivityTypes
->ActivityType
) {
327 foreach ($activitySetXML->ActivityTypes
->ActivityType
as $activityTypeXML) {
328 $result[] = (string) $activityTypeXML->name
;
334 $result = array_unique($result);
340 * @param SimpleXMLElement $caseTypeXML
341 * @return array<string> symbolic relationship-type names
343 function getDeclaredRelationshipTypes($caseTypeXML) {
346 if (!empty($caseTypeXML->CaseRoles
) && $caseTypeXML->CaseRoles
->RelationshipType
) {
347 foreach ($caseTypeXML->CaseRoles
->RelationshipType
as $relTypeXML) {
348 $result[] = (string) $relTypeXML->name
;
352 $result = array_unique($result);
360 function deleteEmptyActivity(&$params) {
361 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
362 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
366 FROM civicrm_activity a
367 INNER JOIN civicrm_activity_contact t ON t.activity_id = a.id
368 WHERE t.contact_id = %1
369 AND t.record_type_id = $targetID
371 AND a.is_current_revision = 1
373 $sqlParams = array(1 => array($params['clientID'], 'Integer'));
374 CRM_Core_DAO
::executeQuery($query, $sqlParams);
382 function isActivityPresent(&$params) {
385 FROM civicrm_activity a
386 INNER JOIN civicrm_case_activity ca on ca.activity_id = a.id
387 WHERE a.activity_type_id = %1
392 $sqlParams = array(1 => array($params['activityTypeID'], 'Integer'),
393 2 => array($params['caseID'], 'Integer'),
395 $count = CRM_Core_DAO
::singleValueQuery($query, $sqlParams);
397 // check for max instance
398 $caseType = CRM_Case_BAO_Case
::getCaseType($params['caseID'], 'name');
399 $maxInstance = self
::getMaxInstance($caseType, $params['activityTypeName']);
401 return $maxInstance ?
($count < $maxInstance ?
FALSE : TRUE) : FALSE;
405 * @param $activityTypeXML
409 * @throws CRM_Core_Exception
412 function createActivity($activityTypeXML, &$params) {
413 $activityTypeName = (string) $activityTypeXML->name
;
414 $activityTypes = &$this->allActivityTypes(TRUE, TRUE);
415 $activityTypeInfo = CRM_Utils_Array
::value($activityTypeName, $activityTypes);
417 if (!$activityTypeInfo) {
418 $docLink = CRM_Utils_System
::docURL2("user/case-management/setup");
419 CRM_Core_Error
::fatal(ts('Activity type %1, found in case configuration file, is not present in the database %2',
420 array(1 => $activityTypeName, 2 => $docLink)
425 $activityTypeID = $activityTypeInfo['id'];
427 if (isset($activityTypeXML->status
)) {
428 $statusName = (string) $activityTypeXML->status
;
431 $statusName = 'Scheduled';
434 if ($this->_isMultiClient
) {
435 $client = $params['clientID'];
438 $client = array(1 => $params['clientID']);
443 if (isset($activityTypeXML->order
)) {
444 $orderVal = (string) $activityTypeXML->order
;
447 if ($activityTypeName == 'Open Case') {
448 $activityParams = array(
449 'activity_type_id' => $activityTypeID,
450 'source_contact_id' => $params['creatorID'],
452 'is_current_revision' => 1,
453 'subject' => CRM_Utils_Array
::value('subject', $params) ?
$params['subject'] : $activityTypeName,
454 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
458 'target_contact_id' => $client,
459 'medium_id' => CRM_Utils_Array
::value('medium_id', $params),
460 'location' => CRM_Utils_Array
::value('location', $params),
461 'details' => CRM_Utils_Array
::value('details', $params),
462 'duration' => CRM_Utils_Array
::value('duration', $params),
463 'weight' => $orderVal,
467 $activityParams = array(
468 'activity_type_id' => $activityTypeID,
469 'source_contact_id' => $params['creatorID'],
471 'is_current_revision' => 1,
472 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
476 'target_contact_id' => $client,
477 'weight' => $orderVal,
481 //parsing date to default preference format
482 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time']);
484 if ($activityTypeName == 'Open Case') {
485 // we don't set activity_date_time for auto generated
486 // activities, but we want it to be set for open case.
487 $activityParams['activity_date_time'] = $params['activity_date_time'];
488 if (array_key_exists('custom', $params) && is_array($params['custom'])) {
489 $activityParams['custom'] = $params['custom'];
492 // Add parameters for attachments
494 $numAttachments = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'max_attachments');
495 for ( $i = 1; $i <= $numAttachments; $i++
) {
496 $attachName = "attachFile_$i";
497 if ( isset( $params[$attachName] ) && !empty( $params[$attachName] ) ) {
498 $activityParams[$attachName] = $params[$attachName];
503 $activityDate = NULL;
504 //get date of reference activity if set.
505 if ($referenceActivityName = (string) $activityTypeXML->reference_activity
) {
507 //we skip open case as reference activity.CRM-4374.
508 if (!empty($params['resetTimeline']) && $referenceActivityName == 'Open Case') {
509 $activityDate = $params['activity_date_time'];
512 $referenceActivityInfo = CRM_Utils_Array
::value($referenceActivityName, $activityTypes);
513 if ($referenceActivityInfo['id']) {
514 $caseActivityParams = array('activity_type_id' => $referenceActivityInfo['id']);
516 //if reference_select is set take according activity.
517 if ($referenceSelect = (string) $activityTypeXML->reference_select
) {
518 $caseActivityParams[$referenceSelect] = 1;
521 $referenceActivity = CRM_Case_BAO_Case
::getCaseActivityDates($params['caseID'], $caseActivityParams, TRUE);
523 if (is_array($referenceActivity)) {
524 foreach ($referenceActivity as $aId => $details) {
525 $activityDate = CRM_Utils_Array
::value('activity_date', $details);
532 if (!$activityDate) {
533 $activityDate = $params['activity_date_time'];
535 list($activity_date, $activity_time) = CRM_Utils_Date
::setDateDefaults($activityDate);
536 $activityDateTime = CRM_Utils_Date
::processDate($activity_date, $activity_time);
537 //add reference offset to date.
538 if ((int) $activityTypeXML->reference_offset
) {
539 $activityDateTime = CRM_Utils_Date
::intervalAdd('day', (int) $activityTypeXML->reference_offset
,
544 $activityParams['activity_date_time'] = CRM_Utils_Date
::format($activityDateTime);
547 // if same activity is already there, skip and dont touch
548 $params['activityTypeID'] = $activityTypeID;
549 $params['activityTypeName'] = $activityTypeName;
550 if ($this->isActivityPresent($params)) {
553 $activityParams['case_id'] = $params['caseID'];
554 if (!empty($activityParams['is_auto'])) {
555 $activityParams['skipRecentView'] = TRUE;
558 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
561 CRM_Core_Error
::fatal();
565 // create case activity record
567 'activity_id' => $activity->id
,
568 'case_id' => $params['caseID'],
570 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
575 * @param $activitySetsXML
579 static function activitySets($activitySetsXML) {
581 foreach ($activitySetsXML as $activitySetXML) {
582 foreach ($activitySetXML as $recordXML) {
583 $activitySetName = (string ) $recordXML->name
;
584 $activitySetLabel = (string ) $recordXML->label
;
585 $result[$activitySetName] = $activitySetLabel;
594 * @param null $activityTypeName
596 * @return array|bool|mixed
599 function getMaxInstance($caseType, $activityTypeName = NULL) {
600 $xml = $this->retrieve($caseType);
602 if ($xml === FALSE) {
603 CRM_Core_Error
::fatal();
607 $activityInstances = $this->activityTypes($xml->ActivityTypes
, TRUE);
608 return $activityTypeName ? CRM_Utils_Array
::value($activityTypeName, $activityInstances) : $activityInstances;
614 * @return array|mixed
616 function getCaseManagerRoleId($caseType) {
617 $xml = $this->retrieve($caseType);
618 return $this->caseRoles($xml->CaseRoles
, TRUE);
622 * @param string $caseType
623 * @return array<\Civi\CCase\CaseChangeListener>
625 function getListeners($caseType) {
626 $xml = $this->retrieve($caseType);
627 $listeners = array();
628 if ($xml->Listeners
&& $xml->Listeners
->Listener
) {
629 foreach ($xml->Listeners
->Listener
as $listenerXML) {
630 $class = (string) $listenerXML;
631 $listeners[] = new $class();
640 function getRedactActivityEmail() {
641 $xml = $this->retrieve("Settings");
642 return ( string ) $xml->RedactActivityEmail ?
1 : 0;
646 * Retrieves AllowMultipleCaseClients setting
648 * @return string 1 if allowed, 0 if not
650 function getAllowMultipleCaseClients() {
651 $xml = $this->retrieve("Settings");
653 return ( string ) $xml->AllowMultipleCaseClients ?
1 : 0;
659 * Retrieves NaturalActivityTypeSort setting
661 * @return string 1 if natural, 0 if alphabetic
663 function getNaturalActivityTypeSort() {
664 $xml = $this->retrieve("Settings");
665 return ( string ) $xml->NaturalActivityTypeSort ?
1 : 0;