CRM/Admin/Form/Setting/Mapping.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 generates form components for Mapping and Geocoding
  38  *
  39  */
  40 class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting {
  41
  42   /**
  43    * Function to build the form
  44    *
  45    * @return void
  46    * @access public
  47    */
  48   public function buildQuickForm() {
  49     CRM_Utils_System::setTitle(ts('Settings - Mapping and Geocoding Providers'));
  50
  51     $map = CRM_Core_SelectValues::mapProvider();
  52     $geo = CRM_Core_SelectValues::geoProvider();
  53     $this->addElement('select', 'mapProvider', ts('Mapping Provider'), array('' => '- select -') + $map, array('onChange' => 'showHideMapAPIkey( this.value );'));
  54     $this->add('text', 'mapAPIKey', ts('Map Provider Key'), NULL);
  55     $this->addElement('select', 'geoProvider', ts('Geocoding Provider'), array('' => '- select -') + $geo);
  56     $this->add('text', 'geoAPIKey', ts('Geo Provider Key'), NULL);
  57
  58     parent::buildQuickForm();
  59   }
  60
  61   /**
  62    * global form rule
  63    *
  64    * @param array $fields  the input form values
  65    *
  66    * @return true if no errors, else array of errors
  67    * @access public
  68    * @static
  69    */
  70   static function formRule($fields) {
  71     $errors = array();
  72
  73     if (!CRM_Utils_System::checkPHPVersion(5, FALSE)) {
  74       $errors['_qf_default'] = ts('Mapping features require PHP version 5 or greater');
  75     }
  76
  77     if (!$fields['mapAPIKey'] && ($fields['mapProvider'] != '' && $fields['mapProvider'] == 'Yahoo')) {
  78       $errors['mapAPIKey'] = "Map Provider key is a required field.";
  79     }
  80
  81     if ($fields['mapProvider'] == 'OpenStreetMaps' && $fields['geoProvider'] == '') {
  82       $errors['geoProvider'] = "Please select a Geocoding Provider - Open Street Maps does not provide geocoding.";
  83     }
  84
  85     return $errors;
  86   }
  87
  88   /**
  89    * This function is used to add the rules (mainly global rules) for form.
  90    * All local rules are added near the element
  91    *
  92    * @param null
  93    *
  94    * @return void
  95    * @access public
  96    */
  97   function addRules() {
  98     $this->addFormRule(array('CRM_Admin_Form_Setting_Mapping', 'formRule'));
  99   }
 100 }
 101