3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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->addSelect('preferred_language');
84 if (!empty($privacyOptions)) {
85 $commPreference['privacy'] = $privacyOptions;
88 $commPreference['preferred_communication_method'] = $comm;
91 //using for display purpose.
92 $form->assign('commPreference', $commPreference);
94 $form->add('select', 'preferred_mail_format', ts('Email Format'), CRM_Core_SelectValues
::pmf());
95 $form->add('checkbox', 'is_opt_out', ts('NO BULK EMAILS (User Opt Out)'));
97 $communicationStyleOptions = array();
98 $communicationStyle = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'communication_style_id', array('localize' => TRUE));
99 foreach ($communicationStyle as $key => $var) {
100 $communicationStyleOptions[$key] = $form->createElement('radio', NULL,
101 ts('Communication Style'), $var, $key,
102 array('id' => "civicrm_communication_style_{$var}_{$key}")
105 if (!empty($communicationStyleOptions)) {
106 $form->addGroup($communicationStyleOptions, 'communication_style_id', ts('Communication Style'));
109 //check contact type and build filter clause accordingly for greeting types, CRM-4575
110 $greetings = self
::getGreetingFields($form->_contactType
);
112 foreach ($greetings as $greeting => $fields) {
114 'contact_type' => $form->_contactType
,
115 'greeting_type' => $greeting,
118 //add addressee in Contact form
119 $greetingTokens = CRM_Core_PseudoConstant
::greeting($filter);
120 if (!empty($greetingTokens)) {
121 $form->addElement('select', $fields['field'], $fields['label'],
123 '' => ts('- select -')) +
$greetingTokens
126 $form->addElement('text', $fields['customField'], $fields['customLabel'],
127 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', $fields['customField']), $fields['js']
136 * @param array $fields the input form values
137 * @param array $files the uploaded files if any
138 * @param array $options additional user data
140 * @return true if no errors, else array of errors
144 static function formRule($fields, $files, $self) {
147 $greetings = self
::getGreetingFields($self->_contactType
);
148 foreach ($greetings as $greeting => $details) {
149 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
150 if (CRM_Utils_Array
::value($details['field'], $fields) == $customizedValue && empty($fields[$details['customField']])) {
151 $errors[$details['customField']] = ts('Custom %1 is a required field if %1 is of type Customized.',
152 array(1 => $details['label'])
156 return empty($errors) ?
TRUE : $errors;
160 * This function sets the default values for the form. Note that in edit/view mode
161 * the default values are retrieved from the database
167 static function setDefaultValues(&$form, &$defaults) {
169 if (!empty($defaults['preferred_language'])) {
170 $languages = CRM_Contact_BAO_Contact
::buildOptions('preferred_language');
171 $defaults['preferred_language'] = CRM_Utils_Array
::key($defaults['preferred_language'], $languages);
174 // CRM-7119: set preferred_language to default if unset
175 if (empty($defaults['preferred_language'])) {
176 $config = CRM_Core_Config
::singleton();
177 $defaults['preferred_language'] = $config->lcMessages
;
180 if (empty($defaults['communication_style_id'])) {
181 $defaults['communication_style_id'] = array_pop(CRM_Core_OptionGroup
::values('communication_style', TRUE, NULL, NULL, 'AND is_default = 1'));
184 //set default from greeting types CRM-4575, CRM-9739
185 if ($form->_action
& CRM_Core_Action
::ADD
) {
186 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
187 if (empty($defaults[$greeting . '_id'])) {
188 if ($defaultGreetingTypeId =
189 CRM_Contact_BAO_Contact_Utils
::defaultGreeting($form->_contactType
, $greeting)
191 $defaults[$greeting . '_id'] = $defaultGreetingTypeId;
197 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
198 $name = "{$greeting}_display";
199 $form->assign($name, CRM_Utils_Array
::value($name, $defaults));
205 * set array of greeting fields
210 static function getGreetingFields($contactType) {
211 if (empty(self
::$greetings[$contactType])) {
212 self
::$greetings[$contactType] = array();
215 'onfocus' => "if (!this.value) { this.value='Dear ';} else return false",
216 'onblur' => "if ( this.value == 'Dear') { this.value='';} else return false",
219 self
::$greetings[$contactType] = array(
220 'addressee' => array(
221 'field' => 'addressee_id',
222 'customField' => 'addressee_custom',
223 'label' => ts('Addressee'),
224 'customLabel' => ts('Custom Addressee'),
227 'email_greeting' => array(
228 'field' => 'email_greeting_id',
229 'customField' => 'email_greeting_custom',
230 'label' => ts('Email Greeting'),
231 'customLabel' => ts('Custom Email Greeting'),
234 'postal_greeting' => array(
235 'field' => 'postal_greeting_id',
236 'customField' => 'postal_greeting_custom',
237 'label' => ts('Postal Greeting'),
238 'customLabel' => ts('Custom Postal Greeting'),
244 return self
::$greetings[$contactType];