3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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 * form helper class for an Communication Preferences object
39 class CRM_Contact_Form_Edit_CommunicationPreferences
{
46 static $greetings = array();
49 * build the form elements for Communication Preferences object
51 * @param CRM_Core_Form $form reference to the form object
57 static function buildQuickForm(&$form) {
58 // since the pcm - preferred comminication method is logically
59 // grouped hence we'll use groups of HTML_QuickForm
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();
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']);
70 foreach ($privacyOptions as $name => $label) {
71 $privacy[] = $form->createElement('advcheckbox', $name, NULL, $label);
73 $form->addGroup($privacy, 'privacy', ts('Privacy'), ' ');
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);
80 $form->addGroup($commPreff, 'preferred_communication_method', ts('Preferred Method(s)'));
82 $form->add('select', 'preferred_language',
83 ts('Preferred Language'),
85 '' => ts('- select -')) +
86 CRM_Contact_BAO_Contact
::buildOptions('preferred_language')
89 if (!empty($privacyOptions)) {
90 $commPreference['privacy'] = $privacyOptions;
93 $commPreference['preferred_communication_method'] = $comm;
96 //using for display purpose.
97 $form->assign('commPreference', $commPreference);
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)'));
102 //check contact type and build filter clause accordingly for greeting types, CRM-4575
103 $greetings = self
::getGreetingFields($form->_contactType
);
105 foreach ($greetings as $greeting => $fields) {
107 'contact_type' => $form->_contactType
,
108 'greeting_type' => $greeting,
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'],
116 '' => ts('- select -')) +
$greetingTokens
119 $form->addElement('text', $fields['customField'], $fields['customLabel'],
120 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', $fields['customField']), $fields['js']
129 * @param array $fields the input form values
130 * @param array $files the uploaded files if any
131 * @param array $options additional user data
133 * @return true if no errors, else array of errors
137 static function formRule($fields, $files, $self) {
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)
146 $errors[$details['customField']] = ts('Custom %1 is a required field if %1 is of type Customized.',
147 array(1 => $details['label'])
151 return empty($errors) ?
TRUE : $errors;
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
162 static function setDefaultValues(&$form, &$defaults) {
164 if (!empty($defaults['preferred_language'])) {
165 $defaults['preferred_language'] = CRM_Utils_Array
::key($defaults['preferred_language'],
166 CRM_Contact_BAO_Contact
::buildOptions('preferred_language')
170 // CRM-7119: set preferred_language to default if unset
171 if (empty($defaults['preferred_language'])) {
172 $config = CRM_Core_Config
::singleton();
173 $defaults['preferred_language'] = $config->lcMessages
;
176 //set default from greeting types CRM-4575, CRM-9739
177 if ($form->_action
& CRM_Core_Action
::ADD
) {
178 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
179 if (empty($defaults[$greeting . '_id'])) {
180 if ($defaultGreetingTypeId =
181 CRM_Contact_BAO_Contact_Utils
::defaultGreeting($form->_contactType
, $greeting)
183 $defaults[$greeting . '_id'] = $defaultGreetingTypeId;
189 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
190 $name = "{$greeting}_display";
191 $form->assign($name, CRM_Utils_Array
::value($name, $defaults));
197 * set array of greeting fields
202 static function getGreetingFields($contactType) {
203 if (empty(self
::$greetings[$contactType])) {
204 self
::$greetings[$contactType] = array();
207 'onfocus' => "if (!this.value) { this.value='Dear ';} else return false",
208 'onblur' => "if ( this.value == 'Dear') { this.value='';} else return false",
211 self
::$greetings[$contactType] = array(
212 'addressee' => array(
213 'field' => 'addressee_id',
214 'customField' => 'addressee_custom',
215 'label' => ts('Addressee'),
216 'customLabel' => ts('Custom Addressee'),
219 'email_greeting' => array(
220 'field' => 'email_greeting_id',
221 'customField' => 'email_greeting_custom',
222 'label' => ts('Email Greeting'),
223 'customLabel' => ts('Custom Email Greeting'),
226 'postal_greeting' => array(
227 'field' => 'postal_greeting_id',
228 'customField' => 'postal_greeting_custom',
229 'label' => ts('Postal Greeting'),
230 'customLabel' => ts('Custom Postal Greeting'),
236 return self
::$greetings[$contactType];