CRM/Contact/Form/Edit/CommunicationPreferences.php

   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  * form helper class for an Communication Preferences object
  38  */
  39 class CRM_Contact_Form_Edit_CommunicationPreferences {
  40
  41   /**
  42    * greetings
  43    * @var array
  44    * @static
  45    */
  46   static $greetings = array();
  47
  48   /**
  49    * build the form elements for Communication Preferences object
  50    *
  51    * @param CRM_Core_Form $form       reference to the form object
  52    *
  53    * @return void
  54    * @access public
  55    * @static
  56    */
  57   static function buildQuickForm(&$form) {
  58     // since the pcm - preferred comminication method is logically
  59     // grouped hence we'll use groups of HTML_QuickForm
  60
  61
  62     // checkboxes for DO NOT phone, email, mail
  63     // we take labels from SelectValues
  64     $privacy = $commPreff = $commPreference = array();
  65     $privacyOptions = CRM_Core_SelectValues::privacy();
  66
  67     // we add is_opt_out as a separate checkbox below for display and help purposes so remove it here
  68     unset($privacyOptions['is_opt_out']);
  69
  70     foreach ($privacyOptions as $name => $label) {
  71       $privacy[] = $form->createElement('advcheckbox', $name, NULL, $label);
  72     }
  73     $form->addGroup($privacy, 'privacy', ts('Privacy'), '&nbsp;');
  74
  75     // preferred communication method
  76     $comm = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method', array('loclize' => TRUE));
  77     foreach ($comm as $value => $title) {
  78       $commPreff[] = $form->createElement('advcheckbox', $value, NULL, $title);
  79     }
  80     $form->addGroup($commPreff, 'preferred_communication_method', ts('Preferred Method(s)'));
  81
  82     $form->add('select', 'preferred_language',
  83       ts('Preferred Language'),
  84       array(
  85         '' => ts('- select -')) +
  86       CRM_Contact_BAO_Contact::buildOptions('preferred_language')
  87     );
  88
  89     if (!empty($privacyOptions)) {
  90       $commPreference['privacy'] = $privacyOptions;
  91     }
  92     if (!empty($comm)) {
  93       $commPreference['preferred_communication_method'] = $comm;
  94     }
  95
  96     //using for display purpose.
  97     $form->assign('commPreference', $commPreference);
  98
  99     $form->add('select', 'preferred_mail_format', ts('Email Format'), CRM_Core_SelectValues::pmf());
 100     $form->add('checkbox', 'is_opt_out', ts('NO BULK EMAILS (User Opt Out)'));
 101
 102     //check contact type and build filter clause accordingly for greeting types, CRM-4575
 103     $greetings = self::getGreetingFields($form->_contactType);
 104
 105     foreach ($greetings as $greeting => $fields) {
 106       $filter = array(
 107         'contact_type' => $form->_contactType,
 108         'greeting_type' => $greeting,
 109       );
 110
 111       //add addressee in Contact form
 112       $greetingTokens = CRM_Core_PseudoConstant::greeting($filter);
 113       if (!empty($greetingTokens)) {
 114         $form->addElement('select', $fields['field'], $fields['label'],
 115           array(
 116             '' => ts('- select -')) + $greetingTokens
 117         );
 118         //custom addressee
 119         $form->addElement('text', $fields['customField'], $fields['customLabel'],
 120           CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', $fields['customField']), $fields['js']
 121         );
 122       }
 123     }
 124   }
 125
 126   /**
 127    * global form rule
 128    *
 129    * @param array $fields  the input form values
 130    * @param array $files   the uploaded files if any
 131    * @param array $options additional user data
 132    *
 133    * @return true if no errors, else array of errors
 134    * @access public
 135    * @static
 136    */
 137   static function formRule($fields, $files, $self) {
 138     //CRM-4575
 139
 140     $greetings = self::getGreetingFields($self->_contactType);
 141     foreach ($greetings as $greeting => $details) {
 142       $customizedValue = CRM_Core_OptionGroup::getValue($greeting, 'Customized', 'name');
 143       if (CRM_Utils_Array::value($details['field'], $fields) == $customizedValue
 144         && !CRM_Utils_Array::value($details['customField'], $fields)
 145       ) {
 146         $errors[$details['customField']] = ts('Custom  %1 is a required field if %1 is of type Customized.',
 147           array(1 => $details['label'])
 148         );
 149       }
 150     }
 151     return empty($errors) ? TRUE : $errors;
 152   }
 153
 154   /**
 155    * This function sets the default values for the form. Note that in edit/view mode
 156    * the default values are retrieved from the database
 157    *
 158    * @access public
 159    *
 160    * @return None
 161    */
 162   static function setDefaultValues(&$form, &$defaults) {
 163
 164     if (!empty($defaults['preferred_language'])) {
 165       $defaults['preferred_language'] = CRM_Core_PseudoConstant::getKey('CRM_Contact_DAO_Contact', 'preferred_language', $defaults['preferred_language']);
 166     }
 167
 168     // CRM-7119: set preferred_language to default if unset
 169     if (empty($defaults['preferred_language'])) {
 170       $config = CRM_Core_Config::singleton();
 171       $defaults['preferred_language'] = $config->lcMessages;
 172     }
 173
 174     //set default from greeting types CRM-4575, CRM-9739
 175     if ($form->_action & CRM_Core_Action::ADD) {
 176       foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
 177         if (empty($defaults[$greeting . '_id'])) {
 178           if ($defaultGreetingTypeId =
 179             CRM_Contact_BAO_Contact_Utils::defaultGreeting($form->_contactType, $greeting)
 180           ) {
 181             $defaults[$greeting . '_id'] = $defaultGreetingTypeId;
 182           }
 183         }
 184       }
 185     }
 186     else {
 187       foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
 188         $name = "{$greeting}_display";
 189         $form->assign($name, CRM_Utils_Array::value($name, $defaults));
 190       }
 191     }
 192   }
 193
 194   /**
 195    *  set array of greeting fields
 196    *
 197    * @return None
 198    * @access public
 199    */
 200   static function getGreetingFields($contactType) {
 201     if (empty(self::$greetings[$contactType])) {
 202       self::$greetings[$contactType] = array();
 203
 204       $js = array(
 205         'onfocus' => "if (!this.value) {  this.value='Dear ';} else return false",
 206         'onblur' => "if ( this.value == 'Dear') {  this.value='';} else return false",
 207       );
 208
 209       self::$greetings[$contactType] = array(
 210         'addressee' => array(
 211           'field' => 'addressee_id',
 212           'customField' => 'addressee_custom',
 213           'label' => ts('Addressee'),
 214           'customLabel' => ts('Custom Addressee'),
 215           'js' => NULL,
 216         ),
 217         'email_greeting' => array(
 218           'field' => 'email_greeting_id',
 219           'customField' => 'email_greeting_custom',
 220           'label' => ts('Email Greeting'),
 221           'customLabel' => ts('Custom Email Greeting'),
 222           'js' => $js,
 223         ),
 224         'postal_greeting' => array(
 225           'field' => 'postal_greeting_id',
 226           'customField' => 'postal_greeting_custom',
 227           'label' => ts('Postal Greeting'),
 228           'customLabel' => ts('Custom Postal Greeting'),
 229           'js' => $js,
 230         ),
 231       );
 232     }
 233
 234     return self::$greetings[$contactType];
 235   }
 236 }
 237