3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
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-2020
37 * This class generates form components for Tell A Friend Form For End User
40 class CRM_Friend_Form
extends CRM_Core_Form
{
43 * Constants for number of friend contacts.
48 * The id of the entity that we are processing.
55 * Tell a friend id in db.
62 * The table name of the entity that we are processing.
66 protected $_entityTable;
68 protected $_campaignId;
75 protected $_contactID;
77 public function preProcess() {
78 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this);
79 $this->_entityId
= CRM_Utils_Request
::retrieve('eid', 'Positive', $this, TRUE);
81 $pcomponent = CRM_Utils_Request
::retrieve('pcomponent', 'String', $this, TRUE);
83 if (in_array($pcomponent, [
88 $params = ['id' => $this->_entityId
];
89 CRM_Core_DAO
::commonRetrieve('CRM_Contribute_DAO_ContributionPage',
90 $params, $values, ['title', 'campaign_id', 'is_share']
92 $this->_title
= CRM_Utils_Array
::value('title', $values);
93 $this->_campaignId
= CRM_Utils_Array
::value('campaign_id', $values);
94 $this->_entityTable
= 'civicrm_contribution_page';
95 if ($pcomponent == 'event') {
96 $this->_entityTable
= 'civicrm_event';
97 $isShare = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $this->_entityId
, 'is_share');
98 $this->_title
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $this->_entityId
, 'title');
101 $isShare = CRM_Utils_Array
::value('is_share', $values);
103 // Tell Form.tpl whether to include SocialNetwork.tpl for social media sharing
104 $this->assign('isShare', $isShare);
106 elseif ($pcomponent == 'pcp') {
107 $this->_pcpBlockId
= CRM_Utils_Request
::retrieve('blockId', 'Positive', $this, TRUE);
110 $params = ['id' => $this->_pcpBlockId
];
111 CRM_Core_DAO
::commonRetrieve('CRM_PCP_DAO_PCPBlock',
112 $params, $values, ['is_tellfriend_enabled', 'tellfriend_limit']
115 if (empty($values['is_tellfriend_enabled'])) {
116 CRM_Core_Error
::fatal(ts('Tell Friend is disable for this Personal Campaign Page'));
119 $this->_mailLimit
= $values['tellfriend_limit'];
120 $this->_entityTable
= 'civicrm_pcp';
126 INNER JOIN civicrm_contribution_page contrib ON ( pcp.page_id = contrib.id AND pcp.page_type = "contribute" )
128 $pcp = CRM_Core_DAO
::executeQuery($sql, [1 => [$this->_entityId
, 'Positive']]);
129 while ($pcp->fetch()) {
130 $this->_title
= $pcp->title
;
131 $this->_campaignId
= $pcp->campaign_id
;
134 $this->assign('pcpTitle', $this->_title
);
137 CRM_Core_Error
::fatal(ts('page argument missing or invalid'));
139 $this->assign('context', $pcomponent);
141 $session = CRM_Core_Session
::singleton();
142 $this->_contactID
= $session->get('userID');
143 if (!$this->_contactID
) {
144 $this->_contactID
= $session->get('transaction.userID');
147 if (!$this->_contactID
) {
148 CRM_Core_Error
::fatal(ts('Could not get the contact ID'));
151 // we do not want to display recently viewed items, so turn off
152 $this->assign('displayRecent', FALSE);
156 * Set default values for the form.
161 public function setDefaultValues() {
164 $defaults['entity_id'] = $this->_entityId
;
165 $defaults['entity_table'] = $this->_entityTable
;
167 CRM_Friend_BAO_Friend
::getValues($defaults);
168 CRM_Utils_System
::setTitle(CRM_Utils_Array
::value('title', $defaults));
170 $this->assign('title', CRM_Utils_Array
::value('title', $defaults));
171 $this->assign('intro', CRM_Utils_Array
::value('intro', $defaults));
172 $this->assign('message', CRM_Utils_Array
::value('suggested_message', $defaults));
173 $this->assign('entityID', $this->_entityId
);
175 list($fromName, $fromEmail) = CRM_Contact_BAO_Contact
::getContactDetails($this->_contactID
);
177 $defaults['from_name'] = $fromName;
178 $defaults['from_email'] = $fromEmail;
184 * Build the form object.
188 public function buildQuickForm() {
189 $this->applyFilter('__ALL__', 'trim');
191 $name = &$this->add('text',
194 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'first_name')
198 $email = &$this->add('text',
201 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', 'email'),
206 $this->add('wysiwyg', 'suggested_message', ts('Your Message'), CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'suggested_message'));
208 $mailLimit = self
::NUM_OPTION
;
209 if ($this->_entityTable
== 'civicrm_pcp') {
210 $mailLimit = $this->_mailLimit
;
212 $this->assign('mailLimit', $mailLimit +
1);
213 for ($i = 1; $i <= $mailLimit; $i++
) {
214 $this->add('text', "friend[$i][first_name]", ts("Friend's First Name"));
215 $this->add('text', "friend[$i][last_name]", ts("Friend's Last Name"));
216 $this->add('text', "friend[$i][email]", ts("Friend's Email"));
217 $this->addRule("friend[$i][email]", ts('The format of this email address is not valid.'), 'email');
223 'name' => ts('Send Your Message'),
224 'spacing' => ' ',
229 'name' => ts('Cancel'),
233 $this->addFormRule(['CRM_Friend_Form', 'formRule']);
239 * @param array $fields
242 * mixed true or array of errors
244 public static function formRule($fields) {
249 foreach ($fields['friend'] as $key => $val) {
250 if (trim($val['first_name']) ||
trim($val['last_name']) ||
trim($val['email'])) {
253 if (!trim($val['first_name'])) {
254 $errors["friend[{$key}][first_name]"] = ts('Please enter your friend\'s first name.');
257 if (!trim($val['last_name'])) {
258 $errors["friend[{$key}][last_name]"] = ts('Please enter your friend\'s last name.');
261 if (!trim($val['email'])) {
262 $errors["friend[{$key}][email]"] = ts('Please enter your friend\'s email address.');
268 $errors['friend[1][first_name]'] = ts("Please enter at least one friend's information, or click Cancel if you don't want to send emails at this time.");
271 return empty($errors) ?
TRUE : $errors;
275 * Process the form submission.
280 public function postProcess() {
281 // get the submitted form values.
282 $formValues = $this->controller
->exportValues($this->_name
);
284 $formValues['entity_id'] = $this->_entityId
;
285 $formValues['entity_table'] = $this->_entityTable
;
286 $formValues['source_contact_id'] = $this->_contactID
;
287 $formValues['is_test'] = $this->_action ?
1 : 0;
288 $formValues['title'] = $this->_title
;
289 $formValues['campaign_id'] = $this->_campaignId
;
291 CRM_Friend_BAO_Friend
::create($formValues);
293 $this->assign('status', 'thankyou');
296 $defaults['entity_id'] = $this->_entityId
;
297 $defaults['entity_table'] = $this->_entityTable
;
299 CRM_Friend_BAO_Friend
::getValues($defaults);
300 if ($this->_entityTable
== 'civicrm_pcp') {
301 $defaults['thankyou_text'] = $defaults['thankyou_title'] = ts('Thank you for your support');
302 $defaults['thankyou_text'] = ts('Thanks for supporting this campaign by spreading the word to your friends.');
304 elseif ($this->_entityTable
== 'civicrm_contribution_page') {
305 // If this is tell a friend after contributing, give donor link to create their own fundraising page
306 if ($linkText = CRM_PCP_BAO_PCP
::getPcpBlockStatus($defaults['entity_id'], $defaults['entity_table'])) {
308 $linkTextUrl = CRM_Utils_System
::url('civicrm/contribute/campaign',
309 "action=add&reset=1&pageId={$defaults['entity_id']}&component=contribute",
313 $this->assign('linkTextUrl', $linkTextUrl);
314 $this->assign('linkText', $linkText);
317 elseif ($this->_entityTable
== 'civicrm_event') {
318 // If this is tell a friend after registering for an event, give donor link to create their own fundraising page
319 require_once 'CRM/PCP/BAO/PCP.php';
320 if ($linkText = CRM_PCP_BAO_PCP
::getPcpBlockStatus($defaults['entity_id'], $defaults['entity_table'])) {
321 $linkTextUrl = CRM_Utils_System
::url('civicrm/contribute/campaign',
322 "action=add&reset=1&pageId={$defaults['entity_id']}&component=event",
325 $this->assign('linkTextUrl', $linkTextUrl);
326 $this->assign('linkText', $linkText);
330 CRM_Utils_System
::setTitle($defaults['thankyou_title']);
331 $this->assign('thankYouText', $defaults['thankyou_text']);