CRM/Admin/Form/Setting/Mapping.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * This class generates form components for Mapping and Geocoding.
  36  */
  37 class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting {
  38
  39   protected $_settings = array(
  40     'mapAPIKey' => CRM_Core_BAO_Setting::MAP_PREFERENCES_NAME,
  41     'mapProvider' => CRM_Core_BAO_Setting::MAP_PREFERENCES_NAME,
  42     'geoAPIKey' => CRM_Core_BAO_Setting::MAP_PREFERENCES_NAME,
  43     'geoProvider' => CRM_Core_BAO_Setting::MAP_PREFERENCES_NAME,
  44   );
  45
  46   /**
  47    * Build the form object.
  48    */
  49   public function buildQuickForm() {
  50     CRM_Utils_System::setTitle(ts('Settings - Mapping and Geocoding Providers'));
  51     parent::buildQuickForm();
  52   }
  53
  54   /**
  55    * Global form rule.
  56    *
  57    * @param array $fields
  58    *   The input form values.
  59    *
  60    * @return bool|array
  61    *   true if no errors, else array of errors
  62    */
  63   public static function formRule($fields) {
  64     $errors = array();
  65
  66     if (!CRM_Utils_System::checkPHPVersion(5, FALSE)) {
  67       $errors['_qf_default'] = ts('Mapping features require PHP version 5 or greater');
  68     }
  69
  70     if (!$fields['mapAPIKey'] && ($fields['mapProvider'] != '' && $fields['mapProvider'] == 'Yahoo')) {
  71       $errors['mapAPIKey'] = "Map Provider key is a required field.";
  72     }
  73
  74     if ($fields['mapProvider'] == 'OpenStreetMaps' && $fields['geoProvider'] == '') {
  75       $errors['geoProvider'] = "Please select a Geocoding Provider - Open Street Maps does not provide geocoding.";
  76     }
  77
  78     return $errors;
  79   }
  80
  81   /**
  82    * Add the rules (mainly global rules) for form.
  83    *
  84    * All local rules are added near the element
  85    */
  86   public function addRules() {
  87     $this->addFormRule(array('CRM_Admin_Form_Setting_Mapping', 'formRule'));
  88   }
  89
  90 }