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_Import_Forms
{
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'), NULL, 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('Saved Field Mapping'), ['' => ts('- select -')] +
$mappingArray);
71 if ($loadedMapping = $this->get('loadedMapping')) {
72 $this->setDefaults(['savedMapping' => $loadedMapping]);
76 CRM_Core_Form_Date
::buildAllowedDateFormats($this);
81 'name' => ts('Continue'),
82 'spacing' => ' ',
87 'name' => ts('Cancel'),
93 * A long-winded way to add one radio element to the form.
95 protected function addContactTypeSelector() {
96 //contact types option
97 $contactTypeOptions = [];
98 if (CRM_Contact_BAO_ContactType
::isActive('Individual')) {
99 $contactTypeOptions[CRM_Import_Parser
::CONTACT_INDIVIDUAL
] = ts('Individual');
101 if (CRM_Contact_BAO_ContactType
::isActive('Household')) {
102 $contactTypeOptions[CRM_Import_Parser
::CONTACT_HOUSEHOLD
] = ts('Household');
104 if (CRM_Contact_BAO_ContactType
::isActive('Organization')) {
105 $contactTypeOptions[CRM_Import_Parser
::CONTACT_ORGANIZATION
] = ts('Organization');
107 $this->addRadio('contactType', ts('Contact Type'), $contactTypeOptions);
110 'contactType' => CRM_Import_Parser
::CONTACT_INDIVIDUAL
,
117 * @param array $names
119 protected function storeFormValues($names) {
120 foreach ($names as $name) {
121 $this->set($name, $this->controller
->exportValue($this->_name
, $name));
126 * Common form postProcess.
128 * @param string $parserClassName
130 * @param string|null $entity
131 * Entity to set for paraser currently only for custom import
133 protected function submitFileForMapping($parserClassName, $entity = NULL) {
134 $this->controller
->resetPage('MapField');
135 CRM_Core_Session
::singleton()->set('dateTypes', $this->getSubmittedValue('dateFormats'));
139 $parser = new $parserClassName($mapper);
141 $parser->setEntity($this->get($entity));
143 $parser->setMaxLinesToProcess(100);
145 $this->getSubmittedValue('uploadFile'),
146 $this->getSubmittedValue('fieldSeparator'),
148 $this->getSubmittedValue('skipColumnHeader'),
149 CRM_Import_Parser
::MODE_MAPFIELD
,
150 $this->getSubmittedValue('contactType')
153 // add all the necessary variables to the form
158 * Return a descriptive name for the page, used in wizard header.
162 public function getTitle() {
163 return ts('Upload Data');