Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class contains the funtions for Friend | |
38 | * | |
39 | */ | |
40 | class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { | |
41 | function __construct() { | |
42 | parent::__construct(); | |
43 | } | |
44 | ||
45 | /** | |
46 | * takes an associative array and creates a friend object | |
47 | * | |
48 | * the function extract all the params it needs to initialize the create a | |
49 | * friend object. the params array could contain additional unused name/value | |
50 | * pairs | |
51 | * | |
52 | * @param array $params (reference ) an assoc array of name/value pairs | |
53 | * | |
54 | * @return object CRM_Friend_BAO_Friend object | |
55 | * @access public | |
56 | * @static | |
57 | */ | |
58 | static function add(&$params) { | |
59 | $friend = CRM_Contact_BAO_Contact::createProfileContact($params, CRM_Core_DAO::$_nullArray); | |
60 | return $friend; | |
61 | } | |
62 | ||
63 | /** | |
64 | * Given the list of params in the params array, fetch the object | |
65 | * and store the values in the values array | |
66 | * | |
67 | * @param array $params input parameters to find object | |
68 | * @param array $values output values of the object | |
69 | * | |
70 | * @return array $values values | |
71 | * @access public | |
72 | * @static | |
73 | */ | |
74 | static function retrieve(&$params, &$values) { | |
75 | $friend = new CRM_Friend_DAO_Friend(); | |
76 | ||
77 | $friend->copyValues($params); | |
78 | ||
79 | $friend->find(TRUE); | |
80 | ||
81 | CRM_Core_DAO::storeValues($friend, $values); | |
82 | ||
83 | return $values; | |
84 | } | |
85 | ||
86 | /** | |
87 | * takes an associative array and creates a friend object | |
88 | * | |
89 | * @param array $params (reference ) an assoc array of name/value pairs | |
90 | * | |
91 | * @return object CRM_Contact_BAO_Contact object | |
92 | * @access public | |
93 | * @static | |
94 | */ | |
95 | static function create(&$params) { | |
96 | $transaction = new CRM_Core_Transaction(); | |
97 | ||
98 | $mailParams = array(); | |
99 | //create contact corresponding to each friend | |
100 | foreach ($params['friend'] as $key => $details) { | |
101 | if ($details["first_name"]) { | |
102 | $contactParams[$key] = array( | |
103 | 'first_name' => $details["first_name"], | |
104 | 'last_name' => $details["last_name"], | |
105 | 'contact_source' => ts('Tell a Friend') . ": {$params['title']}", | |
106 | 'email-Primary' => $details["email"], | |
107 | ); | |
108 | ||
109 | $displayName = $details["first_name"] . " " . $details["last_name"]; | |
110 | $mailParams['email'][$displayName] = $details["email"]; | |
111 | } | |
112 | } | |
113 | ||
114 | $frndParams = array(); | |
115 | $frndParams['entity_id'] = $params['entity_id']; | |
116 | $frndParams['entity_table'] = $params['entity_table']; | |
117 | self::getValues($frndParams); | |
118 | ||
119 | ||
120 | $activityTypeId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', 'Tell a Friend', 'value', 'name'); | |
121 | ||
122 | //create activity | |
123 | $activityParams = array( | |
124 | 'source_contact_id' => $params['source_contact_id'], | |
125 | 'source_record_id' => NULL, | |
126 | 'activity_type_id' => $activityTypeId, | |
127 | 'title' => $params['title'], | |
128 | 'activity_date_time' => date("YmdHis"), | |
129 | 'subject' => ts('Tell a Friend') . ": {$params['title']}", | |
130 | 'details' => $params['suggested_message'], | |
131 | 'status_id' => 2, | |
132 | 'is_test' => $params['is_test'], | |
133 | 'campaign_id' => CRM_Utils_Array::value('campaign_id', $params), | |
134 | ); | |
135 | ||
136 | //activity creation | |
137 | $activity = CRM_Activity_BAO_Activity::create($activityParams); | |
9e74e3ce | 138 | $activityContacts = CRM_Core_PseudoConstant::activityContacts('name'); |
139 | $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts); | |
140 | ||
6a488035 TO |
141 | //friend contacts creation |
142 | foreach ($contactParams as $key => $value) { | |
143 | ||
144 | //create contact only if it does not exits in db | |
145 | $value['email'] = $value['email-Primary']; | |
146 | $value['check_permission'] = FALSE; | |
147 | $contact = CRM_Core_BAO_UFGroup::findContact($value, NULL, 'Individual'); | |
148 | ||
149 | if (!$contact) { | |
150 | $contact = self::add($value); | |
151 | } | |
152 | ||
153 | // attempt to save activity targets | |
154 | $targetParams = array( | |
155 | 'activity_id' => $activity->id, | |
91da6cd5 | 156 | 'contact_id' => $contact, |
9e74e3ce | 157 | 'record_type_id' => $targetID |
6a488035 | 158 | ); |
91da6cd5 | 159 | |
6a488035 | 160 | // See if it already exists |
91da6cd5 DL |
161 | $activityContact = new CRM_Activity_DAO_ActivityContact(); |
162 | $activityContact->activity_id = $activity->id; | |
163 | $activityContact->contact_id = $contact; | |
164 | $activityContact->find(TRUE); | |
165 | if (empty($activityContact->id)) { | |
034500d4 | 166 | $resultTarget = CRM_Activity_BAO_ActivityContact::create($targetParams); |
6a488035 TO |
167 | } |
168 | } | |
169 | ||
170 | $transaction->commit(); | |
171 | ||
172 | //process sending of mails | |
173 | $mailParams['title'] = CRM_Utils_Array::value('title', $params); | |
174 | $mailParams['general_link'] = CRM_Utils_Array::value('general_link', $frndParams); | |
175 | $mailParams['message'] = CRM_Utils_Array::value('suggested_message', $params); | |
176 | ||
177 | // get domain | |
178 | $domainDetails = CRM_Core_BAO_Domain::getNameAndEmail(); | |
179 | list($username, $mailParams['domain']) = explode('@', $domainDetails[1]); | |
180 | ||
181 | $default = array(); | |
182 | $findProperties = array('id' => $params['entity_id']); | |
183 | ||
184 | if ($params['entity_table'] == 'civicrm_contribution_page') { | |
185 | ||
186 | $returnProperties = array('receipt_from_email', 'is_email_receipt'); | |
187 | CRM_Core_DAO::commonRetrieve('CRM_Contribute_DAO_ContributionPage', | |
188 | $findProperties, | |
189 | $default, | |
190 | $returnProperties | |
191 | ); | |
192 | //if is_email_receipt is set then take receipt_from_email | |
193 | //as from_email | |
194 | if (CRM_Utils_Array::value('is_email_receipt', $default) && CRM_Utils_Array::value('receipt_from_email', $default)) { | |
195 | $mailParams['email_from'] = $default['receipt_from_email']; | |
196 | } | |
197 | ||
198 | $urlPath = 'civicrm/contribute/transact'; | |
199 | $mailParams['module'] = 'contribute'; | |
200 | } | |
201 | elseif ($params['entity_table'] == 'civicrm_event') { | |
202 | ||
203 | $returnProperties = array('confirm_from_email', 'is_email_confirm'); | |
204 | CRM_Core_DAO::commonRetrieve('CRM_Event_DAO_Event', | |
205 | $findProperties, | |
206 | $default, | |
207 | $returnProperties | |
208 | ); | |
209 | ||
210 | $mailParams['email_from'] = $domainDetails['1']; | |
211 | ||
212 | //if is_email_confirm is set then take confirm_from_email | |
213 | //as from_email | |
214 | if (CRM_Utils_Array::value('is_email_confirm', $default) && CRM_Utils_Array::value('confirm_from_email', $default)) { | |
215 | $mailParams['email_from'] = $default['confirm_from_email']; | |
216 | } | |
217 | ||
218 | $urlPath = 'civicrm/event/info'; | |
219 | $mailParams['module'] = 'event'; | |
220 | } | |
221 | elseif ($params['entity_table'] == 'civicrm_pcp') { | |
222 | $mailParams['email_from'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $params['source_contact_id'], | |
223 | 'email', 'contact_id' | |
224 | ); | |
225 | $urlPath = 'civicrm/pcp/info'; | |
226 | $mailParams['module'] = 'contribute'; | |
227 | } | |
228 | ||
229 | $mailParams['page_url'] = CRM_Utils_System::url($urlPath, "reset=1&id={$params['entity_id']}", TRUE, NULL, FALSE, TRUE); | |
230 | ||
231 | //send mail | |
232 | self::sendMail($params['source_contact_id'], $mailParams); | |
233 | } | |
234 | ||
235 | /** | |
236 | * Function to build the form | |
237 | * | |
238 | * @param object $form form object | |
239 | * | |
240 | * @return None | |
241 | * @access public | |
242 | */ | |
243 | function buildFriendForm($form) { | |
244 | $form->addElement('checkbox', 'tf_is_active', ts('Tell a Friend enabled?'), NULL, array('onclick' => "friendBlock(this)")); | |
245 | // name | |
246 | $form->add('text', 'tf_title', ts('Title'), CRM_Core_DAO::getAttribute('CRM_Friend_DAO_Friend', 'title'), TRUE); | |
247 | ||
248 | // intro-text and thank-you text | |
249 | $form->addWysiwyg('intro', ts('Introduction'), CRM_Core_DAO::getAttribute('CRM_Friend_DAO_Friend', 'intro'), TRUE); | |
250 | ||
251 | $form->add('textarea', 'suggested_message', ts('Suggested Message'), | |
252 | CRM_Core_DAO::getAttribute('CRM_Friend_DAO_Friend', 'suggested_message'), FALSE | |
253 | ); | |
254 | ||
255 | $form->add('text', 'general_link', ts('Info Page Link'), CRM_Core_DAO::getAttribute('CRM_Friend_DAO_Friend', 'general_link')); | |
256 | ||
257 | $form->add('text', 'tf_thankyou_title', ts('Thank-you Title'), CRM_Core_DAO::getAttribute('CRM_Friend_DAO_Friend', 'thankyou_title'), TRUE); | |
258 | ||
259 | $form->addWysiwyg('tf_thankyou_text', ts('Thank-you Message'), CRM_Core_DAO::getAttribute('CRM_Friend_DAO_Friend', 'thankyou_text'), TRUE); | |
260 | } | |
261 | ||
262 | /** | |
263 | * The function sets the deafult values of the form. | |
264 | * | |
265 | * @param array $defaults (reference) the default values. | |
266 | * | |
267 | * @return booelan whether anything was found | |
268 | */ | |
269 | static function getValues(&$defaults) { | |
270 | if (empty($defaults)) { | |
271 | return NULL; | |
272 | } | |
273 | $friend = new CRM_Friend_BAO_Friend(); | |
274 | $friend->copyValues($defaults); | |
275 | $found = $friend->find(TRUE); | |
276 | CRM_Core_DAO::storeValues($friend, $defaults); | |
277 | return $found; | |
278 | } | |
279 | ||
280 | /** | |
281 | * Process that send tell a friend e-mails | |
282 | * | |
283 | * @params int $contactId contact id | |
284 | * @params array $values associative array of name/value pair | |
285 | * | |
286 | * @return void | |
287 | * @access public | |
288 | */ | |
289 | static function sendMail($contactID, &$values) { | |
290 | list($fromName, $email) = CRM_Contact_BAO_Contact::getContactDetails($contactID); | |
291 | // if no $fromName (only email collected from originating contact) - list returns single space | |
292 | if (trim($fromName) == '') { | |
293 | $fromName = $email; | |
294 | } | |
295 | ||
296 | // use contact email, CRM-4963 | |
297 | if (!CRM_Utils_Array::value('email_from', $values)) { | |
298 | $values['email_from'] = $email; | |
299 | } | |
300 | ||
301 | foreach ($values['email'] as $displayName => $emailTo) { | |
302 | if ($emailTo) { | |
303 | // FIXME: factor the below out of the foreach loop | |
304 | CRM_Core_BAO_MessageTemplates::sendTemplate( | |
305 | array( | |
306 | 'groupName' => 'msg_tpl_workflow_friend', | |
307 | 'valueName' => 'friend', | |
308 | 'contactId' => $contactID, | |
309 | 'tplParams' => array( | |
310 | $values['module'] => $values['module'], | |
311 | 'senderContactName' => $fromName, | |
312 | 'title' => $values['title'], | |
313 | 'generalLink' => $values['general_link'], | |
314 | 'pageURL' => $values['page_url'], | |
315 | 'senderMessage' => $values['message'], | |
316 | ), | |
317 | 'from' => "$fromName (via {$values['domain']}) <{$values['email_from']}>", | |
318 | 'toName' => $displayName, | |
319 | 'toEmail' => $emailTo, | |
320 | 'replyTo' => $email, | |
321 | ) | |
322 | ); | |
323 | } | |
324 | } | |
325 | } | |
326 | ||
327 | /** | |
328 | * takes an associative array and creates a tell a friend object | |
329 | * | |
330 | * the function extract all the params it needs to initialize the create/edit a | |
331 | * friend object. the params array could contain additional unused name/value | |
332 | * pairs | |
333 | * | |
334 | * @param array $params (reference ) an assoc array of name/value pairs | |
335 | * | |
336 | * @return object CRM_Friend_BAO_Friend object | |
337 | * @access public | |
338 | * @static | |
339 | */ | |
340 | static function addTellAFriend(&$params) { | |
341 | $friendDAO = new CRM_Friend_DAO_Friend(); | |
342 | ||
343 | $friendDAO->copyValues($params); | |
344 | $friendDAO->is_active = CRM_Utils_Array::value('is_active', $params, FALSE); | |
345 | ||
346 | $friendDAO->save(); | |
347 | ||
348 | return $friendDAO; | |
349 | } | |
350 | } | |
351 |