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 * This class is to build the form for adding Group
39 class CRM_Contact_Form_Domain
extends CRM_Core_Form
{
42 * the group id, used when editing a group
49 * the contact_id of domain
53 protected $_contactId;
56 * default from email address option value id.
60 protected $_fromEmailId = NULL;
63 * default location type fields
67 protected $_locationDefaults = array();
70 * how many locationBlocks should we display?
75 CONST LOCATION_BLOCKS
= 1;
77 function preProcess() {
78 CRM_Utils_System
::setTitle(ts('Organization Address and Contact Info'));
79 $breadCrumbPath = CRM_Utils_System
::url('civicrm/admin', 'reset=1');
80 CRM_Utils_System
::appendBreadCrumb(ts('Administer CiviCRM'), $breadCrumbPath);
81 $session = CRM_Core_Session
::singleton();
82 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));
84 $this->_id
= CRM_Core_Config
::domainID();
85 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String',
89 $location = new CRM_Contact_Form_Location();
90 $location->preProcess($this);
94 * This function sets the default values for the form.
95 * the default values are retrieved from the database
100 function setDefaultValues() {
104 if (isset($this->_id
)) {
105 $params['id'] = $this->_id
;
106 CRM_Core_BAO_Domain
::retrieve($params, $domainDefaults);
107 $this->_contactId
= $domainDefaults['contact_id'];
108 //get the default domain from email address. fix CRM-3552
109 $optionValues = array();
110 $grpParams['name'] = 'from_email_address';
111 CRM_Core_OptionValue
::getValues($grpParams, $optionValues);
112 foreach ($optionValues as $Id => $value) {
113 if ($value['is_default'] && $value['is_active']) {
114 $this->_fromEmailId
= $Id;
115 $list = explode('"', $value['label']);
116 $domainDefaults['email_name'] = CRM_Utils_Array
::value(1, $list);
117 $domainDefaults['email_address'] = CRM_Utils_Mail
::pluckEmailFromHeader($value['label']);
122 unset($params['id']);
123 $locParams = array('contact_id' => $domainDefaults['contact_id']);
124 $this->_locationDefaults
= $defaults = CRM_Core_BAO_Location
::getValues($locParams);
126 $config = CRM_Core_Config
::singleton();
127 if (!isset($defaults['address'][1]['country_id'])) {
128 $defaults['address'][1]['country_id'] = $config->defaultContactCountry
;
131 if (!isset($defaults['address'][1]['state_province_id'])) {
132 $defaults['address'][1]['state_province_id'] = $config->defaultContactStateProvince
;
135 if (!empty($defaults['address'])) {
136 foreach ($defaults['address'] as $key => $value) {
137 CRM_Contact_Form_Edit_Address
::fixStateSelect($this,
138 "address[$key][country_id]",
139 "address[$key][state_province_id]",
140 "address[$key][county_id]",
141 CRM_Utils_Array
::value('country_id', $value,
142 $config->defaultContactCountry
144 CRM_Utils_Array
::value('state_province_id', $value,
145 $config->defaultContactStateProvince
151 $defaults = array_merge($defaults, $domainDefaults);
156 * Function to actually build the form
161 public function buildQuickForm() {
163 $this->add('text', 'name', ts('Organization Name'), array('size' => 25), TRUE);
164 $this->add('text', 'description', ts('Description'), array('size' => 25));
166 $this->add('text', 'email_name', ts('FROM Name'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', 'email'), TRUE);
168 $this->add('text', 'email_address', ts('FROM Email Address'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', 'email'), TRUE);
169 $this->addRule('email_address', ts('Domain Email Address must use a valid email address format (e.g. \'info@example.org\').'), 'email');
171 //build location blocks.
172 CRM_Contact_Form_Location
::buildQuickForm($this);
174 $this->addButtons(array(
177 'name' => ts('Save'),
183 'name' => ts('Cancel'),
187 if ($this->_action
& CRM_Core_Action
::VIEW
) {
190 $this->assign('emailDomain', TRUE);
194 * Add local and global form rules
200 function addRules() {
201 $this->addFormRule(array('CRM_Contact_Form_Domain', 'formRule'));
205 * global validation rules for the form
207 * @param array $fields posted values of the form
209 * @return array list of errors to be posted back to the form
213 static function formRule($fields) {
214 // check for state/country mapping
215 $errors = CRM_Contact_Form_Edit_Address
::formRule($fields, CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullObject);
216 // $errors === TRUE means no errors from above formRule excution,
217 // so declaring $errors to array for futher processing
218 if ($errors === TRUE) {
223 //as we use "fromName"<emailaddresss> format for domain email.
224 if (strpos($fields['email_name'], '"') !== FALSE) {
225 $errors['email_name'] = ts('Double quotes are not allow in from name.');
228 // Check for default from email address and organization (domain) name. Force them to change it.
229 if ($fields['email_address'] == 'info@EXAMPLE.ORG') {
230 $errors['email_address'] = ts('Please enter a valid default FROM email address for system-generated emails.');
232 if ($fields['name'] == 'Default Domain Name') {
233 $errors['name'] = ts('Please enter the name of the organization or entity which owns this CiviCRM site.');
236 return empty($errors) ?
TRUE : $errors;
240 * Process the form when submitted
245 public function postProcess() {
246 $params = $this->exportValues();
247 $params['entity_id'] = $this->_id
;
248 $params['entity_table'] = CRM_Core_BAO_Domain
::getTableName();
249 $domain = CRM_Core_BAO_Domain
::edit($params, $this->_id
);
251 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
253 if (isset($this->_locationDefaults
['address'][1]['location_type_id'])) {
254 $params['address'][1]['location_type_id'] = $this->_locationDefaults
['address'][1]['location_type_id'];
257 $params['address'][1]['location_type_id'] = $defaultLocationType->id
;
260 if (isset($this->_locationDefaults
['phone'][1]['location_type_id'])) {
261 $params['phone'][1]['location_type_id'] = $this->_locationDefaults
['phone'][1]['location_type_id'];
264 $params['phone'][1]['location_type_id'] = $defaultLocationType->id
;
267 if (isset($this->_locationDefaults
['email'][1]['location_type_id'])) {
268 $params['email'][1]['location_type_id'] = $this->_locationDefaults
['email'][1]['location_type_id'];
271 $params['email'][1]['location_type_id'] = $defaultLocationType->id
;
274 $params +
= array('contact_id' => $this->_contactId
);
275 $contactParams = array (
276 'sort_name' => $domain->name
,
277 'display_name' => $domain->name
,
278 'legal_name' => $domain->name
,
279 'organization_name' => $domain->name
,
280 'contact_id' => $this->_contactId
,
281 'contact_type' => 'Organization',
284 if ($this->_contactId
) {
285 $contactParams['contact_sub_type'] = CRM_Contact_BAO_Contact
::getContactSubType($this->_contactId
);
288 CRM_Contact_BAO_Contact
::add($contactParams);
289 CRM_Core_BAO_Location
::create($params, TRUE);
291 CRM_Core_BAO_Domain
::edit($params, $this->_id
);
293 //set domain from email address, CRM-3552
294 $emailName = '"' . $params['email_name'] . '" <' . $params['email_address'] . '>';
296 $emailParams = array(
297 'label' => $emailName,
298 'description' => $params['description'],
303 $groupParams = array('name' => 'from_email_address');
305 //get the option value wt.
306 if ($this->_fromEmailId
) {
307 $action = $this->_action
;
308 $emailParams['weight'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_fromEmailId
, 'weight');
311 //add from email address.
312 $action = CRM_Core_Action
::ADD
;
313 $grpId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'from_email_address', 'id', 'name');
314 $fieldValues = array('option_group_id' => $grpId);
315 $emailParams['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues);
319 //reset default within domain.
320 $emailParams['reset_default_for'] = array('domain_id' => CRM_Core_Config
::domainID());
322 CRM_Core_OptionValue
::addOptionValue($emailParams, $groupParams, $action, $this->_fromEmailId
);
324 CRM_Core_Session
::setStatus(ts("Domain information for '%1' has been saved.", array(1 => $domain->name
)), ts('Saved'), 'success');
325 $session = CRM_Core_Session
::singleton();
326 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));