3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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 proceessing
56 * the table name of the entity that we are proceessing
61 protected $_entityTable;
63 protected $_campaignId;
71 protected $_contactID;
73 public function preProcess() {
74 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this);
75 $this->_entityId
= CRM_Utils_Request
::retrieve('eid', 'Positive', $this, TRUE);
77 $pcomponent = CRM_Utils_Request
::retrieve('pcomponent', 'String', $this, TRUE);
79 if (in_array($pcomponent, array(
80 'contribute', 'event'))) {
82 $params = array('id' => $this->_entityId
);
83 CRM_Core_DAO
::commonRetrieve('CRM_Contribute_DAO_ContributionPage',
84 $params, $values, array('title', 'campaign_id', 'is_share')
86 $this->_title
= CRM_Utils_Array
::value('title', $values);
87 $this->_campaignId
= CRM_Utils_Array
::value('campaign_id', $values);
88 $this->_entityTable
= 'civicrm_contribution_page';
89 if ($pcomponent == 'event') {
90 $this->_entityTable
= 'civicrm_event';
91 $isShare = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $this->_entityId
, 'is_share');
93 $isShare = CRM_Utils_Array
::value('is_share', $values);
95 // Tell Form.tpl whether to include SocialNetwork.tpl for social media sharing
96 $this->assign('isShare', $isShare);
98 elseif ($pcomponent == 'pcp') {
99 $this->_pcpBlockId
= CRM_Utils_Request
::retrieve('blockId', 'Positive', $this, TRUE);
102 $params = array('id' => $this->_pcpBlockId
);
103 CRM_Core_DAO
::commonRetrieve('CRM_PCP_DAO_PCPBlock',
104 $params, $values, array('is_tellfriend_enabled', 'tellfriend_limit')
107 if (!CRM_Utils_Array
::value('is_tellfriend_enabled', $values)) {
108 CRM_Core_Error
::fatal(ts('Tell Friend is disable for this Personal Campaign Page'));
111 $this->_mailLimit
= $values['tellfriend_limit'];
112 $this->_entityTable
= 'civicrm_pcp';
118 INNER JOIN civicrm_contribution_page contrib ON ( pcp.page_id = contrib.id AND pcp.page_type = "contribute" )
120 $pcp = CRM_Core_DAO
::executeQuery($sql, array(1 => array($this->_entityId
, 'Positive')));
121 while ($pcp->fetch()) {
122 $this->_title
= $pcp->title
;
123 $this->_campaignId
= $pcp->campaign_id
;
127 $this->assign('pcpTitle', $this->_title
);
130 CRM_Core_Error
::fatal(ts('page argument missing or invalid'));
132 $this->assign('context', $pcomponent);
134 $session = CRM_Core_Session
::singleton();
135 $this->_contactID
= $session->get('userID');
136 if (!$this->_contactID
) {
137 $this->_contactID
= $session->get('transaction.userID');
140 if (!$this->_contactID
) {
141 CRM_Core_Error
::fatal(ts('Could not get the contact ID'));
144 // we do not want to display recently viewed items, so turn off
145 $this->assign('displayRecent', FALSE);
149 * This function sets the default values for the form.
155 public function setDefaultValues() {
158 $defaults['entity_id'] = $this->_entityId
;
159 $defaults['entity_table'] = $this->_entityTable
;
161 CRM_Friend_BAO_Friend
::getValues($defaults);
162 CRM_Utils_System
::setTitle(CRM_Utils_Array
::value('title', $defaults));
164 $this->assign('title', CRM_Utils_Array
::value('title', $defaults));
165 $this->assign('intro', CRM_Utils_Array
::value('intro', $defaults));
166 $this->assign('message', CRM_Utils_Array
::value('suggested_message', $defaults));
167 $this->assign('entityID', $this->_entityId
);
169 list($fromName, $fromEmail) = CRM_Contact_BAO_Contact
::getContactDetails($this->_contactID
);
171 $defaults['from_name'] = $fromName;
172 $defaults['from_email'] = $fromEmail;
178 * Function to build the form
183 public function buildQuickForm() {
185 $name = &$this->add('text',
188 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'first_name')
192 $email = &$this->add('text',
195 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', 'email'),
200 $this->addWysiwyg('suggested_message', ts('Your Message'), CRM_Core_DAO
::getAttribute('CRM_Friend_DAO_Friend', 'suggested_message'));
202 $mailLimit = self
::NUM_OPTION
;
203 if ($this->_entityTable
== 'civicrm_pcp') {
204 $mailLimit = $this->_mailLimit
;
206 $this->assign('mailLimit', $mailLimit +
1);
207 for ($i = 1; $i <= $mailLimit; $i++
) {
208 $this->add('text', "friend[$i][first_name]", ts("Friend's First Name"));
209 $this->add('text', "friend[$i][last_name]", ts("Friend's Last Name"));
210 $this->add('text', "friend[$i][email]", ts("Friend's Email"));
211 $this->addRule("friend[$i][email]", ts('The format of this email address is not valid.'), 'email');
214 $this->addButtons(array(
217 'name' => ts('Send Your Message'),
218 'spacing' => ' ',
223 'name' => ts('Cancel'),
228 $this->addFormRule(array('CRM_Friend_Form', 'formRule'));
232 * Function for validation
234 * @param array $params (ref.) an assoc array of name/value pairs
236 * @return mixed true or array of errors
240 static function formRule($fields) {
245 foreach ($fields['friend'] as $key => $val) {
246 if (trim($val['first_name']) ||
trim($val['last_name']) ||
trim($val['email'])) {
249 if (!trim($val['first_name'])) {
250 $errors["friend[{$key}][first_name]"] = ts('Please enter your friend\'s first name.');
253 if (!trim($val['last_name'])) {
254 $errors["friend[{$key}][last_name]"] = ts('Please enter your friend\'s last name.');
257 if (!trim($val['email'])) {
258 $errors["friend[{$key}][email]"] = ts('Please enter your friend\'s email address.');
264 $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.");
267 return empty($errors) ?
TRUE : $errors;
271 * Function to process the form
277 public function postProcess() {
278 // get the submitted form values.
279 $formValues = $this->controller
->exportValues($this->_name
);
281 $formValues['entity_id'] = $this->_entityId
;
282 $formValues['entity_table'] = $this->_entityTable
;
283 $formValues['source_contact_id'] = $this->_contactID
;
284 $formValues['is_test'] = $this->_action ?
1 : 0;
285 $formValues['title'] = $this->_title
;
286 $formValues['campaign_id'] = $this->_campaignId
;
288 CRM_Friend_BAO_Friend
::create($formValues);
290 $this->assign('status', 'thankyou');
293 $defaults['entity_id'] = $this->_entityId
;
294 $defaults['entity_table'] = $this->_entityTable
;
296 CRM_Friend_BAO_Friend
::getValues($defaults);
297 if ($this->_entityTable
== 'civicrm_pcp') {
298 $defaults['thankyou_text'] = $defaults['thankyou_title'] = ts('Thanks for your Support');
299 $defaults['thankyou_text'] = ts('Thanks for supporting this campaign by spreading the word to your friends.');
301 elseif ($this->_entityTable
== 'civicrm_contribution_page') {
302 // If this is tell a friend after contributing, give donor link to create their own fundraising page
303 if ($linkText = CRM_PCP_BAO_PCP
::getPcpBlockStatus($defaults['entity_id'], $defaults['entity_table'])) {
305 $linkTextUrl = CRM_Utils_System
::url('civicrm/contribute/campaign',
306 "action=add&reset=1&pageId={$defaults['entity_id']}&component=contribute",
310 $this->assign('linkTextUrl', $linkTextUrl);
311 $this->assign('linkText', $linkText);
313 } else if ( $this->_entityTable
== 'civicrm_event' ) {
314 // If this is tell a friend after registering for an event, give donor link to create their own fundraising page
315 require_once 'CRM/PCP/BAO/PCP.php';
316 if ( $linkText = CRM_PCP_BAO_PCP
::getPcpBlockStatus( $defaults['entity_id'], $defaults['entity_table'] ) ) {
317 $linkTextUrl = CRM_Utils_System
::url( 'civicrm/contribute/campaign',
318 "action=add&reset=1&pageId={$defaults['entity_id']}&component=event",
321 $this->assign( 'linkTextUrl', $linkTextUrl );
322 $this->assign( 'linkText', $linkText );
326 CRM_Utils_System
::setTitle($defaults['thankyou_title']);
327 $this->assign('thankYouText', $defaults['thankyou_text']);