CRM/Export/Form/Map.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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    * @access protected
  46    */
  47   protected $_mapperFields;
  48
  49   /**
  50    * number of columns in import file
  51    *
  52    * @var int
  53    * @access protected
  54    */
  55   protected $_exportColumnCount;
  56
  57   /**
  58    * loaded mapping ID
  59    *
  60    * @var int
  61    * @access protected
  62    */
  63   protected $_mappingId;
  64
  65   /**
  66    * Function to actually build the form
  67    *
  68    * @return void
  69    * @access public
  70    */
  71   public function preProcess() {
  72     $this->_exportColumnCount = $this->get('exportColumnCount');
  73     if (!$this->_exportColumnCount) {
  74       $this->_exportColumnCount = 10;
  75     }
  76     else {
  77       $this->_exportColumnCount = $this->_exportColumnCount + 10;
  78     }
  79
  80     $this->_mappingId = $this->get('mappingId');
  81   }
  82
  83   public function buildQuickForm() {
  84     CRM_Core_BAO_Mapping::buildMappingForm($this,
  85       'Export',
  86       $this->_mappingId,
  87       $this->_exportColumnCount,
  88       $blockCnt = 2,
  89       $this->get('exportMode')
  90     );
  91
  92     $this->addButtons(array(
  93         array(
  94           'type' => 'back',
  95           'name' => ts('<< Previous'),
  96         ),
  97         array(
  98           'type' => 'next',
  99           'name' => ts('Export >>'),
 100           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 101         ),
 102         array(
 103           'type' => 'done',
 104           'name' => ts('Done'),
 105         ),
 106       )
 107     );
 108   }
 109
 110   /**
 111    * global validation rules for the form
 112    *
 113    * @param array $fields posted values of the form
 114    *
 115    * @return array list of errors to be posted back to the form
 116    * @static
 117    * @access public
 118    */
 119   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    * @access public
 151    */
 152   public function postProcess() {
 153     $params = $this->controller->exportValues($this->_name);
 154     $exportParams = $this->controller->exportValues('Select');
 155
 156     $greetingOptions = CRM_Export_Form_Select::getGreetingOptions();
 157
 158     if (!empty($greetingOptions)) {
 159       foreach ($greetingOptions as $key => $value) {
 160         if ($option = CRM_Utils_Array::value($key, $exportParams)) {
 161           if ($greetingOptions[$key][$option] == ts('Other')) {
 162             $exportParams[$key] = $exportParams["{$key}_other"];
 163           }
 164           elseif ($greetingOptions[$key][$option] == ts('List of names')) {
 165             $exportParams[$key] = '';
 166           }
 167           else {
 168             $exportParams[$key] = $greetingOptions[$key][$option];
 169           }
 170         }
 171       }
 172     }
 173
 174     $currentPath = CRM_Utils_System::currentPath();
 175
 176     $urlParams = NULL;
 177     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
 178     if (CRM_Utils_Rule::qfKey($qfKey)) {
 179       $urlParams = "&qfKey=$qfKey";
 180     }
 181
 182     //get the button name
 183     $buttonName = $this->controller->getButtonName('done');
 184     $buttonName1 = $this->controller->getButtonName('next');
 185     if ($buttonName == '_qf_Map_done') {
 186       $this->set('exportColumnCount', NULL);
 187       $this->controller->resetPage($this->_name);
 188       return CRM_Utils_System::redirect(CRM_Utils_System::url($currentPath, 'force=1' . $urlParams));
 189     }
 190
 191     if ($this->controller->exportValue($this->_name, 'addMore')) {
 192       $this->set('exportColumnCount', $this->_exportColumnCount);
 193       return;
 194     }
 195
 196     $mapperKeys = $params['mapper'][1];
 197
 198     $checkEmpty = 0;
 199     foreach ($mapperKeys as $value) {
 200       if ($value[0]) {
 201         $checkEmpty++;
 202       }
 203     }
 204
 205     if (!$checkEmpty) {
 206       $this->set('mappingId', NULL);
 207       CRM_Utils_System::redirect(CRM_Utils_System::url($currentPath, '_qf_Map_display=true' . $urlParams));
 208     }
 209
 210     if ($buttonName1 == '_qf_Map_next') {
 211       if (!empty($params['updateMapping'])) {
 212         //save mapping fields
 213         CRM_Core_BAO_Mapping::saveMappingFields($params, $params['mappingId']);
 214       }
 215
 216       if (!empty($params['saveMapping'])) {
 217         $mappingParams = array(
 218           'name' => $params['saveMappingName'],
 219           'description' => $params['saveMappingDesc'],
 220           'mapping_type_id' => $this->get('mappingTypeId'),
 221         );
 222
 223         $saveMapping = CRM_Core_BAO_Mapping::add($mappingParams);
 224
 225         //save mapping fields
 226         CRM_Core_BAO_Mapping::saveMappingFields($params, $saveMapping->id);
 227       }
 228     }
 229
 230     //get the csv file
 231     CRM_Export_BAO_Export::exportComponents($this->get('selectAll'),
 232       $this->get('componentIds'),
 233       $this->get('queryParams'),
 234       $this->get(CRM_Utils_Sort::SORT_ORDER),
 235       $mapperKeys,
 236       $this->get('returnProperties'),
 237       $this->get('exportMode'),
 238       $this->get('componentClause'),
 239       $this->get('componentTable'),
 240       $this->get('mergeSameAddress'),
 241       $this->get('mergeSameHousehold'),
 242       $exportParams
 243     );
 244   }
 245
 246   /**
 247    * Return a descriptive name for the page, used in wizard header
 248    *
 249    * @return string
 250    * @access public
 251    */
 252   public function getTitle() {
 253     return ts('Select Fields to Export');
 254   }
 255 }
 256