3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 generates form components for Address Section
39 class CRM_Admin_Form_Preferences_Address
extends CRM_Admin_Form_Preferences
{
40 public function preProcess() {
42 CRM_Utils_System
::setTitle(ts('Settings - Addresses'));
44 // Address Standardization
45 $addrProviders = array(
47 ) + CRM_Core_SelectValues
::addressProvider();
49 $this->_varNames
= array(
50 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
=> array(
51 'address_options' => array(
52 'html_type' => 'checkboxes',
53 'title' => ts('Address Fields'),
56 'address_format' => array(
57 'html_type' => 'textarea',
58 'title' => ts('Display Format'),
59 'description' => NULL,
62 'mailing_format' => array(
63 'html_type' => 'textarea',
64 'title' => ts('Mailing Label Format'),
65 'description' => NULL,
69 CRM_Core_BAO_Setting
::ADDRESS_STANDARDIZATION_PREFERENCES_NAME
=> array(
70 'address_standardization_provider' => array(
71 'html_type' => 'select',
72 'title' => ts('Provider'),
73 'option_values' => $addrProviders,
76 'address_standardization_userid' => array(
77 'html_type' => 'text',
78 'title' => ts('User ID'),
79 'description' => NULL,
82 'address_standardization_url' => array(
83 'html_type' => 'text',
84 'title' => ts('Web Service URL'),
85 'description' => NULL,
97 public function setDefaultValues() {
99 $defaults['address_standardization_provider'] = $this->_config
->address_standardization_provider
;
100 $defaults['address_standardization_userid'] = $this->_config
->address_standardization_userid
;
101 $defaults['address_standardization_url'] = $this->_config
->address_standardization_url
;
103 $this->addressSequence
= isset($newSequence) ?
$newSequence : "";
105 if (empty($this->_config
->address_format
)) {
106 $defaults['address_format'] = "
107 {contact.street_address}
108 {contact.supplemental_address_1}
109 {contact.supplemental_address_2}
110 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
115 $defaults['address_format'] = $this->_config
->address_format
;
118 if (empty($this->_config
->mailing_format
)) {
119 $defaults['mailing_format'] = "
121 {contact.street_address}
122 {contact.supplemental_address_1}
123 {contact.supplemental_address_2}
124 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
129 $defaults['mailing_format'] = $this->_config
->mailing_format
;
132 parent
::cbsDefaultValues($defaults);
138 * Build the form object.
142 public function buildQuickForm() {
143 $this->applyFilter('__ALL__', 'trim');
145 $this->addFormRule(array('CRM_Admin_Form_Preferences_Address', 'formRule'));
147 //get the tokens for Mailing Label field
148 $tokens = CRM_Core_SelectValues
::contactTokens();
149 $this->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
151 parent
::buildQuickForm();
159 public static function formRule($fields) {
160 $p = $fields['address_standardization_provider'];
161 $u = $fields['address_standardization_userid'];
162 $w = $fields['address_standardization_url'];
164 // make sure that there is a value for all of them
165 // if any of them are set
166 if ($p ||
$u ||
$w) {
167 if (!CRM_Utils_System
::checkPHPVersion(5, FALSE)) {
168 $errors['_qf_default'] = ts('Address Standardization features require PHP version 5 or greater.');
172 if (!($p && $u && $w)) {
173 $errors['_qf_default'] = ts('You must provide values for all three Address Standarization fields.');
182 * Process the form submission.
187 public function postProcess() {
188 if ($this->_action
== CRM_Core_Action
::VIEW
) {
192 $this->_params
= $this->controller
->exportValues($this->_name
);
194 // check if county option has been set
195 $options = CRM_Core_OptionGroup
::values('address_options', FALSE, FALSE, TRUE);
196 foreach ($options as $key => $title) {
197 if ($title == ts('County')) {
198 // check if the $key is present in $this->_params
199 if (isset($this->_params
['address_options']) &&
200 !empty($this->_params
['address_options'][$key])
202 // print a status message to the user if county table seems small
203 $countyCount = CRM_Core_DAO
::singleValueQuery("SELECT count(*) FROM civicrm_county");
204 if ($countyCount < 10) {
205 CRM_Core_Session
::setStatus(ts('You have enabled the County option. Please ensure you populate the county table in your CiviCRM Database. You can find extensions to populate counties in the <a %1>CiviCRM Extensions Directory</a>.', array(1 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', array('reset' => 1), TRUE, 'extensions-addnew') . '"')),
206 ts('Populate counties'),
214 $this->postProcessCommon();