CRM/Export/Form/Map.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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 gets the name of the file to upload
  38  */
  39 class CRM_Export_Form_Map extends CRM_Core_Form {
  40
  41   /**
  42    * Mapper fields
  43    *
  44    * @var array
  45    */
  46   protected $_mapperFields;
  47
  48   /**
  49    * Number of columns in import file
  50    *
  51    * @var int
  52    */
  53   protected $_exportColumnCount;
  54
  55   /**
  56    * Loaded mapping ID
  57    *
  58    * @var int
  59    */
  60   protected $_mappingId;
  61
  62   /**
  63    * Build the form object
  64    *
  65    * @return void
  66    */
  67   public function preProcess() {
  68     $this->_exportColumnCount = $this->get('exportColumnCount');
  69     if (!$this->_exportColumnCount) {
  70       $this->_exportColumnCount = 10;
  71     }
  72     else {
  73       $this->_exportColumnCount = $this->_exportColumnCount + 10;
  74     }
  75
  76     $this->_mappingId = $this->get('mappingId');
  77   }
  78
  79   public function buildQuickForm() {
  80     CRM_Core_BAO_Mapping::buildMappingForm($this,
  81       'Export',
  82       $this->_mappingId,
  83       $this->_exportColumnCount,
  84       $blockCnt = 2,
  85       $this->get('exportMode')
  86     );
  87
  88     $this->addButtons(array(
  89         array(
  90           'type' => 'back',
  91           'name' => ts('Previous'),
  92         ),
  93         array(
  94           'type' => 'next',
  95           'name' => ts('Export'),
  96           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
  97         ),
  98         array(
  99           'type' => 'done',
 100           'name' => ts('Done'),
 101         ),
 102       )
 103     );
 104   }
 105
 106   /**
 107    * Global validation rules for the form
 108    *
 109    * @param array $fields
 110    *   Posted values of the form.
 111    *
 112    * @param $values
 113    * @param int $mappingTypeId
 114    *
 115    * @return array
 116    *   list of errors to be posted back to the form
 117    * @static
 118    */
 119   public static function formRule($fields, $values, $mappingTypeId) {
 120     $errors = array();
 121
 122     if (!empty($fields['saveMapping']) && !empty($fields['_qf_Map_next'])) {
 123       $nameField = CRM_Utils_Array::value('saveMappingName', $fields);
 124       if (empty($nameField)) {
 125         $errors['saveMappingName'] = ts('Name is required to save Export Mapping');
 126       }
 127       else {
 128         //check for Duplicate mappingName
 129         if (CRM_Core_BAO_Mapping::checkMapping($nameField, $mappingTypeId)) {
 130           $errors['saveMappingName'] = ts('Duplicate Export Mapping Name');
 131         }
 132       }
 133     }
 134
 135     if (!empty($errors)) {
 136       $_flag = 1;
 137       $assignError = new CRM_Core_Page();
 138       $assignError->assign('mappingDetailsError', $_flag);
 139       return $errors;
 140     }
 141     else {
 142       return TRUE;
 143     }
 144   }
 145
 146   /**
 147    * Process the uploaded file
 148    *
 149    * @return void
 150    */
 151   public function postProcess() {
 152     $params = $this->controller->exportValues($this->_name);
 153     $exportParams = $this->controller->exportValues('Select');
 154
 155     $greetingOptions = CRM_Export_Form_Select::getGreetingOptions();
 156
 157     if (!empty($greetingOptions)) {
 158       foreach ($greetingOptions as $key => $value) {
 159         if ($option = CRM_Utils_Array::value($key, $exportParams)) {
 160           if ($greetingOptions[$key][$option] == ts('Other')) {
 161             $exportParams[$key] = $exportParams["{$key}_other"];
 162           }
 163           elseif ($greetingOptions[$key][$option] == ts('List of names')) {
 164             $exportParams[$key] = '';
 165           }
 166           else {
 167             $exportParams[$key] = $greetingOptions[$key][$option];
 168           }
 169         }
 170       }
 171     }
 172
 173     $currentPath = CRM_Utils_System::currentPath();
 174
 175     $urlParams = NULL;
 176     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
 177     if (CRM_Utils_Rule::qfKey($qfKey)) {
 178       $urlParams = "&qfKey=$qfKey";
 179     }
 180
 181     //get the button name
 182     $buttonName = $this->controller->getButtonName('done');
 183     $buttonName1 = $this->controller->getButtonName('next');
 184     if ($buttonName == '_qf_Map_done') {
 185       $this->set('exportColumnCount', NULL);
 186       $this->controller->resetPage($this->_name);
 187       return CRM_Utils_System::redirect(CRM_Utils_System::url($currentPath, 'force=1' . $urlParams));
 188     }
 189
 190     if ($this->controller->exportValue($this->_name, 'addMore')) {
 191       $this->set('exportColumnCount', $this->_exportColumnCount);
 192       return;
 193     }
 194
 195     $mapperKeys = $params['mapper'][1];
 196
 197     $checkEmpty = 0;
 198     foreach ($mapperKeys as $value) {
 199       if ($value[0]) {
 200         $checkEmpty++;
 201       }
 202     }
 203
 204     if (!$checkEmpty) {
 205       $this->set('mappingId', NULL);
 206       CRM_Utils_System::redirect(CRM_Utils_System::url($currentPath, '_qf_Map_display=true' . $urlParams));
 207     }
 208
 209     if ($buttonName1 == '_qf_Map_next') {
 210       if (!empty($params['updateMapping'])) {
 211         //save mapping fields
 212         CRM_Core_BAO_Mapping::saveMappingFields($params, $params['mappingId']);
 213       }
 214
 215       if (!empty($params['saveMapping'])) {
 216         $mappingParams = array(
 217           'name' => $params['saveMappingName'],
 218           'description' => $params['saveMappingDesc'],
 219           'mapping_type_id' => $this->get('mappingTypeId'),
 220         );
 221
 222         $saveMapping = CRM_Core_BAO_Mapping::add($mappingParams);
 223
 224         //save mapping fields
 225         CRM_Core_BAO_Mapping::saveMappingFields($params, $saveMapping->id);
 226       }
 227     }
 228
 229     //get the csv file
 230     CRM_Export_BAO_Export::exportComponents($this->get('selectAll'),
 231       $this->get('componentIds'),
 232       $this->get('queryParams'),
 233       $this->get(CRM_Utils_Sort::SORT_ORDER),
 234       $mapperKeys,
 235       $this->get('returnProperties'),
 236       $this->get('exportMode'),
 237       $this->get('componentClause'),
 238       $this->get('componentTable'),
 239       $this->get('mergeSameAddress'),
 240       $this->get('mergeSameHousehold'),
 241       $exportParams
 242     );
 243   }
 244
 245   /**
 246    * Return a descriptive name for the page, used in wizard header
 247    *
 248    * @return string
 249    */
 250   public function getTitle() {
 251     return ts('Select Fields to Export');
 252   }
 253 }