3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
14 * @copyright CiviCRM LLC https://civicrm.org/licensing
18 * Base class for upload-only import forms (all but Contact import).
20 abstract class CRM_Import_Form_DataSource
extends CRM_Core_Form
{
23 * Set variables up before form is built.
25 public function preProcess() {
26 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE);
29 $params .= "&id={$this->_id}";
31 CRM_Core_Session
::singleton()->pushUserContext(CRM_Utils_System
::url(static::PATH
, $params));
33 // check for post max size
34 CRM_Utils_Number
::formatUnitSize(ini_get('post_max_size'), TRUE);
38 * Common form elements.
40 public function buildQuickForm() {
41 $config = CRM_Core_Config
::singleton();
43 $uploadFileSize = CRM_Utils_Number
::formatUnitSize($config->maxFileSize
. 'm', TRUE);
45 //Fetch uploadFileSize from php_ini when $config->maxFileSize is set to "no limit".
46 if (empty($uploadFileSize)) {
47 $uploadFileSize = CRM_Utils_Number
::formatUnitSize(ini_get('upload_max_filesize'), TRUE);
49 $uploadSize = round(($uploadFileSize / (1024 * 1024)), 2);
51 $this->assign('uploadSize', $uploadSize);
53 $this->add('File', 'uploadFile', ts('Import Data File'), 'size=30 maxlength=255', TRUE);
54 $this->setMaxFileSize($uploadFileSize);
55 $this->addRule('uploadFile', ts('File size should be less than %1 MBytes (%2 bytes)', [
58 ]), 'maxfilesize', $uploadFileSize);
59 $this->addRule('uploadFile', ts('A valid file must be uploaded.'), 'uploadedfile');
60 $this->addRule('uploadFile', ts('Input file must be in CSV format'), 'utf8File');
62 $this->addElement('checkbox', 'skipColumnHeader', ts('First row contains column headers'));
64 $this->add('text', 'fieldSeparator', ts('Import Field Separator'), ['size' => 2], TRUE);
65 $this->setDefaults(['fieldSeparator' => $config->fieldSeparator
]);
66 $mappingArray = CRM_Core_BAO_Mapping
::getCreateMappingValues('Import ' . static::IMPORT_ENTITY
);
68 $this->assign('savedMapping', $mappingArray);
69 $this->add('select', 'savedMapping', ts('Mapping Option'), ['' => ts('- select -')] +
$mappingArray);
71 if ($loadedMapping = $this->get('loadedMapping')) {
72 $this->assign('loadedMapping', $loadedMapping);
73 $this->setDefaults(['savedMapping' => $loadedMapping]);
77 CRM_Core_Form_Date
::buildAllowedDateFormats($this);
82 'name' => ts('Continue'),
83 'spacing' => ' ',
88 'name' => ts('Cancel'),
94 * A long-winded way to add one radio element to the form.
96 protected function addContactTypeSelector() {
97 //contact types option
99 if (CRM_Contact_BAO_ContactType
::isActive('Individual')) {
100 $contactOptions[] = $this->createElement('radio',
101 NULL, NULL, ts('Individual'), CRM_Import_Parser
::CONTACT_INDIVIDUAL
104 if (CRM_Contact_BAO_ContactType
::isActive('Household')) {
105 $contactOptions[] = $this->createElement('radio',
106 NULL, NULL, ts('Household'), CRM_Import_Parser
::CONTACT_HOUSEHOLD
109 if (CRM_Contact_BAO_ContactType
::isActive('Organization')) {
110 $contactOptions[] = $this->createElement('radio',
111 NULL, NULL, ts('Organization'), CRM_Import_Parser
::CONTACT_ORGANIZATION
115 $this->addGroup($contactOptions, 'contactType',
120 'contactType' => CRM_Import_Parser
::CONTACT_INDIVIDUAL
,
127 * @param array $names
129 protected function storeFormValues($names) {
130 foreach ($names as $name) {
131 $this->set($name, $this->controller
->exportValue($this->_name
, $name));
136 * Common form postProcess.
138 * @param string $parserClassName
140 * @param string|null $entity
141 * Entity to set for paraser currently only for custom import
143 protected function submitFileForMapping($parserClassName, $entity = NULL) {
144 $this->controller
->resetPage('MapField');
146 $fileName = $this->controller
->exportValue($this->_name
, 'uploadFile');
147 $skipColumnHeader = $this->controller
->exportValue($this->_name
, 'skipColumnHeader');
149 $session = CRM_Core_Session
::singleton();
150 $session->set("dateTypes", $this->get('dateFormats'));
152 $separator = $this->controller
->exportValue($this->_name
, 'fieldSeparator');
156 $parser = new $parserClassName($mapper);
158 $parser->setEntity($this->get($entity));
160 $parser->setMaxLinesToProcess(100);
161 $parser->run($fileName,
165 CRM_Import_Parser
::MODE_MAPFIELD
,
166 $this->get('contactType')
169 // add all the necessary variables to the form
174 * Return a descriptive name for the page, used in wizard header.
178 public function getTitle() {
179 return ts('Upload Data');