CRM/Export/Form/Map.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  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     $this->_mappingId = $this->get('mappingId');
  70
  71     if (!$this->_exportColumnCount) {
  72       // Set default from saved mapping
  73       if ($this->_mappingId) {
  74         $mapping = new CRM_Core_DAO_MappingField();
  75         $mapping->mapping_id = $this->_mappingId;
  76         $this->_exportColumnCount = $mapping->count();
  77       }
  78       else {
  79         $this->_exportColumnCount = 10;
  80       }
  81     }
  82     else {
  83       $this->_exportColumnCount += 10;
  84     }
  85   }
  86
  87   public function buildQuickForm() {
  88     CRM_Core_BAO_Mapping::buildMappingForm($this,
  89       'Export',
  90       $this->_mappingId,
  91       $this->_exportColumnCount,
  92       2,
  93       $this->get('exportMode')
  94     );
  95
  96     $this->addButtons([
  97       [
  98         'type' => 'back',
  99         'name' => ts('Previous'),
 100       ],
 101       [
 102         'type' => 'next',
 103         'name' => ts('Export'),
 104         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 105       ],
 106       [
 107         'type' => 'done',
 108         'icon' => 'fa-times',
 109         'name' => ts('Done'),
 110       ],
 111     ]);
 112   }
 113
 114   /**
 115    * Global validation rules for the form.
 116    *
 117    * @param array $fields
 118    *   Posted values of the form.
 119    *
 120    * @param $values
 121    * @param int $mappingTypeId
 122    *
 123    * @return array
 124    *   list of errors to be posted back to the form
 125    */
 126   public static function formRule($fields, $values, $mappingTypeId) {
 127     $errors = [];
 128
 129     if (!empty($fields['saveMapping']) && !empty($fields['_qf_Map_next'])) {
 130       $nameField = CRM_Utils_Array::value('saveMappingName', $fields);
 131       if (empty($nameField)) {
 132         $errors['saveMappingName'] = ts('Name is required to save Export Mapping');
 133       }
 134       else {
 135         //check for Duplicate mappingName
 136         if (CRM_Core_BAO_Mapping::checkMapping($nameField, $mappingTypeId)) {
 137           $errors['saveMappingName'] = ts('Duplicate Export Mapping Name');
 138         }
 139       }
 140     }
 141
 142     if (!empty($errors)) {
 143       $_flag = 1;
 144       $assignError = new CRM_Core_Page();
 145       $assignError->assign('mappingDetailsError', $_flag);
 146       return $errors;
 147     }
 148     else {
 149       return TRUE;
 150     }
 151   }
 152
 153   /**
 154    * Process the uploaded file.
 155    *
 156    * @return void
 157    */
 158   public function postProcess() {
 159     $params = $this->controller->exportValues($this->_name);
 160     $exportParams = $this->controller->exportValues('Select');
 161
 162     $currentPath = CRM_Utils_System::currentPath();
 163
 164     $urlParams = NULL;
 165     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
 166     if (CRM_Utils_Rule::qfKey($qfKey)) {
 167       $urlParams = "&qfKey=$qfKey";
 168     }
 169
 170     //get the button name
 171     $buttonName = $this->controller->getButtonName('done');
 172     $buttonName1 = $this->controller->getButtonName('next');
 173     if ($buttonName == '_qf_Map_done') {
 174       $this->set('exportColumnCount', NULL);
 175       $this->controller->resetPage($this->_name);
 176       return CRM_Utils_System::redirect(CRM_Utils_System::url($currentPath, 'force=1' . $urlParams));
 177     }
 178
 179     if ($this->controller->exportValue($this->_name, 'addMore')) {
 180       $this->set('exportColumnCount', $this->_exportColumnCount);
 181       return;
 182     }
 183
 184     $mapperKeys = $params['mapper'][1];
 185
 186     $mappedFields = [];
 187     foreach ((array) $mapperKeys as $field) {
 188       if (!empty($field[1])) {
 189         $mappedFields[] = CRM_Core_BAO_Mapping::getMappingParams([], $field);
 190       }
 191     }
 192
 193     if (!$mappedFields) {
 194       $this->set('mappingId', NULL);
 195       CRM_Utils_System::redirect(CRM_Utils_System::url($currentPath, '_qf_Map_display=true' . $urlParams));
 196     }
 197
 198     if ($buttonName1 == '_qf_Map_next') {
 199       if (!empty($params['updateMapping'])) {
 200         //save mapping fields
 201         CRM_Core_BAO_Mapping::saveMappingFields($params, $params['mappingId']);
 202       }
 203
 204       if (!empty($params['saveMapping'])) {
 205         $mappingParams = [
 206           'name' => $params['saveMappingName'],
 207           'description' => $params['saveMappingDesc'],
 208           'mapping_type_id' => $this->get('mappingTypeId'),
 209         ];
 210
 211         $saveMapping = CRM_Core_BAO_Mapping::add($mappingParams);
 212
 213         //save mapping fields
 214         CRM_Core_BAO_Mapping::saveMappingFields($params, $saveMapping->id);
 215       }
 216     }
 217
 218     //get the csv file
 219     CRM_Export_BAO_Export::exportComponents($this->get('selectAll'),
 220       $this->get('componentIds'),
 221       (array) $this->get('queryParams'),
 222       $this->get(CRM_Utils_Sort::SORT_ORDER),
 223       $mappedFields,
 224       $this->get('returnProperties'),
 225       $this->get('exportMode'),
 226       $this->get('componentClause'),
 227       $this->get('componentTable'),
 228       $this->get('mergeSameAddress'),
 229       $this->get('mergeSameHousehold'),
 230       $exportParams,
 231       $this->get('queryOperator')
 232     );
 233   }
 234
 235   /**
 236    * Return a descriptive name for the page, used in wizard header
 237    *
 238    * @return string
 239    */
 240   public function getTitle() {
 241     return ts('Select Fields to Export');
 242   }
 243
 244 }