3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
36 * This class contains the functions for Friend
39 class CRM_Friend_BAO_Friend
extends CRM_Friend_DAO_Friend
{
42 * Tell a friend id in db.
50 public function __construct() {
51 parent
::__construct();
55 * Takes an associative array and creates a friend object.
57 * the function extract all the params it needs to initialize the create a
58 * friend object. the params array could contain additional unused name/value
61 * @param array $params
62 * (reference ) an assoc array of name/value pairs.
66 public static function add(&$params) {
67 return CRM_Contact_BAO_Contact
::createProfileContact($params, CRM_Core_DAO
::$_nullArray);
71 * Given the list of params in the params array, fetch the object
72 * and store the values in the values array
74 * @param array $params
75 * Input parameters to find object.
76 * @param array $values
77 * Output values of the object.
82 public static function retrieve(&$params, &$values) {
83 $friend = new CRM_Friend_DAO_Friend();
84 $friend->copyValues($params);
86 CRM_Core_DAO
::storeValues($friend, $values);
91 * Takes an associative array and creates a friend object.
93 * @param array $params
94 * (reference) an assoc array of name/value pairs.
96 * @throws \CRM_Core_Exception
98 public static function create(&$params) {
99 $transaction = new CRM_Core_Transaction();
104 // create contact corresponding to each friend
105 foreach ($params['friend'] as $key => $details) {
106 if ($details["first_name"]) {
107 $contactParams[$key] = [
108 'first_name' => $details["first_name"],
109 'last_name' => $details["last_name"],
110 'contact_source' => ts('Tell a Friend') . ": {$params['title']}",
111 'email-Primary' => $details["email"],
114 $displayName = $details["first_name"] . " " . $details["last_name"];
115 $mailParams['email'][$displayName] = $details["email"];
120 'entity_id' => $params['entity_id'],
121 'entity_table' => $params['entity_table'],
123 self
::getValues($friendParams);
125 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', 'Tell a Friend', 'value', 'name');
129 'source_contact_id' => $params['source_contact_id'],
130 'source_record_id' => NULL,
131 'activity_type_id' => $activityTypeId,
132 'title' => $params['title'],
133 'activity_date_time' => date("YmdHis"),
134 'subject' => ts('Tell a Friend') . ": {$params['title']}",
135 'details' => $params['suggested_message'],
136 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
137 'is_test' => $params['is_test'],
138 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $params),
142 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
143 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
144 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
146 // friend contacts creation
147 foreach ($contactParams as $key => $value) {
148 // create contact only if it does not exits in db
149 $value['email'] = $value['email-Primary'];
150 $contactID = CRM_Contact_BAO_Contact
::getFirstDuplicateContact($value, 'Individual', 'Supervised', [], FALSE);
153 $contactID = self
::add($value);
156 // attempt to save activity targets
158 'activity_id' => $activity->id
,
159 'contact_id' => $contactID,
160 'record_type_id' => $targetID,
163 // See if it already exists
164 $activityContact = new CRM_Activity_DAO_ActivityContact();
165 $activityContact->activity_id
= $activity->id
;
166 $activityContact->contact_id
= $contactID;
167 $activityContact->find(TRUE);
168 if (empty($activityContact->id
)) {
169 CRM_Activity_BAO_ActivityContact
::create($targetParams);
173 $transaction->commit();
175 // Process sending of mails
176 $mailParams['title'] = CRM_Utils_Array
::value('title', $params);
177 $mailParams['general_link'] = CRM_Utils_Array
::value('general_link', $friendParams);
178 $mailParams['message'] = CRM_Utils_Array
::value('suggested_message', $params);
180 // Default "from email address" is default domain address.
181 list($_, $mailParams['email_from']) = CRM_Core_BAO_Domain
::getNameAndEmail();
182 list($username, $mailParams['domain']) = explode('@', $mailParams['email_from']);
185 $findProperties = ['id' => $params['entity_id']];
187 if ($params['entity_table'] == 'civicrm_contribution_page') {
188 $returnProperties = ['receipt_from_email', 'is_email_receipt'];
189 CRM_Core_DAO
::commonRetrieve('CRM_Contribute_DAO_ContributionPage',
195 // if is_email_receipt is set then take receipt_from_email as from_email
196 if (!empty($default['is_email_receipt']) && !empty($default['receipt_from_email'])) {
197 $mailParams['email_from'] = $default['receipt_from_email'];
200 $urlPath = 'civicrm/contribute/transact';
201 $mailParams['module'] = 'contribute';
203 elseif ($params['entity_table'] == 'civicrm_event') {
204 $returnProperties = ['confirm_from_email', 'is_email_confirm'];
205 CRM_Core_DAO
::commonRetrieve('CRM_Event_DAO_Event',
211 // if is_email_confirm is set then take confirm_from_email as from_email
212 if (!empty($default['is_email_confirm']) && !empty($default['confirm_from_email'])) {
213 $mailParams['email_from'] = $default['confirm_from_email'];
216 $urlPath = 'civicrm/event/info';
217 $mailParams['module'] = 'event';
219 elseif ($params['entity_table'] == 'civicrm_pcp') {
220 if (Civi
::settings()->get('allow_mail_from_logged_in_contact')) {
221 $mailParams['email_from'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $params['source_contact_id'],
222 'email', 'contact_id'
225 $urlPath = 'civicrm/pcp/info';
226 $mailParams['module'] = 'contribute';
229 $mailParams['page_url'] = CRM_Utils_System
::url($urlPath, "reset=1&id={$params['entity_id']}", TRUE, NULL, FALSE, TRUE);
232 self
::sendMail($params['source_contact_id'], $mailParams);
236 * Build the form object.
238 * @param CRM_Friend_Form $form
243 public static function buildFriendForm($form) {
244 $form->addElement('checkbox', 'tf_is_active', ts('Tell a Friend enabled?'), NULL, ['onclick' => "friendBlock(this)"]);
246 $form->add('text', 'tf_title', ts('Title'), CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'title'), TRUE);
248 // intro-text and thank-you text
249 $form->add('wysiwyg', 'intro', ts('Introduction'), CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'intro') +
['class' => 'collapsed']);
251 $form->add('textarea', 'suggested_message', ts('Suggested Message'),
252 CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'suggested_message'), FALSE
255 $form->add('text', 'general_link', ts('Info Page Link'), CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'general_link'));
257 $form->add('text', 'tf_thankyou_title', ts('Thank-you Title'), CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'thankyou_title'), TRUE);
259 $form->add('wysiwyg', 'tf_thankyou_text', ts('Thank-you Message'), CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'thankyou_text') +
['class' => 'collapsed']);
261 if ($form->_friendId
) {
262 // CRM-14200 the i18n dialogs need this for translation
263 $form->assign('friendId', $form->_friendId
);
268 * The function sets the default values of the form.
270 * @param array $defaults
271 * (reference) the default values.
274 * whether anything was found
276 public static function getValues(&$defaults) {
277 if (empty($defaults)) {
280 $friend = new CRM_Friend_BAO_Friend();
281 $friend->copyValues($defaults);
282 $found = $friend->find(TRUE);
283 CRM_Core_DAO
::storeValues($friend, $defaults);
288 * Process that sends tell a friend e-mails
290 * @param int $contactID
291 * @param array $values
295 public static function sendMail($contactID, &$values) {
296 list($fromName, $email) = CRM_Contact_BAO_Contact
::getContactDetails($contactID);
297 // if no $fromName (only email collected from originating contact) - list returns single space
298 if (trim($fromName) == '') {
302 if (Civi
::settings()->get('allow_mail_from_logged_in_contact')) {
303 // use contact email, CRM-4963
304 if (empty($values['email_from'])) {
305 $values['email_from'] = $email;
309 // If we have no "email_from" when we get to here, explicitly set it to the default domain email.
310 if (empty($values['email_from'])) {
311 list($domainFromName, $domainEmail) = CRM_Core_BAO_Domain
::getNameAndEmail();
312 $values['email_from'] = $domainEmail;
313 $values['domain'] = $domainFromName;
317 'groupName' => 'msg_tpl_workflow_friend',
318 'valueName' => 'friend',
319 'contactId' => $contactID,
321 $values['module'] => $values['module'],
322 'senderContactName' => $fromName,
323 'title' => $values['title'],
324 'generalLink' => $values['general_link'],
325 'pageURL' => $values['page_url'],
326 'senderMessage' => $values['message'],
328 'from' => "$fromName (via {$values['domain']}) <{$values['email_from']}>",
332 foreach ($values['email'] as $displayName => $emailTo) {
334 $templateParams['toName'] = $displayName;
335 $templateParams['toEmail'] = $emailTo;
336 CRM_Core_BAO_MessageTemplate
::sendTemplate($templateParams);
342 * Takes an associative array and creates a tell a friend object.
344 * the function extract all the params it needs to initialize the create/edit a
345 * friend object. the params array could contain additional unused name/value
348 * @param array $params
349 * (reference) an assoc array of name/value pairs.
351 * @return CRM_Friend_DAO_Friend
353 public static function addTellAFriend(&$params) {
354 $friendDAO = new CRM_Friend_DAO_Friend();
355 $friendDAO->copyValues($params);
356 $friendDAO->is_active
= CRM_Utils_Array
::value('is_active', $params, FALSE);