45380 multiple contact types in form specific options (#770)

* 45380 multiple contact types in form specific options * 45380 update unit test * 45380 update logic migrate contact types * 45380 update unit test * 45380 refactor code * 45380 refactor code * 45380 update unit test * 45380 fix conflict * 45380 remove input field renderer * 45380 update unit test * Small refactoring for unused styling and readability #4116037 * Remove unused select2 call #4116037 --------- Co-authored-by: Frederic Alpers <88546396+fredericalpers@users.noreply.github.com> Co-authored-by: andernath <chibineko@gmail.com>
onOffice-Web-Org · Aug 15, 2024 · b47552a · b47552a
1 parent 47a6f6b
commit b47552a
Show file tree

Hide file tree

Showing 24 changed files with 194 additions and 28 deletions.
diff --git a/dist/onoffice-custom-select.min.js b/dist/onoffice-custom-select.min.js
diff --git a/js/onoffice-custom-select.js b/js/onoffice-custom-select.js
@@ -1,12 +1,19 @@
 const custom_select2 = (typeof custom_select2_translation !== 'undefined') ? custom_select2_translation : {};
 jQuery(document).ready(function ($) {
+	const $adminSelect = $('.oo-poststuff .custom-input-field .oo-custom-select2');
 	const $multiSelectAdminSorting = $('#viewrecordssorting .oo-custom-select2.oo-custom-select2--multiple');
 	const $singleSelectAdminSorting = $("#viewrecordssorting .oo-custom-select2.oo-custom-select2--single");
 
 	$('.custom-multiple-select, .custom-single-select').select2({
 		width: '100%'
 	});
 
+	if ($adminSelect.length > 0) {
+		$adminSelect.select2({
+			width: '50%'
+		});
+	}
+
 	if ($multiSelectAdminSorting.length) {
 		$multiSelectAdminSorting.select2({
 			placeholder: custom_select2.multipleSelectOptions,

diff --git a/plugin/DataFormConfiguration/DataFormConfiguration.php b/plugin/DataFormConfiguration/DataFormConfiguration.php
@@ -67,8 +67,8 @@ class DataFormConfiguration
 	/** @var bool */
 	private $_showEstateContext = false;
 
-	/** @var bool */
-	private $_contactType = '';
+	/** @var array */
+	private $_contactType = [];
 
 	/** @var string */
 	private $_recipient = '';
@@ -142,8 +142,8 @@ public function addAvailableOptionsField(string $availableOptionsField)
 	public function setShowEstateContext(bool $showEstateContext)
 		{ $this->_showEstateContext = $showEstateContext; }
 
-	/** @param string $contactTypeField */
-	public function setContactTypeField(string $contactTypeField)
+	/** @param array $contactTypeField */
+	public function setContactTypeField(array $contactTypeField)
 		{ $this->_contactType = $contactTypeField; }
 
 	/** @return array */
@@ -219,8 +219,8 @@ public function setId(int $id)
 	public function getShowEstateContext(): bool
 		{ return $this->_showEstateContext; }
 
-	/** @return string */
-	public function getContactType(): string
+	/** @return array */
+	public function getContactType(): array
 		{ return $this->_contactType; }
 
 	/** @return bool */

diff --git a/plugin/DataFormConfiguration/DataFormConfigurationFactory.php b/plugin/DataFormConfiguration/DataFormConfigurationFactory.php
@@ -283,7 +283,7 @@ private function configureContact(array $row, DataFormConfigurationContact $pCon
 		$pConfig->setCheckDuplicateOnCreateAddress((bool)$row['checkduplicates']);
 		$pConfig->setNewsletterCheckbox((bool)$row['newsletter']);
 		$pConfig->setShowEstateContext((bool)$row['show_estate_context']);
-		$pConfig->setContactTypeField($row['contact_type'] ?? '');
+		$pConfig->setContactTypeField($row['contact_type'] ?? []);
 	}
 
 
@@ -336,7 +336,7 @@ private function configureOwner(array $row, DataFormConfigurationOwner $pConfig)
 		$pConfig->setPages($row['pages']);
 		$pConfig->setCreateOwner((bool)$row['createaddress']);
 		$pConfig->setCheckDuplicateOnCreateAddress((bool)$row['checkduplicates']);
-		$pConfig->setContactTypeField($row['contact_type'] ?? '');
+		$pConfig->setContactTypeField($row['contact_type'] ?? []);
 	}
 
 
@@ -354,7 +354,7 @@ private function configureInterest(array $row, DataFormConfigurationInterest $pC
 		$pConfig->setSubject($row['subject']);
 		$pConfig->setCreateInterest((bool)$row['createaddress']);
 		$pConfig->setCheckDuplicateOnCreateAddress($row['checkduplicates']);
-		$pConfig->setContactTypeField($row['contact_type'] ?? '');
+		$pConfig->setContactTypeField($row['contact_type'] ?? []);
 	}
 
 

diff --git a/plugin/Form/FormAddressCreator.php b/plugin/Form/FormAddressCreator.php
@@ -64,7 +64,7 @@ public function __construct(
 	/**
 	 * @param FormData $pFormData
 	 * @param bool $mergeExisting
-	 * @param string $contactType
+	 * @param array $contactType
 	 * @param int|null $estateId
 	 * @return int the new (or updated) address ID
 	 * @throws ApiClientException
@@ -73,7 +73,7 @@ public function __construct(
 	 * @throws NotFoundException
 	 */
 	public function createOrCompleteAddress(
-		FormData $pFormData, bool $mergeExisting = false, string $contactType = '', int $estateId = null): int
+		FormData $pFormData, bool $mergeExisting = false, array $contactType = [], int $estateId = null): int
 	{
 		$requestParams = $this->getAddressDataForApiCall($pFormData);
 		$requestParams['checkDuplicate'] = $mergeExisting;

diff --git a/plugin/Gui/AdminPageFormSettingsBase.php b/plugin/Gui/AdminPageFormSettingsBase.php
@@ -213,6 +213,10 @@ protected function updateValues(array $row, stdClass $pResult, $recordId = null)
 				$result = $result && $pRecordManagerUpdateForm->updateFieldConfigByRow
 					($row[RecordManager::TABLENAME_FIELDCONFIG_FORMS]);
 			}
+
+			if (array_key_exists(RecordManager::TABLENAME_CONTACT_TYPES, $row)) {
+				$result = $result && $pRecordManagerUpdateForm->updateContactTypeByRow($row[RecordManager::TABLENAME_CONTACT_TYPES]);
+			}
 		} else {
 			$action = RecordManagerFactory::ACTION_INSERT;
 			// insert
@@ -225,6 +229,8 @@ protected function updateValues(array $row, stdClass $pResult, $recordId = null)
 				$rowFieldConfig = $this->prepareRelationValues
 					(RecordManager::TABLENAME_FIELDCONFIG_FORMS, 'form_id', $row, $recordId);
 				$row[RecordManager::TABLENAME_FIELDCONFIG_FORMS] = $rowFieldConfig;
+				$row[RecordManager::TABLENAME_CONTACT_TYPES] =
+					$this->prepareRelationValues(RecordManager::TABLENAME_CONTACT_TYPES, 'form_id', $row, $recordId);
 				$pRecordManagerInsertForm->insertAdditionalValues($row);
 				$result = true;
 			} catch (RecordManagerInsertException $pException) {
@@ -700,6 +706,12 @@ public function doExtraEnqueues()
 		wp_localize_script('oo-sanitize-shortcode-name', 'shortcode', ['name' => 'oopluginforms-name']);
 		wp_enqueue_script('oo-sanitize-shortcode-name');
 		wp_enqueue_script('oo-copy-shortcode');
+
+		if ($this->getType() !== Form::TYPE_APPLICANT_SEARCH) {
+			wp_enqueue_script('select2',  plugin_dir_url( ONOFFICE_PLUGIN_DIR . '/index.php' ) . 'vendor/select2/select2/dist/js/select2.min.js');
+			wp_enqueue_style('select2',  plugin_dir_url( ONOFFICE_PLUGIN_DIR . '/index.php' ) . 'vendor/select2/select2/dist/css/select2.min.css');
+			wp_enqueue_script('onoffice-custom-select',  plugins_url('/dist/onoffice-custom-select.min.js', $pluginPath));
+		}
 	}
 
 

diff --git a/plugin/Installer/DatabaseChanges.php b/plugin/Installer/DatabaseChanges.php
@@ -41,7 +41,7 @@
 class DatabaseChanges implements DatabaseChangesInterface
 {
 	/** @var int */
-	const MAX_VERSION = 46;
+	const MAX_VERSION = 47;
 
 	/** @var WPOptionWrapperBase */
 	private $_pWpOption;
@@ -319,6 +319,12 @@ public function install()
 			$dbversion = 46;
 		}
 
+		if ($dbversion == 46) {
+			dbDelta($this->getCreateQueryContactTypes());
+			$this->migrateContactTypes();
+			$dbversion = 47;
+		}
+
 		$this->_pWpOption->updateOption( 'oo_plugin_db_version', $dbversion, true );
 	}
 
@@ -607,6 +613,45 @@ private function getCreateQuerySortByUserValues()
 		return $sql;
 	}
 
+	/**
+	 * @return string
+	 */
+	private function getCreateQueryContactTypes()
+	{
+		$prefix = $this->getPrefix();
+		$charsetCollate = $this->getCharsetCollate();
+		$tableName = $prefix."oo_plugin_contacttypes";
+		$sql =  "CREATE TABLE $tableName (
+			`contacttype_id` bigint(20) NOT NULL AUTO_INCREMENT,
+			`form_id` int(11) NOT NULL,
+			`contact_type` varchar(100) NOT NULL,
+			PRIMARY KEY (`contacttype_id`)
+		) $charsetCollate;";
+
+		return $sql;
+	}
+
+	/**
+	 * @return void
+	 */
+	private function migrateContactTypes()
+	{
+		$prefix = $this->getPrefix();
+		$tableForm = $prefix."oo_plugin_forms";
+		$tableContactTypes = $prefix."oo_plugin_contacttypes";
+		$contactTypes = $this->_pWPDB->get_results("SELECT form_id, contact_type 
+			FROM $tableForm
+			WHERE contact_type IS NOT NULL 
+			AND contact_type != '' ", ARRAY_A);
+
+		if (!empty($contactTypes) && is_array($contactTypes)) {
+			foreach ($contactTypes as $contactType) {
+				$formId = esc_sql((int) $contactType['form_id']);
+				$value = esc_sql($contactType['contact_type']);
+				$this->_pWPDB->insert($tableContactTypes, ['form_id' => $formId, 'contact_type' => $value]);
+			}
+		}
+	}
 
 	/**
 	 *
@@ -907,6 +952,7 @@ public function deinstall()
 			$prefix."oo_plugin_fieldconfig_form_translated_labels",
 			$prefix."oo_plugin_fieldconfig_estate_customs_labels",
 			$prefix."oo_plugin_fieldconfig_estate_translated_labels",
+			$prefix."oo_plugin_contacttypes",
 		);
 
 		foreach ($tables as $table)	{

diff --git a/plugin/Model/FormModelBuilder/FormModelBuilderDBForm.php b/plugin/Model/FormModelBuilder/FormModelBuilderDBForm.php
@@ -412,10 +412,14 @@ public function createInputModelContactType()
         $pInputModelFormContactType = $this->getInputModelDBFactory()->create
         (InputModelDBFactoryConfigForm::INPUT_FORM_CONTACT_TYPE, $labelContactType);
         $field = $pInputModelFormContactType->getField();
-        $pInputModelFormContactType->setHtmlType(InputModelOption::HTML_TYPE_SELECT);
-        $availableContactType = array('' => 'No contact type') + $this->getDataContactType(onOfficeSDK::MODULE_ADDRESS);
+        $pInputModelFormContactType->setHtmlType(InputModelOption::HTML_TYPE_SELECT_TWO);
+        $availableContactType = $this->getDataContactType(onOfficeSDK::MODULE_ADDRESS);
         $pInputModelFormContactType->setValuesAvailable($availableContactType);
+        $pInputModelFormContactType->setIsMulti(true);
         $selectedValue = $this->getValue($field);
+        if (is_null($selectedValue)) {
+            $selectedValue = [];
+        }
         $pInputModelFormContactType->setValue($selectedValue);
 
         return $pInputModelFormContactType;

diff --git a/plugin/Model/InputModel/InputModelDBFactoryConfigForm.php b/plugin/Model/InputModel/InputModelDBFactoryConfigForm.php
@@ -169,7 +169,7 @@ class InputModelDBFactoryConfigForm
 			self::KEY_FIELD => 'show_estate_context',
 		],
 		self::INPUT_FORM_CONTACT_TYPE => [
-			self::KEY_TABLE => 'oo_plugin_forms',
+			self::KEY_TABLE => 'oo_plugin_contacttypes',
 			self::KEY_FIELD => 'contact_type',
 		],
 

diff --git a/plugin/Model/InputModelDBAdapterRow.php b/plugin/Model/InputModelDBAdapterRow.php
@@ -70,6 +70,11 @@ class InputModelDBAdapterRow
 			'sortbyvalue_id' => null,
 			'listview_id' => ['oo_plugin_listviews', 'listview_id'],
 		],
+
+		'oo_plugin_contacttypes' => [
+			'contacttype_id' => null,
+			'form_id' => ['oo_plugin_forms', 'form_id'],
+		],
 	];
 
 

diff --git a/plugin/Record/RecordManager.php b/plugin/Record/RecordManager.php
@@ -77,6 +77,9 @@ abstract class RecordManager
 	/** */
 	const TABLENAME_FIELDCONFIG_ESTATE_TRANSLATED_LABELS = 'oo_plugin_fieldconfig_estate_translated_labels';
 
+	/** */
+	const TABLENAME_CONTACT_TYPES = 'oo_plugin_contacttypes';
+
 	/**
 	 *
 	 * @deprecated get wpdb via DI

diff --git a/plugin/Record/RecordManagerDuplicateListViewForm.php b/plugin/Record/RecordManagerDuplicateListViewForm.php
@@ -163,6 +163,15 @@ public function duplicateByName(string $name)
 							$tableFieldFormTranslatedLabel, 'input_id', 'translated_label_id' );
 					}
 				}
+
+				$contactTypes = $listViewRoot['contact_type'];
+				foreach ($contactTypes as $contactType) {
+					$this->_pWPDB->insert($prefix.'oo_plugin_contacttypes', [
+							'form_id' => esc_sql((int) $duplicateListViewId),
+							'contact_type' => esc_sql($contactType)
+						]
+					);
+				}
 			}
 		}
 	}

diff --git a/plugin/Record/RecordManagerRead.php b/plugin/Record/RecordManagerRead.php
@@ -131,10 +131,31 @@ public function getRowById(int $recordId): array
 				WHERE `".esc_sql($this->getIdColumnMain())."` = ".esc_sql((int)$recordId);
 
 		$result = $pWpDb->get_row($sql, ARRAY_A);
+		if ($result !== null) {
+			$result['contact_type'] = $this->readContactTypesByFormId($recordId);
+		}
 
 		return $result;
 	}
 
+	/**
+	 * @param int $formId
+	 *
+	 * @return array
+	 */
+	public function readContactTypesByFormId(int $formId): array
+	{
+		$prefix = $this->getTablePrefix();
+		$pWpDb = $this->getWpdb();
+		$sql = "SELECT `contact_type`
+			FROM {$prefix}oo_plugin_contacttypes
+			WHERE `form_id` = ".esc_sql($formId);
+
+		$contactTypes = $pWpDb->get_col($sql);
+
+		return is_array($contactTypes) ? $contactTypes : [];
+	}
+
 
 	/** @return int */
 	public function getCountOverall(): int

diff --git a/plugin/Record/RecordManagerReadForm.php b/plugin/Record/RecordManagerReadForm.php
@@ -167,6 +167,8 @@ public function getRowByName($formName)
 		$result['filterable'] = array_keys(array_filter(array_column($resultFieldConfig, 'filterable', 'fieldname')));
 		$result['hidden'] = array_keys(array_filter(array_column($resultFieldConfig, 'hidden', 'fieldname')));
 
+		$result['contact_type'] = $this->readContactTypesByFormId($result['form_id']);
+
 		return $result;
 	}
 

diff --git a/plugin/Record/RecordManagerUpdateForm.php b/plugin/Record/RecordManagerUpdateForm.php
@@ -70,4 +70,27 @@ public function updateFieldConfigByRow(array $fieldConfig): bool
 
 		return $result;
 	}
+
+	/**
+	 * @param array $contactTypes
+	 *
+	 * @return bool
+	 */
+	public function updateContactTypeByRow(array $contactTypes): bool
+	{
+		$prefix = $this->getTablePrefix();
+		$pWpDb = $this->getWpdb();
+		$pWpDb->delete($prefix.self::TABLENAME_CONTACT_TYPES, ['form_id' => $this->getRecordId()]);
+
+		$result = true;
+		foreach ($contactTypes as $row) {
+			if (empty($row)) {
+				continue;
+			}
+
+			$result = $result && $pWpDb->insert($pWpDb->prefix.self::TABLENAME_CONTACT_TYPES, $row);
+		}
+
+		return $result;
+	}
 }
diff --git a/plugin/Record/RecordStructure.php b/plugin/Record/RecordStructure.php
@@ -199,6 +199,12 @@ class RecordStructure
 				self::EMPTY_VALUE => '',
 			),
 		],
+		RecordManager::TABLENAME_CONTACT_TYPES => array(
+			'contact_type' => array(
+				self::NULL_ALLOWED => false,
+				self::EMPTY_VALUE => '',
+			),
+		),
 	);
 
 

diff --git a/plugin/Renderer/InputModelRenderer.php b/plugin/Renderer/InputModelRenderer.php
@@ -336,6 +336,7 @@ private function getHtmlElementName(InputModelBase $pInputModel): string
 			case InputModelOption::HTML_TYPE_BUTTON_FIELD:
 			case InputModelOption::HTML_SEARCH_FIELD_FOR_FIELD_LISTS:
 			case InputModelOption::HTML_TYPE_TOGGLE_SWITCH:
+			case InputModelOption::HTML_TYPE_SELECT_TWO:
 				if ($pInputModel->getIsMulti()) {
 					$name .= '[]';
 				}

diff --git a/tests/TestClassDataFormConfigurationFactory.php b/tests/TestClassDataFormConfigurationFactory.php
@@ -447,7 +447,7 @@ private function getBaseRow(int $formId, string $formType): array
 			'newsletter' => '1',
 			'availableOptions' => '1',
 			'show_estate_context' => '0',
-			'contact_type' => '',
+			'contact_type' => ['Owner', 'Investor'],
             'default_recipient' => 'default@my-onoffice.com'
 		];
 	}
-Original file line number
+Diff line change
@@ Expand Up / @@ -77,6 +77,9 @@ abstract class RecordManager @@
     	/** */
     	const TABLENAME_FIELDCONFIG_ESTATE_TRANSLATED_LABELS = 'oo_plugin_fieldconfig_estate_translated_labels';
+    	/** */
+    	const TABLENAME_CONTACT_TYPES = 'oo_plugin_contacttypes';
     	/**
     	 *
     	 * @deprecated get wpdb via DI
@@ Expand Down @@