3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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;
78 * Explicitly declare the entity api name.
80 public function getDefaultEntity() {
85 * Explicitly declare the form context.
87 public function getDefaultContext() {
91 public function preProcess() {
92 CRM_Utils_System
::setTitle(ts('Organization Address and Contact Info'));
93 $breadCrumbPath = CRM_Utils_System
::url('civicrm/admin', 'reset=1');
94 CRM_Utils_System
::appendBreadCrumb(ts('Administer CiviCRM'), $breadCrumbPath);
95 $session = CRM_Core_Session
::singleton();
96 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));
98 $this->_id
= CRM_Core_Config
::domainID();
99 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String',
103 $location = new CRM_Contact_Form_Location();
104 $location->preProcess($this);
108 * This virtual function is used to set the default values of.
109 * various form elements
112 * reference to the array of default values
115 public function setDefaultValues() {
119 if (isset($this->_id
)) {
120 $params['id'] = $this->_id
;
121 CRM_Core_BAO_Domain
::retrieve($params, $domainDefaults);
122 $this->_contactId
= $domainDefaults['contact_id'];
123 //get the default domain from email address. fix CRM-3552
124 $optionValues = array();
125 $grpParams['name'] = 'from_email_address';
126 CRM_Core_OptionValue
::getValues($grpParams, $optionValues);
127 foreach ($optionValues as $Id => $value) {
128 if ($value['is_default'] && $value['is_active']) {
129 $this->_fromEmailId
= $Id;
130 $list = explode('"', $value['label']);
131 $domainDefaults['email_name'] = CRM_Utils_Array
::value(1, $list);
132 $domainDefaults['email_address'] = CRM_Utils_Mail
::pluckEmailFromHeader($value['label']);
137 unset($params['id']);
138 $locParams = array('contact_id' => $domainDefaults['contact_id']);
139 $this->_locationDefaults
= $defaults = CRM_Core_BAO_Location
::getValues($locParams);
141 $config = CRM_Core_Config
::singleton();
142 if (!isset($defaults['address'][1]['country_id'])) {
143 $defaults['address'][1]['country_id'] = $config->defaultContactCountry
;
146 if (!isset($defaults['address'][1]['state_province_id'])) {
147 $defaults['address'][1]['state_province_id'] = $config->defaultContactStateProvince
;
151 $defaults = array_merge($defaults, $domainDefaults);
156 * Build the form object.
160 public function buildQuickForm() {
161 $this->addField('name', array('label' => ts('Organization Name')), TRUE);
162 $this->addField('description', array('label' => ts('Description'), 'size' => 30));
163 $this->add('text', 'email_name', ts('FROM Name'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', 'email'), TRUE);
164 $this->add('text', 'email_address', ts('FROM Email Address'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', 'email'), TRUE);
165 $this->addRule('email_address', ts('Domain Email Address must use a valid email address format (e.g. \'info@example.org\').'), 'email');
167 //build location blocks.
168 CRM_Contact_Form_Location
::buildQuickForm($this);
170 $this->addButtons(array(
173 'name' => ts('Save'),
179 'name' => ts('Cancel'),
183 if ($this->_action
& CRM_Core_Action
::VIEW
) {
186 $this->assign('emailDomain', TRUE);
190 * Add local and global form rules.
195 public function addRules() {
196 $this->addFormRule(array('CRM_Contact_Form_Domain', 'formRule'));
200 * Global validation rules for the form.
202 * @param array $fields
203 * Posted values of the form.
206 * list of errors to be posted back to the form
208 public static function formRule($fields) {
209 // check for state/country mapping
210 $errors = CRM_Contact_Form_Edit_Address
::formRule($fields, CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullObject);
211 // $errors === TRUE means no errors from above formRule excution,
212 // so declaring $errors to array for further processing
213 if ($errors === TRUE) {
218 //as we use "fromName"<emailaddresss> format for domain email.
219 if (strpos($fields['email_name'], '"') !== FALSE) {
220 $errors['email_name'] = ts('Double quotes are not allow in from name.');
223 // Check for default from email address and organization (domain) name. Force them to change it.
224 if ($fields['email_address'] == 'info@EXAMPLE.ORG') {
225 $errors['email_address'] = ts('Please enter a valid default FROM email address for system-generated emails.');
227 if ($fields['name'] == 'Default Domain Name') {
228 $errors['name'] = ts('Please enter the name of the organization or entity which owns this CiviCRM site.');
231 return empty($errors) ?
TRUE : $errors;
235 * Process the form when submitted.
239 public function postProcess() {
240 $params = $this->exportValues();
241 $params['entity_id'] = $this->_id
;
242 $params['entity_table'] = CRM_Core_BAO_Domain
::getTableName();
243 $domain = CRM_Core_BAO_Domain
::edit($params, $this->_id
);
245 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
247 if (isset($this->_locationDefaults
['address'][1]['location_type_id'])) {
248 $params['address'][1]['location_type_id'] = $this->_locationDefaults
['address'][1]['location_type_id'];
251 $params['address'][1]['location_type_id'] = $defaultLocationType->id
;
254 if (isset($this->_locationDefaults
['phone'][1]['location_type_id'])) {
255 $params['phone'][1]['location_type_id'] = $this->_locationDefaults
['phone'][1]['location_type_id'];
258 $params['phone'][1]['location_type_id'] = $defaultLocationType->id
;
261 if (isset($this->_locationDefaults
['email'][1]['location_type_id'])) {
262 $params['email'][1]['location_type_id'] = $this->_locationDefaults
['email'][1]['location_type_id'];
265 $params['email'][1]['location_type_id'] = $defaultLocationType->id
;
268 $params +
= array('contact_id' => $this->_contactId
);
269 $contactParams = array(
270 'sort_name' => $domain->name
,
271 'display_name' => $domain->name
,
272 'legal_name' => $domain->name
,
273 'organization_name' => $domain->name
,
274 'contact_id' => $this->_contactId
,
275 'contact_type' => 'Organization',
278 if ($this->_contactId
) {
279 $contactParams['contact_sub_type'] = CRM_Contact_BAO_Contact
::getContactSubType($this->_contactId
);
282 CRM_Contact_BAO_Contact
::add($contactParams);
283 CRM_Core_BAO_Location
::create($params, TRUE);
285 CRM_Core_BAO_Domain
::edit($params, $this->_id
);
287 //set domain from email address, CRM-3552
288 $emailName = '"' . $params['email_name'] . '" <' . $params['email_address'] . '>';
290 $emailParams = array(
291 'label' => $emailName,
292 'description' => $params['description'],
297 $groupParams = array('name' => 'from_email_address');
299 //get the option value wt.
300 if ($this->_fromEmailId
) {
301 $action = $this->_action
;
302 $emailParams['weight'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_fromEmailId
, 'weight');
305 //add from email address.
306 $action = CRM_Core_Action
::ADD
;
307 $grpId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'from_email_address', 'id', 'name');
308 $fieldValues = array('option_group_id' => $grpId);
309 $emailParams['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues);
312 //reset default within domain.
313 $emailParams['reset_default_for'] = array('domain_id' => CRM_Core_Config
::domainID());
315 CRM_Core_OptionValue
::addOptionValue($emailParams, $groupParams, $action, $this->_fromEmailId
);
317 CRM_Core_Session
::setStatus(ts("Domain information for '%1' has been saved.", array(1 => $domain->name
)), ts('Saved'), 'success');
318 $session = CRM_Core_Session
::singleton();
319 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));