3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
29 * Class CRM_Core_BAO_RecurringEntityTest
32 class CRM_Core_BAO_RecurringEntityTest
extends CiviUnitTestCase
{
35 * Sets up the fixture, for example, opens a network connection.
36 * This method is called before a test is executed.
38 protected function setUp() {
43 * Tears down the fixture, for example, closes a network connection.
44 * This method is called after a test is executed.
46 protected function tearDown() {
50 * Testing Activity Generation through Entity Recursion.
52 public function testActivityGeneration() {
53 //Activity set initial params
54 $daoActivity = new CRM_Activity_DAO_Activity();
55 $daoActivity->activity_type_id
= 1;
56 $daoActivity->subject
= "Initial Activity";
57 $daoActivity->activity_date_time
= '20141002103000';
60 $recursion = new CRM_Core_BAO_RecurringEntity();
61 $recursion->entity_id
= $daoActivity->id
;
62 $recursion->entity_table
= 'civicrm_activity';
63 $recursion->dateColumns
= array('activity_date_time');
64 $recursion->schedule
= array(
65 'entity_value' => $daoActivity->id
,
66 'start_action_date' => $daoActivity->activity_date_time
,
67 'entity_status' => 'fourth saturday',
68 'repetition_frequency_unit' => 'month',
69 'repetition_frequency_interval' => 3,
70 'start_action_offset' => 5,
71 'used_for' => 'activity',
74 $generatedEntities = $recursion->generate();
75 $this->assertEquals(5, count($generatedEntities['civicrm_activity']), "Cehck if number of iterations are 5");
76 $expectedDates = array(
83 foreach ($generatedEntities['civicrm_activity'] as $entityID) {
84 $this->assertDBNotNull('CRM_Activity_DAO_Activity', $entityID, 'id',
85 'id', 'Check DB if repeating activities were created'
89 // set mode to ALL, i.e any change to changing activity affects all related recurring activities
92 // lets change subject of initial activity that we created in beginning
93 $daoActivity->find(TRUE);
94 $daoActivity->subject
= 'Changed Activity';
97 // check if other activities were affected
98 $actualDates = array();
99 foreach ($generatedEntities['civicrm_activity'] as $entityID) {
100 $this->assertDBCompareValue('CRM_Activity_DAO_Activity', $entityID, 'subject', 'id', 'Changed Activity', 'Check if subject was updated');
101 $actualDates[] = date('YmdHis', strtotime(CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $entityID, 'activity_date_time', 'id')));
103 $resultDates = array_diff($actualDates, $expectedDates);
104 $this->assertEquals(0, count($resultDates), "Check if all the value in expected array matches actual array");
109 * Testing Event Generation through Entity Recursion.
111 public function testEventGeneration() {
112 //Event set initial params
113 $daoEvent = new CRM_Event_DAO_Event();
114 $daoEvent->title
= 'Test event for Recurring Entity';
115 $daoEvent->event_type_id
= 3;
116 $daoEvent->is_public
= 1;
117 $daoEvent->start_date
= date('YmdHis', strtotime('2014-10-26 10:30:00'));
118 $daoEvent->end_date
= date('YmdHis', strtotime('2014-10-28 10:30:00'));
119 $daoEvent->created_date
= date('YmdHis');
120 $daoEvent->is_active
= 1;
122 $this->assertDBNotNull('CRM_Event_DAO_Event', $daoEvent->id
, 'id', 'id', 'Check DB if event was created');
124 //Create tell a friend for event
125 $daoTellAFriend = new CRM_Friend_DAO_Friend();
126 $daoTellAFriend->entity_table
= 'civicrm_event';
127 $daoTellAFriend->entity_id
= $daoEvent->id
; // join with event
128 $daoTellAFriend->title
= 'Testing tell a friend';
129 $daoTellAFriend->is_active
= 1;
130 $daoTellAFriend->save();
131 $this->assertDBNotNull('CRM_Friend_DAO_Friend', $daoTellAFriend->id
, 'id', 'id', 'Check DB if tell a friend was created');
133 // time to use recursion
134 $recursion = new CRM_Core_BAO_RecurringEntity();
135 $recursion->entity_id
= $daoEvent->id
;
136 $recursion->entity_table
= 'civicrm_event';
137 $recursion->dateColumns
= array('start_date');
138 $recursion->schedule
= array(
139 'entity_value' => $daoEvent->id
,
140 'start_action_date' => $daoEvent->start_date
,
141 'start_action_condition' => 'monday',
142 'repetition_frequency_unit' => 'week',
143 'repetition_frequency_interval' => 1,
144 'start_action_offset' => 4,
145 'used_for' => 'event',
148 $recursion->linkedEntities
= array(
150 'table' => 'civicrm_tell_friend',
151 'findCriteria' => array(
152 'entity_id' => $recursion->entity_id
,
153 'entity_table' => 'civicrm_event',
155 'linkedColumns' => array('entity_id'),
156 'isRecurringEntityRecord' => TRUE,
160 $interval = $recursion->getInterval($daoEvent->start_date
, $daoEvent->end_date
);
161 $recursion->intervalDateColumns
= array('end_date' => $interval);
162 $generatedEntities = $recursion->generate();
163 $this->assertArrayHasKey('civicrm_event', $generatedEntities, 'Check if generatedEntities has civicrm_event as required key');
164 $expectedDates = array(
165 '20141027103000' => '20141029103000',
166 '20141103103000' => '20141105103000',
167 '20141110103000' => '20141112103000',
168 '20141117103000' => '20141119103000',
171 $this->assertCount($recursion->schedule
['start_action_offset'], $generatedEntities['civicrm_event'], 'Check if the number of events created are right');
172 $actualDates = array();
173 foreach ($generatedEntities['civicrm_event'] as $key => $val) {
174 $this->assertDBNotNull('CRM_Event_DAO_Event', $val, 'id', 'id', 'Check if repeating events were created.');
175 $startDate = date('YmdHis', strtotime(CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $val, 'start_date', 'id')));
176 $endDate = date('YmdHis', strtotime(CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $val, 'end_date', 'id')));
177 $actualDates[$startDate] = $endDate;
180 $resultDates = array_diff($actualDates, $expectedDates);
181 $this->assertEquals(0, count($resultDates), "Check if all the value in expected array matches actual array");
183 foreach ($generatedEntities['civicrm_tell_friend'] as $key => $val) {
184 $this->assertDBNotNull('CRM_Friend_DAO_Friend', $val, 'id', 'id', 'Check if friends were created in loop');
185 $this->assertDBCompareValue('CRM_Friend_DAO_Friend', $val, 'entity_id', 'id', $generatedEntities['civicrm_event'][$key], 'Check DB if correct FK was maintained with event for Friend');
187 $this->assertCount($recursion->schedule
['start_action_offset'], $generatedEntities['civicrm_tell_friend'], 'Check if the number of tell a friend records are right');
189 // set mode to ALL, i.e any change to changing event affects all related recurring activities
192 $daoEvent->find(TRUE);
193 $daoEvent->title
= 'Event Changed';
196 // check if other events were affected
197 foreach ($generatedEntities['civicrm_event'] as $entityID) {
198 $this->assertDBCompareValue('CRM_Event_DAO_Event', $entityID, 'title', 'id', 'Event Changed', 'Check if title was updated');
201 end($generatedEntities['civicrm_event']);
202 $key = key($generatedEntities['civicrm_event']);
204 end($generatedEntities['civicrm_tell_friend']);
205 $actKey = key($generatedEntities['civicrm_tell_friend']);
207 //Check if both(event/tell a friend) keys are same
208 $this->assertEquals($key, $actKey, "Check if both the keys are same");
210 //Cross check event exists before we test deletion
211 $searchParamsEventBeforeDelete = array(
212 'entity_id' => $generatedEntities['civicrm_event'][$key],
213 'entity_table' => 'civicrm_event',
215 $expectedValuesEventBeforeDelete = array(
216 'entity_id' => $generatedEntities['civicrm_event'][$key],
217 'entity_table' => 'civicrm_event',
219 $this->assertDBCompareValues('CRM_Core_DAO_RecurringEntity', $searchParamsEventBeforeDelete, $expectedValuesEventBeforeDelete);
221 //Cross check event exists before we test deletion
222 $searchParamsTellAFriendBeforeDelete = array(
223 'entity_id' => $generatedEntities['civicrm_tell_friend'][$actKey],
224 'entity_table' => 'civicrm_tell_friend',
226 $expectedValuesTellAFriendBeforeDelete = array(
227 'entity_id' => $generatedEntities['civicrm_tell_friend'][$actKey],
228 'entity_table' => 'civicrm_tell_friend',
230 $this->assertDBCompareValues('CRM_Core_DAO_RecurringEntity', $searchParamsTellAFriendBeforeDelete, $expectedValuesTellAFriendBeforeDelete);
232 //Delete an event from recurring set and respective linked entity should be deleted from civicrm_recurring_entity_table
233 $daoRecurEvent = new CRM_Event_DAO_Event();
234 $daoRecurEvent->id
= $generatedEntities['civicrm_event'][$key];
235 if ($daoRecurEvent->find(TRUE)) {
236 $daoRecurEvent->delete();
237 $daoRecurEvent->free();
240 //Check if this event_id was deleted
241 $this->assertDBNull('CRM_Event_DAO_Event', $generatedEntities['civicrm_event'][$key], 'id', 'id', 'Check if event was deleted');
242 $searchParams = array(
243 'entity_id' => $generatedEntities['civicrm_event'][$key],
244 'entity_table' => 'civicrm_event',
246 $compareParams = array();
247 $this->assertDBCompareValues('CRM_Core_DAO_RecurringEntity', $searchParams, $compareParams);
249 //Find tell_a_friend id if that was deleted from civicrm
250 $searchActParams = array(
251 'entity_id' => $generatedEntities['civicrm_tell_friend'][$actKey],
252 'entity_table' => 'civicrm_tell_friend',
254 $compareActParams = array();
255 $this->assertDBCompareValues('CRM_Friend_DAO_Friend', $searchActParams, $compareActParams);