3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2017
34 * Base class for upload-only import forms (all but Contact import).
36 abstract class CRM_Import_Form_DataSource
extends CRM_Core_Form
{
39 * Set variables up before form is built.
41 public function preProcess() {
42 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE);
45 $params .= "&id={$this->_id}";
47 CRM_Core_Session
::singleton()->pushUserContext(CRM_Utils_System
::url(static::PATH
, $params));
49 // check for post max size
50 CRM_Utils_Number
::formatUnitSize(ini_get('post_max_size'), TRUE);
54 * Common form elements.
56 public function buildQuickForm() {
57 $config = CRM_Core_Config
::singleton();
59 $uploadFileSize = CRM_Utils_Number
::formatUnitSize($config->maxFileSize
. 'm', TRUE);
61 //Fetch uploadFileSize from php_ini when $config->maxFileSize is set to "no limit".
62 if (empty($uploadFileSize)) {
63 $uploadFileSize = CRM_Utils_Number
::formatUnitSize(ini_get('upload_max_filesize'), TRUE);
65 $uploadSize = round(($uploadFileSize / (1024 * 1024)), 2);
67 $this->assign('uploadSize', $uploadSize);
69 $this->add('File', 'uploadFile', ts('Import Data File'), 'size=30 maxlength=255', TRUE);
70 $this->setMaxFileSize($uploadFileSize);
71 $this->addRule('uploadFile', ts('File size should be less than %1 MBytes (%2 bytes)', array(
74 )), 'maxfilesize', $uploadFileSize);
75 $this->addRule('uploadFile', ts('A valid file must be uploaded.'), 'uploadedfile');
76 $this->addRule('uploadFile', ts('Input file must be in CSV format'), 'utf8File');
78 $this->addElement('checkbox', 'skipColumnHeader', ts('First row contains column headers'));
80 $this->add('text', 'fieldSeparator', ts('Import Field Separator'), array('size' => 2), TRUE);
81 $this->setDefaults(array('fieldSeparator' => $config->fieldSeparator
));
83 //get the saved mapping details
84 $mappingArray = CRM_Core_BAO_Mapping
::getMappings('Import ' . static::IMPORT_ENTITY
);
85 $this->assign('savedMapping', $mappingArray);
86 $this->add('select', 'savedMapping', ts('Mapping Option'), array('' => ts('- select -')) +
$mappingArray);
88 if ($loadedMapping = $this->get('loadedMapping')) {
89 $this->assign('loadedMapping', $loadedMapping);
90 $this->setDefaults(array('savedMapping' => $loadedMapping));
94 CRM_Core_Form_Date
::buildAllowedDateFormats($this);
96 $this->addButtons(array(
99 'name' => ts('Continue'),
100 'spacing' => ' ',
105 'name' => ts('Cancel'),
112 * A long-winded way to add one radio element to the form.
114 protected function addContactTypeSelector() {
115 //contact types option
116 $contactOptions = array();
117 if (CRM_Contact_BAO_ContactType
::isActive('Individual')) {
118 $contactOptions[] = $this->createElement('radio',
119 NULL, NULL, ts('Individual'), CRM_Import_Parser
::CONTACT_INDIVIDUAL
122 if (CRM_Contact_BAO_ContactType
::isActive('Household')) {
123 $contactOptions[] = $this->createElement('radio',
124 NULL, NULL, ts('Household'), CRM_Import_Parser
::CONTACT_HOUSEHOLD
127 if (CRM_Contact_BAO_ContactType
::isActive('Organization')) {
128 $contactOptions[] = $this->createElement('radio',
129 NULL, NULL, ts('Organization'), CRM_Import_Parser
::CONTACT_ORGANIZATION
133 $this->addGroup($contactOptions, 'contactType',
137 $this->setDefaults(array(
138 'contactType' => CRM_Import_Parser
::CONTACT_INDIVIDUAL
,
145 * @param array $names
147 protected function storeFormValues($names) {
148 foreach ($names as $name) {
149 $this->set($name, $this->controller
->exportValue($this->_name
, $name));
154 * Common form postProcess.
156 * @param string $parserClassName
158 * @param string|null $entity
159 * Entity to set for paraser currently only for custom import
161 protected function submitFileForMapping($parserClassName, $entity = NULL) {
162 $this->controller
->resetPage('MapField');
164 $fileName = $this->controller
->exportValue($this->_name
, 'uploadFile');
165 $skipColumnHeader = $this->controller
->exportValue($this->_name
, 'skipColumnHeader');
167 $session = CRM_Core_Session
::singleton();
168 $session->set("dateTypes", $this->get('dateFormats'));
170 $separator = $this->controller
->exportValue($this->_name
, 'fieldSeparator');
174 $parser = new $parserClassName($mapper);
176 $parser->setEntity($this->get($entity));
178 $parser->setMaxLinesToProcess(100);
179 $parser->run($fileName,
183 CRM_Import_Parser
::MODE_MAPFIELD
,
184 $this->get('contactType')
187 // add all the necessary variables to the form
192 * Return a descriptive name for the page, used in wizard header.
196 public function getTitle() {
197 return ts('Upload Data');