CRM/Friend/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Tell A Friend Form For End User
  38  *
  39  */
  40 class CRM_Friend_Form extends CRM_Core_Form {
  41
  42   /**
  43    * Constants for number of friend contacts.
  44    */
  45   const NUM_OPTION = 3;
  46
  47   /**
  48    * The id of the entity that we are processing.
  49    *
  50    * @var int
  51    */
  52   protected $_entityId;
  53
  54   /**
  55    * Tell a friend id in db.
  56    *
  57    * @var int
  58    */
  59   public $_friendId;
  60
  61   /**
  62    * The table name of the entity that we are processing.
  63    *
  64    * @var string
  65    */
  66   protected $_entityTable;
  67
  68   protected $_campaignId;
  69
  70   /**
  71    * The contact ID.
  72    *
  73    * @var int
  74    */
  75   protected $_contactID;
  76
  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);
  80
  81     $pcomponent = CRM_Utils_Request::retrieve('pcomponent', 'String', $this, TRUE);
  82
  83     if (in_array($pcomponent, array(
  84       'contribute',
  85       'event',
  86     ))) {
  87       $values = array();
  88       $params = array('id' => $this->_entityId);
  89       CRM_Core_DAO::commonRetrieve('CRM_Contribute_DAO_ContributionPage',
  90         $params, $values, array('title', 'campaign_id', 'is_share')
  91       );
  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       }
  99       else {
 100         $isShare = CRM_Utils_Array::value('is_share', $values);
 101       }
 102       // Tell Form.tpl whether to include SocialNetwork.tpl for social media sharing
 103       $this->assign('isShare', $isShare);
 104     }
 105     elseif ($pcomponent == 'pcp') {
 106       $this->_pcpBlockId = CRM_Utils_Request::retrieve('blockId', 'Positive', $this, TRUE);
 107
 108       $values = array();
 109       $params = array('id' => $this->_pcpBlockId);
 110       CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock',
 111         $params, $values, array('is_tellfriend_enabled', 'tellfriend_limit')
 112       );
 113
 114       if (empty($values['is_tellfriend_enabled'])) {
 115         CRM_Core_Error::fatal(ts('Tell Friend is disable for this Personal Campaign Page'));
 116       }
 117
 118       $this->_mailLimit = $values['tellfriend_limit'];
 119       $this->_entityTable = 'civicrm_pcp';
 120
 121       $sql = '
 122    SELECT  pcp.title,
 123            contrib.campaign_id
 124   FROM  civicrm_pcp pcp
 125     INNER JOIN  civicrm_contribution_page contrib ON ( pcp.page_id = contrib.id AND pcp.page_type = "contribute" )
 126   WHERE  pcp.id = %1';
 127       $pcp = CRM_Core_DAO::executeQuery($sql, array(1 => array($this->_entityId, 'Positive')));
 128       while ($pcp->fetch()) {
 129         $this->_title = $pcp->title;
 130         $this->_campaignId = $pcp->campaign_id;
 131         $pcp->free();
 132       }
 133
 134       $this->assign('pcpTitle', $this->_title);
 135     }
 136     else {
 137       CRM_Core_Error::fatal(ts('page argument missing or invalid'));
 138     }
 139     $this->assign('context', $pcomponent);
 140
 141     $session = CRM_Core_Session::singleton();
 142     $this->_contactID = $session->get('userID');
 143     if (!$this->_contactID) {
 144       $this->_contactID = $session->get('transaction.userID');
 145     }
 146
 147     if (!$this->_contactID) {
 148       CRM_Core_Error::fatal(ts('Could not get the contact ID'));
 149     }
 150
 151     // we do not want to display recently viewed items, so turn off
 152     $this->assign('displayRecent', FALSE);
 153   }
 154
 155   /**
 156    * Set default values for the form.
 157    *
 158    *
 159    * @return void
 160    */
 161   public function setDefaultValues() {
 162     $defaults = array();
 163
 164     $defaults['entity_id'] = $this->_entityId;
 165     $defaults['entity_table'] = $this->_entityTable;
 166
 167     CRM_Friend_BAO_Friend::getValues($defaults);
 168     CRM_Utils_System::setTitle(CRM_Utils_Array::value('title', $defaults));
 169
 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);
 174
 175     list($fromName, $fromEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->_contactID);
 176
 177     $defaults['from_name'] = $fromName;
 178     $defaults['from_email'] = $fromEmail;
 179
 180     return $defaults;
 181   }
 182
 183   /**
 184    * Build the form object.
 185    *
 186    * @return void
 187    */
 188   public function buildQuickForm() {
 189     $this->applyFilter('__ALL__', 'trim');
 190     // Details of User
 191     $name = &$this->add('text',
 192       'from_name',
 193       ts('From'),
 194       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'first_name')
 195     );
 196     $name->freeze();
 197
 198     $email = &$this->add('text',
 199       'from_email',
 200       ts('Your Email'),
 201       CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', 'email'),
 202       TRUE
 203     );
 204     $email->freeze();
 205
 206     $this->add('wysiwyg', 'suggested_message', ts('Your Message'), CRM_Core_DAO::getAttribute('CRM_Friend_DAO_Friend', 'suggested_message'));
 207     $friend = array();
 208     $mailLimit = self::NUM_OPTION;
 209     if ($this->_entityTable == 'civicrm_pcp') {
 210       $mailLimit = $this->_mailLimit;
 211     }
 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');
 218     }
 219
 220     $this->addButtons(array(
 221         array(
 222           'type' => 'submit',
 223           'name' => ts('Send Your Message'),
 224           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 225           'isDefault' => TRUE,
 226         ),
 227         array(
 228           'type' => 'cancel',
 229           'name' => ts('Cancel'),
 230         ),
 231       )
 232     );
 233
 234     $this->addFormRule(array('CRM_Friend_Form', 'formRule'));
 235   }
 236
 237   /**
 238    * Validation.
 239    *
 240    * @param array $fields
 241    *
 242    * @return bool|array
 243    *   mixed true or array of errors
 244    */
 245   public static function formRule($fields) {
 246
 247     $errors = array();
 248
 249     $valid = FALSE;
 250     foreach ($fields['friend'] as $key => $val) {
 251       if (trim($val['first_name']) || trim($val['last_name']) || trim($val['email'])) {
 252         $valid = TRUE;
 253
 254         if (!trim($val['first_name'])) {
 255           $errors["friend[{$key}][first_name]"] = ts('Please enter your friend\'s first name.');
 256         }
 257
 258         if (!trim($val['last_name'])) {
 259           $errors["friend[{$key}][last_name]"] = ts('Please enter your friend\'s last name.');
 260         }
 261
 262         if (!trim($val['email'])) {
 263           $errors["friend[{$key}][email]"] = ts('Please enter your friend\'s email address.');
 264         }
 265       }
 266     }
 267
 268     if (!$valid) {
 269       $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.");
 270     }
 271
 272     return empty($errors) ? TRUE : $errors;
 273   }
 274
 275   /**
 276    * Process the form submission.
 277    *
 278    *
 279    * @return void
 280    */
 281   public function postProcess() {
 282     // get the submitted form values.
 283     $formValues = $this->controller->exportValues($this->_name);
 284
 285     $formValues['entity_id'] = $this->_entityId;
 286     $formValues['entity_table'] = $this->_entityTable;
 287     $formValues['source_contact_id'] = $this->_contactID;
 288     $formValues['is_test'] = $this->_action ? 1 : 0;
 289     $formValues['title'] = $this->_title;
 290     $formValues['campaign_id'] = $this->_campaignId;
 291
 292     CRM_Friend_BAO_Friend::create($formValues);
 293
 294     $this->assign('status', 'thankyou');
 295     $defaults = array();
 296
 297     $defaults['entity_id'] = $this->_entityId;
 298     $defaults['entity_table'] = $this->_entityTable;
 299
 300     CRM_Friend_BAO_Friend::getValues($defaults);
 301     if ($this->_entityTable == 'civicrm_pcp') {
 302       $defaults['thankyou_text'] = $defaults['thankyou_title'] = ts('Thank you for your support');
 303       $defaults['thankyou_text'] = ts('Thanks for supporting this campaign by spreading the word to your friends.');
 304     }
 305     elseif ($this->_entityTable == 'civicrm_contribution_page') {
 306       // If this is tell a friend after contributing, give donor link to create their own fundraising page
 307       if ($linkText = CRM_PCP_BAO_PCP::getPcpBlockStatus($defaults['entity_id'], $defaults['entity_table'])) {
 308
 309         $linkTextUrl = CRM_Utils_System::url('civicrm/contribute/campaign',
 310           "action=add&reset=1&pageId={$defaults['entity_id']}&component=contribute",
 311           FALSE, NULL, TRUE,
 312           TRUE
 313         );
 314         $this->assign('linkTextUrl', $linkTextUrl);
 315         $this->assign('linkText', $linkText);
 316       }
 317     }
 318     elseif ($this->_entityTable == 'civicrm_event') {
 319       // If this is tell a friend after registering for an event, give donor link to create their own fundraising page
 320       require_once 'CRM/PCP/BAO/PCP.php';
 321       if ($linkText = CRM_PCP_BAO_PCP::getPcpBlockStatus($defaults['entity_id'], $defaults['entity_table'])) {
 322         $linkTextUrl = CRM_Utils_System::url('civicrm/contribute/campaign',
 323           "action=add&reset=1&pageId={$defaults['entity_id']}&component=event",
 324           FALSE, NULL, TRUE,
 325           TRUE);
 326         $this->assign('linkTextUrl', $linkTextUrl);
 327         $this->assign('linkText', $linkText);
 328       }
 329     }
 330
 331     CRM_Utils_System::setTitle($defaults['thankyou_title']);
 332     $this->assign('thankYouText', $defaults['thankyou_text']);
 333   }
 334
 335 }