CRM/Contact/Form/Task/ProximityCommon.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality to support Proximity Searches
  38  */
  39 class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task {
  40
  41   /**
  42    * The context that we are working on
  43    *
  44    * @var string
  45    */
  46   protected $_context;
  47
  48   /**
  49    * the groupId retrieved from the GET vars
  50    *
  51    * @var int
  52    */
  53   protected $_id;
  54
  55   /**
  56    * the title of the group
  57    *
  58    * @var string
  59    */
  60   protected $_title;
  61
  62   /**
  63    * build all the data structures needed to build the form
  64    *
  65    * @return void
  66    * @access public
  67    */
  68   function preProcess() {
  69     /*
  70      * initialize the task and row fields
  71      */
  72     parent::preProcess();
  73   }
  74
  75   /**
  76    * Build the form
  77    *
  78    * @access public
  79    *
  80    * @param $form
  81    * @param $proxSearch
  82    *
  83    * @return void
  84    */
  85   function buildQuickForm($form, $proxSearch) {
  86     // is proximity search required (2) or optional (1)?
  87     $proxRequired = ($proxSearch == 2 ? TRUE : FALSE);
  88     $form->assign('proximity_search', TRUE);
  89
  90     $form->add('text', 'prox_street_address', ts('Street Address'), NULL, FALSE);
  91
  92     $form->add('text', 'prox_city', ts('City'), NULL, FALSE);
  93
  94     $form->add('text', 'prox_postal_code', ts('Postal Code'), NULL, FALSE);
  95
  96     $defaults = self::setDefaultValues($form);
  97     if (!empty($defaults['prox_country_id'])) {
  98       $stateProvince = array('' => ts('- select -')) + CRM_Core_PseudoConstant::stateProvinceForCountry($defaults['prox_country_id']);
  99     }
 100     else {
 101       $stateProvince = array('' => ts('- select -')) + CRM_Core_PseudoConstant::stateProvince();
 102     }
 103     $form->add('select', 'prox_state_province_id', ts('State/Province'), $stateProvince, $proxRequired);
 104
 105     $country = array('' => ts('- select -')) + CRM_Core_PseudoConstant::country();
 106     $form->add('select', 'prox_country_id', ts('Country'), $country, $proxRequired);
 107
 108     $form->add('text', 'prox_distance', ts('Distance'), NULL, $proxRequired);
 109
 110     $proxUnits = array('km' => ts('km'), 'miles' => ts('miles'));
 111     $form->add('select', 'prox_distance_unit', ts('Units'), $proxUnits, $proxRequired);
 112     // prox_distance_unit
 113
 114     // state country js, CRM-5233
 115     $stateCountryMap = array();
 116     $stateCountryMap[] = array(
 117       'state_province' => 'prox_state_province_id',
 118       'country' => 'prox_country_id',
 119     );
 120     CRM_Core_BAO_Address::addStateCountryMap($stateCountryMap);
 121     CRM_Core_BAO_Address::fixAllStateSelects($this, $defaults);
 122     $form->addFormRule(array('CRM_Contact_Form_Task_ProximityCommon', 'formRule'), $form);
 123   }
 124
 125   /**
 126    * global form rule
 127    *
 128    * @param array $fields the input form values
 129    * @param array $files the uploaded files if any
 130    * @param $form
 131    *
 132    * @internal param array $options additional user data
 133    *
 134    * @return true if no errors, else array of errors
 135    * @access public
 136    * @static
 137    */
 138   static function formRule($fields, $files, $form) {
 139     $errors = array();
 140     // If Distance is present, make sure state, country and city or postal code are populated.
 141     if (!empty($fields['prox_distance'])) {
 142       if (empty($fields['prox_state_province_id']) || empty($fields['prox_country_id'])) {
 143         $errors["prox_state_province_id"] = ts("Country AND State/Province are required to search by distance.");
 144       }
 145       if (!CRM_Utils_Array::value('prox_postal_code', $fields) AND
 146         !CRM_Utils_Array::value('prox_city', $fields)
 147       ) {
 148         $errors["prox_distance"] = ts("City OR Postal Code are required to search by distance.");
 149       }
 150     }
 151
 152     return empty($errors) ? TRUE : $errors;
 153   }
 154
 155   /**
 156    * Set the default form values
 157    *
 158    * @access protected
 159    *
 160    * @param $form
 161    *
 162    * @return array the default array reference
 163    */
 164   function setDefaultValues($form) {
 165     $defaults       = array();
 166     $config         = CRM_Core_Config::singleton();
 167     $countryDefault = $config->defaultContactCountry;
 168
 169     if ($countryDefault) {
 170       $defaults['prox_country_id'] = $countryDefault;
 171       if ($countryDefault == '1228') {
 172         $defaults['prox_distance_unit'] = 'miles';
 173       }
 174       else {
 175         $defaults['prox_distance_unit'] = 'km';
 176       }
 177     }
 178     $form->setDefaults($defaults);
 179     return $defaults;
 180   }
 181 }
 182