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
36 require_once 'packages/When/When.php';
39 * Class CRM_Core_BAO_RecurringEntity
41 class CRM_Core_BAO_RecurringEntity
extends CRM_Core_DAO_RecurringEntity
{
44 public $schedule = array();
45 public $scheduleId = NULL;
46 public $scheduleFormValues = array();
48 public $dateColumns = array();
49 public $overwriteColumns = array();
50 public $intervalDateColumns = array();
51 public $excludeDates = array();
53 public $linkedEntities = array();
55 public $isRecurringEntityRecord = TRUE;
57 protected $recursion = NULL;
58 protected $recursion_start_date = NULL;
60 public static $_entitiesToBeDeleted = array();
62 public static $status = NULL;
64 static $_recurringEntityHelper
66 'civicrm_event' => array(
67 'helper_class' => 'CRM_Event_DAO_Event',
68 'delete_func' => 'delete',
69 'pre_delete_func' => 'CRM_Event_Form_ManageEvent_Repeat::checkRegistrationForEvents',
71 'civicrm_activity' => array(
72 'helper_class' => 'CRM_Activity_DAO_Activity',
73 'delete_func' => 'delete',
74 'pre_delete_func' => '',
80 'civicrm_event' => array(
81 'dateColumns' => array('start_date'),
82 'excludeDateRangeColumns' => array('start_date', 'end_date'),
83 'intervalDateColumns' => array('end_date'),
85 'civicrm_activity' => array(
86 'dateColumns' => array('activity_date_time'),
90 static $_tableDAOMapper
92 'civicrm_event' => 'CRM_Event_DAO_Event',
93 'civicrm_price_set_entity' => 'CRM_Price_DAO_PriceSetEntity',
94 'civicrm_uf_join' => 'CRM_Core_DAO_UFJoin',
95 'civicrm_tell_friend' => 'CRM_Friend_DAO_Friend',
96 'civicrm_pcp_block' => 'CRM_PCP_DAO_PCPBlock',
97 'civicrm_activity' => 'CRM_Activity_DAO_Activity',
98 'civicrm_activity_contact' => 'CRM_Activity_DAO_ActivityContact',
101 static $_updateSkipFields
103 'civicrm_event' => array('start_date', 'end_date'),
104 'civicrm_tell_friend' => array('entity_id'),
105 'civicrm_pcp_block' => array('entity_id'),
106 'civicrm_activity' => array('activity_date_time'),
109 static $_linkedEntitiesInfo
111 'civicrm_tell_friend' => array(
112 'entity_id_col' => 'entity_id',
113 'entity_table_col' => 'entity_table',
115 'civicrm_price_set_entity' => array(
116 'entity_id_col' => 'entity_id',
117 'entity_table_col' => 'entity_table',
118 'is_multirecord' => TRUE,
120 'civicrm_uf_join' => array(
121 'entity_id_col' => 'entity_id',
122 'entity_table_col' => 'entity_table',
123 'is_multirecord' => TRUE,
125 'civicrm_pcp_block' => array(
126 'entity_id_col' => 'entity_id',
127 'entity_table_col' => 'entity_table',
136 public static function getStatus() {
137 return self
::$status;
143 * @param string $status
145 public static function setStatus($status) {
146 self
::$status = $status;
150 * Save records in civicrm_recurring_entity table.
152 * @param array $params
153 * Reference array contains the values submitted by the form.
157 public static function add(&$params) {
158 if (!empty($params['id'])) {
159 CRM_Utils_Hook
::pre('edit', 'RecurringEntity', $params['id'], $params);
162 CRM_Utils_Hook
::pre('create', 'RecurringEntity', NULL, $params);
165 $daoRecurringEntity = new CRM_Core_DAO_RecurringEntity();
166 $daoRecurringEntity->copyValues($params);
167 $daoRecurringEntity->find(TRUE);
168 $result = $daoRecurringEntity->save();
170 if (!empty($params['id'])) {
171 CRM_Utils_Hook
::post('edit', 'RecurringEntity', $daoRecurringEntity->id
, $daoRecurringEntity);
174 CRM_Utils_Hook
::post('create', 'RecurringEntity', $daoRecurringEntity->id
, $daoRecurringEntity);
180 * Wrapper for the function add() to add entry in recurring entity
182 * @param int $parentId
184 * @param int $entityId
186 * @param string $entityTable
187 * Name of the entity table .
192 public static function quickAdd($parentId, $entityId, $entityTable) {
195 'parent_id' => $parentId,
196 'entity_id' => $entityId,
197 'entity_table' => $entityTable,
199 return self
::add($params);
203 * This function updates the mode column in the civicrm_recurring_entity table.
206 * Mode of the entity to cascade changes across parent/child relations eg 1 - only this entity, 2 - this and the following entities, 3 - All the entity .
211 public function mode($mode) {
212 if ($this->entity_id
&& $this->entity_table
) {
213 if ($this->find(TRUE)) {
217 $this->parent_id
= $this->entity_id
;
225 * This function generates all new entities based on object vars.
229 public function generate() {
230 $this->generateRecursiveDates();
232 return $this->generateEntities();
236 * This function builds a "When" object based on schedule/reminder params
241 public function generateRecursion() {
242 // return if already generated
243 if (is_a($this->recursion
, 'When')) {
244 return $this->recursion
;
247 if ($this->scheduleId
) {
249 $this->schedule
= $this->getScheduleParams($this->scheduleId
);
251 elseif (!empty($this->scheduleFormValues
)) {
252 $this->schedule
= $this->mapFormValuesToDB($this->scheduleFormValues
);
255 if (!empty($this->schedule
)) {
256 $this->recursion
= $this->getRecursionFromSchedule($this->schedule
);
258 return $this->recursion
;
262 * Generate new DAOs and along with entries in civicrm_recurring_entity table.
266 public function generateEntities() {
267 self
::setStatus(self
::RUNNING
);
269 $newEntities = array();
270 $findCriteria = array();
271 if (!empty($this->recursionDates
)) {
272 if ($this->entity_id
) {
273 $findCriteria = array('id' => $this->entity_id
);
275 // save an entry with initiating entity-id & entity-table
276 if ($this->entity_table
&& !$this->find(TRUE)) {
277 $this->parent_id
= $this->entity_id
;
281 if (empty($findCriteria)) {
282 CRM_Core_Error
::fatal("Find criteria missing to generate form. Make sure entity_id and table is set.");
286 foreach ($this->recursionDates
as $key => $dateCols) {
287 $newCriteria = $dateCols;
288 foreach ($this->overwriteColumns
as $col => $val) {
289 $newCriteria[$col] = $val;
291 // create main entities
292 $obj = CRM_Core_BAO_RecurringEntity
::copyCreateEntity($this->entity_table
,
295 $this->isRecurringEntityRecord
298 if (is_a($obj, 'CRM_Core_DAO') && $obj->id
) {
299 $newCriteria = array();
300 $newEntities[$this->entity_table
][$count] = $obj->id
;
302 foreach ($this->linkedEntities
as $linkedInfo) {
303 foreach ($linkedInfo['linkedColumns'] as $col) {
304 $newCriteria[$col] = $obj->id
;
306 // create linked entities
307 $linkedObj = CRM_Core_BAO_RecurringEntity
::copyCreateEntity($linkedInfo['table'],
308 $linkedInfo['findCriteria'],
310 CRM_Utils_Array
::value('isRecurringEntityRecord', $linkedInfo, TRUE)
313 if (is_a($linkedObj, 'CRM_Core_DAO') && $linkedObj->id
) {
314 $newEntities[$linkedInfo['table']][$count] = $linkedObj->id
;
322 self
::$status = NULL;
327 * This function iterates through when object criterias and
328 * generates recursive dates based on that
333 public function generateRecursiveDates() {
334 $this->generateRecursion();
336 $recursionDates = array();
337 if (is_a($this->recursion
, 'When')) {
338 $initialCount = CRM_Utils_Array
::value('start_action_offset', $this->schedule
);
340 $exRangeStart = $exRangeEnd = NULL;
341 if (!empty($this->excludeDateRangeColumns
)) {
342 $exRangeStart = $this->excludeDateRangeColumns
[0];
343 $exRangeEnd = $this->excludeDateRangeColumns
[1];
347 while ($result = $this->recursion
->next()) {
349 if ($result == $this->recursion_start_date
) {
350 // skip the recursion-start-date from the list we going to generate
353 $baseDate = CRM_Utils_Date
::processDate($result->format('Y-m-d H:i:s'));
355 foreach ($this->dateColumns
as $col) {
356 $recursionDates[$count][$col] = $baseDate;
358 foreach ($this->intervalDateColumns
as $col => $interval) {
359 $newDate = new DateTime($baseDate);
360 $newDate->add($interval);
361 $recursionDates[$count][$col] = CRM_Utils_Date
::processDate($newDate->format('Y-m-d H:i:s'));
364 $exRangeStartDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value($exRangeStart, $recursionDates[$count]), NULL, FALSE, 'Ymd');
365 $exRangeEndDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value($exRangeEnd, $recursionDates[$count]), NULL, FALSE, 'Ymd');
368 foreach ($this->excludeDates
as $exDate) {
369 $exDate = CRM_Utils_Date
::processDate($exDate, NULL, FALSE, 'Ymd');
370 if (!$exRangeStart) {
371 if ($exDate == $result->format('Ymd')) {
377 if (($exDate == $exRangeStartDate) ||
378 ($exRangeEndDate && ($exDate > $exRangeStartDate) && ($exDate <= $exRangeEndDate))
387 unset($recursionDates[$count]);
388 if ($initialCount && ($initialCount > 0)) {
389 // lets increase the counter, so we get correct number of occurrences
391 $this->recursion
->count($initialCount);
398 $this->recursionDates
= $recursionDates;
400 return $recursionDates;
404 * This function gets all the children for a particular parent entity.
406 * @param int $parentId
408 * @param string $entityTable
409 * Name of the entity table .
410 * @param bool $includeParent
411 * If true parent id is included in result set and vice versa .
413 * 1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. .
414 * @param int $initiatorId
415 * The instance where this function is invoked from .
419 * an array of child ids
421 static public function getEntitiesForParent($parentId, $entityTable, $includeParent = TRUE, $mode = 3, $initiatorId = NULL) {
423 if (empty($parentId) ||
empty($entityTable)) {
428 $initiatorId = $parentId;
431 $queryParams = array(
432 1 => array($parentId, 'Integer'),
433 2 => array($entityTable, 'String'),
434 3 => array($initiatorId, 'Integer'),
438 $mode = CRM_Core_DAO
::singleValueQuery("SELECT mode FROM civicrm_recurring_entity WHERE entity_id = %3 AND entity_table = %2", $queryParams);
442 FROM civicrm_recurring_entity
443 WHERE parent_id = %1 AND entity_table = %2";
444 if (!$includeParent) {
445 $query .= " AND entity_id != " . ($initiatorId ?
"%3" : "%1");
450 $query .= " AND entity_id = %3";
453 elseif ($mode == '2') {
454 $recurringEntityID = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_recurring_entity WHERE entity_id = %3 AND entity_table = %2", $queryParams);
455 if ($recurringEntityID) {
456 $query .= $includeParent ?
" AND id >= %4" : " AND id > %4";
457 $query .= " ORDER BY id ASC"; // FIXME: change to order by dates
458 $queryParams[4] = array($recurringEntityID, 'Integer');
461 // something wrong, return empty
466 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
467 while ($dao->fetch()) {
468 $entities["{$dao->entity_table}_{$dao->entity_id}"]['table'] = $dao->entity_table
;
469 $entities["{$dao->entity_table}_{$dao->entity_id}"]['id'] = $dao->entity_id
;
475 * This function when passed an entity id checks if it has parent and
476 * returns all other entities that are connected to same parent.
478 * @param int $entityId
480 * @param string $entityTable
481 * Entity table name .
482 * @param bool $includeParent
483 * Include parent in result set .
485 * 1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. .
489 * array of connected ids
491 static public function getEntitiesFor($entityId, $entityTable, $includeParent = TRUE, $mode = 3) {
492 $parentId = self
::getParentFor($entityId, $entityTable);
494 return self
::getEntitiesForParent($parentId, $entityTable, $includeParent, $mode, $entityId);
500 * This function gets the parent for the entity id passed to it.
502 * @param int $entityId
504 * @param string $entityTable
505 * Entity table name .
506 * @param bool $includeParent
507 * Include parent in result set .
511 * unsigned $parentId Parent ID
513 static public function getParentFor($entityId, $entityTable, $includeParent = TRUE) {
514 if (empty($entityId) ||
empty($entityTable)) {
520 FROM civicrm_recurring_entity
521 WHERE entity_id = %1 AND entity_table = %2";
522 if (!$includeParent) {
523 $query .= " AND parent_id != %1";
526 = CRM_Core_DAO
::singleValueQuery($query,
528 1 => array($entityId, 'Integer'),
529 2 => array($entityTable, 'String'),
536 * This function copies the information from parent entity and creates other entities with same information.
538 * @param string $entityTable
539 * Entity table name .
540 * @param array $fromCriteria
541 * Array of all the fields & values on which basis to copy .
542 * @param array $newParams
543 * Array of all the fields & values to be copied besides the other fields .
544 * @param bool $createRecurringEntity
545 * If to create a record in recurring_entity table .
550 static public function copyCreateEntity($entityTable, $fromCriteria, $newParams, $createRecurringEntity = TRUE) {
551 $daoName = self
::$_tableDAOMapper[$entityTable];
553 CRM_Core_Error
::fatal("DAO Mapper missing for $entityTable.");
555 $newObject = CRM_Core_DAO
::copyGeneric($daoName, $fromCriteria, $newParams);
557 if (is_a($newObject, 'CRM_Core_DAO') && $newObject->id
&& $createRecurringEntity) {
558 $object = new $daoName();
559 foreach ($fromCriteria as $key => $value) {
560 $object->$key = $value;
564 CRM_Core_BAO_RecurringEntity
::quickAdd($object->id
, $newObject->id
, $entityTable);
570 * This function acts as a listener to dao->update whenever there is an update,
571 * and propagates any changes to all related entities present in recurring entity table
573 * @param object $event
574 * An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just updated .
579 static public function triggerUpdate($event) {
580 // if DB version is earlier than 4.6 skip any processing
581 static $currentVer = NULL;
583 $currentVer = CRM_Core_BAO_Domain
::version();
585 if (version_compare($currentVer, '4.6.alpha1') < 0) {
589 static $processedEntities = array();
590 $obj =& $event->object;
591 if (empty($obj->id
) ||
empty($obj->__table
)) {
594 $key = "{$obj->__table}_{$obj->id}";
596 if (array_key_exists($key, $processedEntities)) {
601 // get related entities
602 $repeatingEntities = self
::getEntitiesFor($obj->id
, $obj->__table
, FALSE, NULL);
603 if (empty($repeatingEntities)) {
604 // return if its not a recurring entity parent
607 // mark being processed
608 $processedEntities[$key] = 1;
610 // to make sure we not copying to source itself
611 unset($repeatingEntities[$key]);
613 foreach ($repeatingEntities as $key => $val) {
614 $entityID = $val['id'];
615 $entityTable = $val['table'];
617 $processedEntities[$key] = 1;
619 if (array_key_exists($entityTable, self
::$_tableDAOMapper)) {
620 $daoName = self
::$_tableDAOMapper[$entityTable];
623 if (array_key_exists($entityTable, self
::$_updateSkipFields)) {
624 $skipFields = self
::$_updateSkipFields[$entityTable];
625 foreach ($skipFields as $sfield) {
626 $skipData[$sfield] = NULL;
630 $updateDAO = CRM_Core_DAO
::cascadeUpdate($daoName, $obj->id
, $entityID, $skipData);
631 CRM_Core_DAO
::freeResult();
634 CRM_Core_Error
::fatal("DAO Mapper missing for $entityTable.");
637 // done with processing. lets unset static var.
638 unset($processedEntities);
642 * This function acts as a listener to dao->save,
643 * and creates entries for linked entities in recurring entity table
645 * @param object $event
646 * An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just inserted .
651 static public function triggerInsert($event) {
652 $obj =& $event->object;
653 if (!array_key_exists($obj->__table
, self
::$_linkedEntitiesInfo)) {
657 // if DB version is earlier than 4.6 skip any processing
658 static $currentVer = NULL;
660 $currentVer = CRM_Core_BAO_Domain
::version();
662 if (version_compare($currentVer, '4.6.alpha1') < 0) {
666 static $processedEntities = array();
667 if (empty($obj->id
) ||
empty($obj->__table
)) {
670 $key = "{$obj->__table}_{$obj->id}";
672 if (array_key_exists($key, $processedEntities)) {
673 // already being processed. Exit recursive calls.
677 if (self
::getStatus() == self
::RUNNING
) {
678 // if recursion->generate() is doing some work, lets not intercept
682 // mark being processed
683 $processedEntities[$key] = 1;
685 // get related entities for table being saved
686 $hasaRecurringRecord = self
::getParentFor($obj->id
, $obj->__table
);
688 if (empty($hasaRecurringRecord)) {
689 // check if its a linked entity
690 if (array_key_exists($obj->__table
, self
::$_linkedEntitiesInfo) &&
691 !CRM_Utils_Array
::value('is_multirecord', self
::$_linkedEntitiesInfo[$obj->__table
])
693 $linkedDAO = new self
::$_tableDAOMapper[$obj->__table
]();
694 $linkedDAO->id
= $obj->id
;
695 if ($linkedDAO->find(TRUE)) {
696 $idCol = self
::$_linkedEntitiesInfo[$obj->__table
]['entity_id_col'];
697 $tableCol = self
::$_linkedEntitiesInfo[$obj->__table
]['entity_table_col'];
699 $pEntityID = $linkedDAO->$idCol;
700 $pEntityTable = $linkedDAO->$tableCol;
702 // find all parent recurring entity set
703 $pRepeatingEntities = self
::getEntitiesFor($pEntityID, $pEntityTable);
705 if (!empty($pRepeatingEntities)) {
706 // for each parent entity in the set, find out a similar linked entity,
707 // if doesn't exist create one, and also create entries in recurring_entity table
709 foreach ($pRepeatingEntities as $key => $val) {
710 if (array_key_exists($key, $processedEntities)) {
711 // this graph is already being processed
714 $processedEntities[$key] = 1;
717 // start with first entry with just itself
718 CRM_Core_BAO_RecurringEntity
::quickAdd($obj->id
, $obj->id
, $obj->__table
);
720 foreach ($pRepeatingEntities as $key => $val) {
721 $rlinkedDAO = new self
::$_tableDAOMapper[$obj->__table
]();
722 $rlinkedDAO->$idCol = $val['id'];
723 $rlinkedDAO->$tableCol = $val['table'];
724 if ($rlinkedDAO->find(TRUE)) {
725 CRM_Core_BAO_RecurringEntity
::quickAdd($obj->id
, $rlinkedDAO->id
, $obj->__table
);
728 // linked entity doesn't exist. lets create them
729 $newCriteria = array(
730 $idCol => $val['id'],
731 $tableCol => $val['table'],
733 $linkedObj = CRM_Core_BAO_RecurringEntity
::copyCreateEntity($obj->__table
,
734 array('id' => $obj->id
),
738 if ($linkedObj->id
) {
739 CRM_Core_BAO_RecurringEntity
::quickAdd($obj->id
, $linkedObj->id
, $obj->__table
);
748 // done with processing. lets unset static var.
749 unset($processedEntities);
753 * This function acts as a listener to dao->delete, and deletes an entry from recurring_entity table
755 * @param object $event
756 * An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just deleted .
761 static public function triggerDelete($event) {
762 $obj =& $event->object;
764 // if DB version is earlier than 4.6 skip any processing
765 static $currentVer = NULL;
767 $currentVer = CRM_Core_BAO_Domain
::version();
769 if (version_compare($currentVer, '4.6.alpha1') < 0) {
773 static $processedEntities = array();
774 if (empty($obj->id
) ||
empty($obj->__table
) ||
!$event->result
) {
777 $key = "{$obj->__table}_{$obj->id}";
779 if (array_key_exists($key, $processedEntities)) {
784 // mark being processed
785 $processedEntities[$key] = 1;
787 $parentID = self
::getParentFor($obj->id
, $obj->__table
);
789 CRM_Core_BAO_RecurringEntity
::delEntity($obj->id
, $obj->__table
, TRUE);
794 * This function deletes main entity and related linked entities from recurring-entity table
796 * @param int $entityId
798 * @param string $entityTable
799 * Name of the entity table
802 * @return bool|CRM_Core_DAO_RecurringEntity
804 static public function delEntity($entityId, $entityTable, $isDelLinkedEntities = FALSE) {
805 if (empty($entityId) ||
empty($entityTable)) {
808 $dao = new CRM_Core_DAO_RecurringEntity();
809 $dao->entity_id
= $entityId;
810 $dao->entity_table
= $entityTable;
811 if ($dao->find(TRUE)) {
812 // make sure its not a linked entity thats being deleted
813 if ($isDelLinkedEntities && !array_key_exists($entityTable, self
::$_linkedEntitiesInfo)) {
814 // delete all linked entities from recurring entity table
815 foreach (self
::$_linkedEntitiesInfo as $linkedTable => $linfo) {
816 $daoName = self
::$_tableDAOMapper[$linkedTable];
818 CRM_Core_Error
::fatal("DAO Mapper missing for $linkedTable.");
821 $linkedDao = new $daoName();
822 $linkedDao->$linfo['entity_id_col'] = $entityId;
823 $linkedDao->$linfo['entity_table_col'] = $entityTable;
825 while ($linkedDao->fetch()) {
826 CRM_Core_BAO_RecurringEntity
::delEntity($linkedDao->id
, $linkedTable, FALSE);
830 // delete main entity
831 return $dao->delete();
837 * This function maps values posted from form to civicrm_action_schedule columns.
839 * @param array $formParams
840 * And array of form values posted .
844 public function mapFormValuesToDB($formParams = array()) {
846 if (!empty($formParams['used_for'])) {
847 $dbParams['used_for'] = $formParams['used_for'];
850 if (!empty($formParams['entity_id'])) {
851 $dbParams['entity_value'] = $formParams['entity_id'];
854 if (!empty($formParams['repetition_start_date'])) {
855 if (!empty($formParams['repetition_start_date_display'])) {
856 $repetitionStartDate = $formParams['repetition_start_date_display'];
859 $repetitionStartDate = $formParams['repetition_start_date'];
861 if (!empty($formParams['repetition_start_date_time'])) {
862 $repetitionStartDate = $repetitionStartDate . " " . $formParams['repetition_start_date_time'];
864 $repetition_start_date = new DateTime($repetitionStartDate);
865 $dbParams['start_action_date'] = CRM_Utils_Date
::processDate($repetition_start_date->format('Y-m-d H:i:s'));
868 if (!empty($formParams['repetition_frequency_unit'])) {
869 $dbParams['repetition_frequency_unit'] = $formParams['repetition_frequency_unit'];
872 if (!empty($formParams['repetition_frequency_interval'])) {
873 $dbParams['repetition_frequency_interval'] = $formParams['repetition_frequency_interval'];
876 //For Repeats on:(weekly case)
877 if ($formParams['repetition_frequency_unit'] == 'week') {
878 if (!empty($formParams['start_action_condition'])) {
879 $repeats_on = CRM_Utils_Array
::value('start_action_condition', $formParams);
880 $dbParams['start_action_condition'] = implode(",", array_keys($repeats_on));
884 //For Repeats By:(monthly case)
885 if ($formParams['repetition_frequency_unit'] == 'month') {
886 if ($formParams['repeats_by'] == 1) {
887 if (!empty($formParams['limit_to'])) {
888 $dbParams['limit_to'] = $formParams['limit_to'];
891 if ($formParams['repeats_by'] == 2) {
892 if (CRM_Utils_Array
::value('entity_status_1', $formParams) && CRM_Utils_Array
::value('entity_status_2', $formParams)) {
893 $dbParams['entity_status'] = $formParams['entity_status_1'] . " " . $formParams['entity_status_2'];
898 //For "Ends" - After:
899 if ($formParams['ends'] == 1) {
900 if (!empty($formParams['start_action_offset'])) {
901 $dbParams['start_action_offset'] = $formParams['start_action_offset'];
906 if ($formParams['ends'] == 2) {
907 if (!empty($formParams['repeat_absolute_date'])) {
908 $dbParams['absolute_date'] = CRM_Utils_Date
::processDate($formParams['repeat_absolute_date']);
915 * This function gets all the columns of civicrm_action_schedule table based on id(primary key)
917 * @param int $scheduleReminderId
918 * Primary key of civicrm_action_schedule table .
923 static public function getScheduleReminderDetailsById($scheduleReminderId) {
925 FROM civicrm_action_schedule WHERE 1";
926 if ($scheduleReminderId) {
930 $dao = CRM_Core_DAO
::executeQuery($query,
932 1 => array($scheduleReminderId, 'Integer'),
940 * wrapper of getScheduleReminderDetailsById function.
942 * @param int $scheduleReminderId
943 * Primary key of civicrm_action_schedule table .
947 public function getScheduleParams($scheduleReminderId) {
948 $scheduleReminderDetails = array();
949 if ($scheduleReminderId) {
950 //Get all the details from schedule reminder table
951 $scheduleReminderDetails = self
::getScheduleReminderDetailsById($scheduleReminderId);
952 $scheduleReminderDetails = (array) $scheduleReminderDetails;
954 return $scheduleReminderDetails;
958 * This function takes criterias saved in civicrm_action_schedule table
959 * and creates recursion rule
961 * @param array $scheduleReminderDetails
962 * Array of repeat criterias saved in civicrm_action_schedule table .
967 public function getRecursionFromSchedule($scheduleReminderDetails = array()) {
969 //If there is some data for this id
970 if ($scheduleReminderDetails['repetition_frequency_unit']) {
971 if ($scheduleReminderDetails['start_action_date']) {
972 $currDate = date('Y-m-d H:i:s', strtotime($scheduleReminderDetails['start_action_date']));
975 $currDate = date("Y-m-d H:i:s");
977 $start = new DateTime($currDate);
978 $this->recursion_start_date
= $start;
979 if ($scheduleReminderDetails['repetition_frequency_unit']) {
980 $repetition_frequency_unit = $scheduleReminderDetails['repetition_frequency_unit'];
981 if ($repetition_frequency_unit == "day") {
982 $repetition_frequency_unit = "dai";
984 $repetition_frequency_unit = $repetition_frequency_unit . 'ly';
985 $r->recur($start, $repetition_frequency_unit);
988 if ($scheduleReminderDetails['repetition_frequency_interval']) {
989 $r->interval($scheduleReminderDetails['repetition_frequency_interval']);
992 $r->errors
[] = 'Repeats every: is a required field';
996 if ($scheduleReminderDetails['repetition_frequency_unit'] == 'week') {
997 if ($scheduleReminderDetails['start_action_condition']) {
998 $startActionCondition = $scheduleReminderDetails['start_action_condition'];
999 $explodeStartActionCondition = explode(',', $startActionCondition);
1000 $buildRuleArray = array();
1001 foreach ($explodeStartActionCondition as $key => $val) {
1002 $buildRuleArray[] = strtoupper(substr($val, 0, 2));
1004 $r->wkst('MO')->byday($buildRuleArray);
1009 if ($scheduleReminderDetails['repetition_frequency_unit'] == 'month') {
1010 if ($scheduleReminderDetails['entity_status']) {
1011 $startActionDate = explode(" ", $scheduleReminderDetails['entity_status']);
1012 switch ($startActionDate[0]) {
1014 $startActionDate1 = 1;
1018 $startActionDate1 = 2;
1022 $startActionDate1 = 3;
1026 $startActionDate1 = 4;
1030 $startActionDate1 = -1;
1033 $concatStartActionDateBits = $startActionDate1 . strtoupper(substr($startActionDate[1], 0, 2));
1034 $r->byday(array($concatStartActionDateBits));
1036 elseif ($scheduleReminderDetails['limit_to']) {
1037 $r->bymonthday(array($scheduleReminderDetails['limit_to']));
1042 if ($scheduleReminderDetails['start_action_offset']) {
1043 if ($scheduleReminderDetails['start_action_offset'] > 30) {
1044 $r->errors
[] = 'Occurrences should be less than or equal to 30';
1046 $r->count($scheduleReminderDetails['start_action_offset']);
1049 if (!empty($scheduleReminderDetails['absolute_date'])) {
1050 $absoluteDate = CRM_Utils_Date
::setDateDefaults($scheduleReminderDetails['absolute_date']);
1051 $endDate = new DateTime($absoluteDate[0] . ' ' . $absoluteDate[1]);
1052 $endDate->modify('+1 day');
1053 $r->until($endDate);
1056 if (!$scheduleReminderDetails['start_action_offset'] && !$scheduleReminderDetails['absolute_date']) {
1057 $r->errors
[] = 'Ends: is a required field';
1061 $r->errors
[] = 'Repeats: is a required field';
1068 * This function gets time difference between the two datetime object.
1070 * @param DateTime $startDate
1072 * @param DateTime $endDate
1077 * DateTime object which contain time difference
1079 static public function getInterval($startDate, $endDate) {
1080 if ($startDate && $endDate) {
1081 $startDate = new DateTime($startDate);
1082 $endDate = new DateTime($endDate);
1083 return $startDate->diff($endDate);
1088 * This function gets all columns from civicrm_action_schedule on the basis of event id.
1090 * @param int $entityId
1092 * @param string $used_for
1093 * Specifies for which entity type it's used for .
1098 public static function getReminderDetailsByEntityId($entityId, $used_for) {
1102 FROM civicrm_action_schedule
1103 WHERE entity_value = %1";
1105 $query .= " AND used_for = %2";
1108 1 => array($entityId, 'Integer'),
1109 2 => array($used_for, 'String'),
1111 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1118 * Update mode column in civicrm_recurring_entity table for event related tabs.
1120 * @param int $entityId
1122 * @param string $linkedEntityTable
1123 * Linked entity table name for this event .
1126 public static function updateModeLinkedEntity($entityId, $linkedEntityTable, $mainEntityTable) {
1128 if ($entityId && $linkedEntityTable && $mainEntityTable) {
1129 if (CRM_Utils_Array
::value($linkedEntityTable, self
::$_tableDAOMapper)) {
1130 $dao = self
::$_tableDAOMapper[$linkedEntityTable];
1133 CRM_Core_Session
::setStatus('Could not update mode for linked entities');
1136 $entityTable = $linkedEntityTable;
1138 'entity_id' => $entityId,
1139 'entity_table' => $mainEntityTable,
1141 $defaults = array();
1142 CRM_Core_DAO
::commonRetrieve($dao, $params, $defaults);
1143 if (!empty($defaults['id'])) {
1144 $result['entityId'] = $defaults['id'];
1145 $result['entityTable'] = $entityTable;