P#48327(Task) Make contact selectable

languages/onoffice-for-wp-websites-de_DE.po

@@ -815,6 +815,10 @@ msgstr "Maximale Ergebnisanzahl"
 msgid "Required"
 msgstr "Pflichtangabe"
 
+#: plugin/Model/FormModelBuilder/FormModelBuilderDBForm.php:345
+msgid "Contact Type of New Address"
+msgstr "Kontaktart der neuen Adresse"
+
 #: plugin/Model/FormModelBuilder/FormModelBuilderDBForm.php:390
 #: plugin/Model/FormModelBuilder/FormModelBuilderDBForm.php:404
 msgid "Add language"

plugin/DataFormConfiguration/DataFormConfiguration.php

@@ -67,6 +67,9 @@ class DataFormConfiguration
 	/** @var bool */
 	private $_showEstateContext = false;
 
+	/** @var bool */
+	private $_contactType = '';
+
 	/**
 	 *
 	 * Override to set default fields for new, empty forms
@@ -128,7 +131,9 @@ public function addAvailableOptionsField(string $availableOptionsField)
 	public function setShowEstateContext(bool $showEstateContext)
 		{ $this->_showEstateContext = $showEstateContext; }
 
-
+	/** @param string $contactTypeField */
+	public function setContactTypeField(string $contactTypeField)
+		{ $this->_contactType = $contactTypeField; }
 	/**
 	 *
 	 * @param string $input
@@ -182,4 +187,8 @@ public function setId(int $id)
 	/** @return bool */
 	public function getShowEstateContext(): bool
 		{ return $this->_showEstateContext; }
+
+	/** @return string */
+	public function getContactType(): string
+		{ return $this->_contactType; }
 }

plugin/DataFormConfiguration/DataFormConfigurationFactory.php

@@ -269,6 +269,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'] ?? '');
 	}
 
 
@@ -319,6 +320,7 @@ private function configureOwner(array $row, DataFormConfigurationOwner $pConfig)
 		$pConfig->setSubject($row['subject']);
 		$pConfig->setPages($row['pages']);
 		$pConfig->setCheckDuplicateOnCreateAddress((bool)$row['checkduplicates']);
+		$pConfig->setContactTypeField($row['contact_type'] ?? '');
 	}
 
 
@@ -334,6 +336,7 @@ private function configureInterest(array $row, DataFormConfigurationInterest $pC
 		$pConfig->setRecipient($row['recipient']);
 		$pConfig->setSubject($row['subject']);
 		$pConfig->setCheckDuplicateOnCreateAddress($row['checkduplicates']);
+		$pConfig->setContactTypeField($row['contact_type'] ?? '');
 	}
 
 

plugin/Form/FormAddressCreator.php

@@ -68,10 +68,13 @@ public function __construct(
 	 * @throws NotFoundException
 	 */
 	public function createOrCompleteAddress(
-		FormData $pFormData, bool $mergeExisting = false): int
+		FormData $pFormData, bool $mergeExisting = false, string $contactType = ''): int
 	{
 		$requestParams = $this->getAddressDataForApiCall($pFormData);
 		$requestParams['checkDuplicate'] = $mergeExisting;
+		if (!empty($contactType)) {
+			$requestParams['ArtDaten'] = $contactType;
+		}
 
 		$pApiClientAction = new APIClientActionGeneric
 			($this->_pSDKWrapper, onOfficeSDK::ACTION_ID_CREATE, 'address');

plugin/FormPostContact.php

@@ -134,8 +134,9 @@ private function createAddress(FormData $pFormData)
 	{
 		$pFormConfig = $pFormData->getDataFormConfiguration();
 		$checkDuplicate = $pFormConfig->getCheckDuplicateOnCreateAddress();
+		$contactType = $pFormConfig->getContactType();
 		$addressId = $this->_pFormPostContactConfiguration->getFormAddressCreator()
-			->createOrCompleteAddress($pFormData, $checkDuplicate);
+			->createOrCompleteAddress($pFormData, $checkDuplicate, $contactType);
 
 		if (!$this->_pFormPostContactConfiguration->getNewsletterAccepted()) {
 			// No subscription for newsletter, which is ok

plugin/FormPostInterest.php

@@ -80,9 +80,9 @@ protected function analyseFormContentByPrefix(FormData $pFormData)
 		$recipient = $pFormConfiguration->getRecipient();
 		$subject = $pFormConfiguration->getSubject();
 		$checkduplicate = $pFormConfiguration->getCheckDuplicateOnCreateAddress();
-
+		$contactType = $pFormConfiguration->getContactType();
 		$addressId = $this->_pFormPostInterestConfiguration->getFormAddressCreator()
-			->createOrCompleteAddress($pFormData, $checkduplicate);
+			->createOrCompleteAddress($pFormData, $checkduplicate, $contactType);
 		$this->createSearchcriteria($pFormData, $addressId);
 
 		if ($recipient != null) {

plugin/FormPostOwner.php

@@ -88,9 +88,10 @@ protected function analyseFormContentByPrefix(FormData $pFormData)
 		$recipient = $pDataFormConfiguration->getRecipient();
 		$subject = $pDataFormConfiguration->getSubject();
 		$checkduplicate = $pDataFormConfiguration->getCheckDuplicateOnCreateAddress();
+		$contactType = $pDataFormConfiguration->getContactType();
 
 		$addressId = $this->_pFormPostOwnerConfiguration->getFormAddressCreator()
-			->createOrCompleteAddress($pFormData, $checkduplicate);
+			->createOrCompleteAddress($pFormData, $checkduplicate, $contactType);
 		$estateData = $this->getEstateData();
 		$estateId = $this->createEstate($estateData);
 		$this->createOwnerRelation($estateId, $addressId);

plugin/Gui/AdminPageFormSettingsContact.php

@@ -68,6 +68,9 @@ class AdminPageFormSettingsContact
 	/** @var bool */
 	private $_showEstateContextCheckbox = false;
 
+    /** @var bool */
+    private $_showContactTypeSelect = false;
+
 
 	/**
 	 *
@@ -112,6 +115,11 @@ protected function buildForms()
 			$pFormModelFormSpecific->addInputModel($pInputModel);
 		}
 
+		if ($this->_showContactTypeSelect) {
+			$pInputModelContactType = $pFormModelBuilder->createInputModelContactType();
+			$pFormModelFormSpecific->addInputModel($pInputModelContactType);
+		}
+
 		if ($this->_showNewsletterCheckbox) {
 			$pInputModel = $pInputModelBuilder->build(InputModelDBFactoryConfigForm::INPUT_FORM_NEWSLETTER);
 			$pFormModelFormSpecific->addInputModel($pInputModel);
@@ -238,4 +246,8 @@ public function setShowGeoPositionSettings(bool $showGeoPositionSettings)
 	/** @param bool $showEstateContextCheckbox */
 	public function setShowEstateContextCheckbox(bool $showEstateContextCheckbox)
 		{ $this->_showEstateContextCheckbox = $showEstateContextCheckbox; }
+
+    /** @param bool $showContactTypeSelect */
+    public function setShowContactTypeSelect(bool $showContactTypeSelect)
+		{ $this->_showContactTypeSelect = $showContactTypeSelect; }
 }

plugin/Gui/AdminPageFormSettingsMain.php

@@ -120,13 +120,15 @@ private function configureAdminPage(AdminPageFormSettingsBase $pAdminPage, strin
 				$pAdminPage->setShowAddressFields(true);
 				$pAdminPage->setShowCheckDuplicates(true); // address will be created anyway
 				$pAdminPage->setShowGeoPositionSettings(true);
+				$pAdminPage->setShowContactTypeSelect(true);
 				break;
 			case Form::TYPE_OWNER:
 				/* @var $pAdminPage AdminPageFormSettingsInquiry */
 				$pAdminPage->setShowEstateFields(true);
 				$pAdminPage->setShowAddressFields(true);
 				$pAdminPage->setShowCheckDuplicates(true); // address will be created anyway
 				$pAdminPage->setShowMessageInput(true);
+				$pAdminPage->setShowContactTypeSelect(true);
 				break;
 			case Form::TYPE_CONTACT:
 				/* @var $pAdminPage AdminPageFormSettingsContact */
@@ -136,6 +138,7 @@ private function configureAdminPage(AdminPageFormSettingsBase $pAdminPage, strin
 				$pAdminPage->setShowMessageInput(true);
 				$pAdminPage->setShowNewsletterCheckbox(true);
 				$pAdminPage->setShowEstateContextCheckbox(true);
+				$pAdminPage->setShowContactTypeSelect(true);
 				break;
 			case Form::TYPE_APPLICANT_SEARCH:
 				/* @var $pAdminPage AdminPageFormSettingsApplicantSearch */

plugin/Installer/DatabaseChanges.php

@@ -34,7 +34,7 @@
 class DatabaseChanges implements DatabaseChangesInterface
 {
 	/** @var int */
-	const MAX_VERSION = 20;
+	const MAX_VERSION = 21;
 
 	/** @var WPOptionWrapperBase */
 	private $_pWpOption;
@@ -132,7 +132,7 @@ public function install()
 			$this->updateSortByUserDefinedDefault();
 			$dbversion = 15;
 		}
-		
+
 		if ($dbversion == 15) {
 			dbDelta( $this->getCreateQueryFieldConfigDefaults() );
 			dbDelta( $this->getCreateQueryFieldConfigDefaultsValues() );
@@ -159,6 +159,11 @@ public function install()
 			$dbversion = 20;
 		}
 
+		if ($dbversion == 20) {
+			dbDelta($this->getQueryAddColumnContactTypePluginFormTable());
+			$dbversion = 21;
+		}
+
 		$this->_pWpOption->updateOption( 'oo_plugin_db_version', $dbversion, true);
 	}
 
@@ -291,19 +296,28 @@ private function installDataQueryForms()
 				$template = $templatePathsForm;
 			}
 		}
-		$this->_pWPDB->insert(
-			$tableName,
-			array(
-				'name' => 'Default Form',
-				'form_type' => 'contact',
-				'template' => $template,
-				'country_active' => 1,
-				'zip_active' => 1,
-				'street_active' => 1,
-				'radius_active' => 1,
-				'geo_order' => 'street,zip,city,country,radius'
-			)
+		$data = array(
+			'name' => 'Default Form',
+			'form_type' => 'contact',
+			'template' => $template,
+			'country_active' => 1,
+			'zip_active' => 1,
+			'street_active' => 1,
+			'radius_active' => 1,
+			'geo_order' => 'street,zip,city,country,radius'
 		);
+		$query = "INSERT IGNORE $tableName (name, form_type, template, country_active, zip_active, street_active, radius_active, geo_order)";
+		$query .= "VALUES (";
+		$query .= "'" . esc_sql($data['name']) ."',";
+		$query .= "'" . esc_sql($data['form_type']) ."',";
+		$query .= "'" . esc_sql($data['template']) ."',";
+		$query .= esc_sql($data['country_active']) . ",";
+		$query .= esc_sql($data['zip_active']) . ",";
+		$query .= esc_sql($data['street_active']) . ",";
+		$query .= esc_sql($data['radius_active']) . ",";
+		$query .= "'" . esc_sql($data['geo_order']) ."')";
+		$this->_pWPDB->query($query);
+
 		$defaultFormId = $this->_pWPDB->insert_id;
 		$this->installDataQueryFormFieldConfig($defaultFormId);
 	}
@@ -684,6 +698,17 @@ private function deleteCommentFieldApplicantSearchForm()
 		}
 	}
 
+	public function getQueryAddColumnContactTypePluginFormTable() :string
+	{
+		$prefix = $this->getPrefix();
+		$charsetCollate = $this->getCharsetCollate();
+		$tableName = $prefix . "oo_plugin_forms";
+
+		return "CREATE TABLE $tableName (
+			`contact_type` varchar(255) NULL DEFAULT NULL
+		) $charsetCollate;";
+	}
+
 
 	/**
 	 *

plugin/Model/FormModelBuilder/FormModelBuilderDBForm.php

@@ -26,8 +26,12 @@
 use DI\DependencyException;
 use DI\NotFoundException;
 use Exception;
+use onOffice\SDK\onOfficeSDK;
+use onOffice\WPlugin\API\APIClientCredentialsException;
 use onOffice\WPlugin\DataFormConfiguration\DataFormConfiguration;
 use onOffice\WPlugin\DataFormConfiguration\DataFormConfigurationFactory;
+use onOffice\WPlugin\Field\Collection\FieldLoaderGeneric;
+use onOffice\WPlugin\Field\Collection\FieldsCollectionBuilder;
 use onOffice\WPlugin\Field\Collection\FieldsCollectionBuilderShort;
 use onOffice\WPlugin\Model\FormModel;
 use onOffice\WPlugin\Model\InputModel\InputModelDBFactory;
@@ -334,6 +338,45 @@ public function createInputModelResultLimit()
 		return $pInputModelFormLimitResult;
 	}
 
+    /**
+     * @return InputModelDB
+     */
+    public function createInputModelContactType()
+    {
+        $labelContactType = __('Contact Type of New Address', 'onoffice-for-wp-websites');
+        $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->setValuesAvailable($availableContactType);
+        $selectedValue = $this->getValue($field);
+        $pInputModelFormContactType->setValue($selectedValue);
+
+        return $pInputModelFormContactType;
+    }
+
+    public function getDataContactType($module)
+    {
+        try {
+            $pFieldLoader = $this->_pContainer->get(FieldLoaderGeneric::class);
+            $pFieldCollectionAddressEstate = $this->_pContainer->get(FieldsCollectionBuilder::class)
+                ->buildFieldsCollection($pFieldLoader);
+            $fields = $pFieldCollectionAddressEstate->getFieldsByModule($module);
+            $result = [];
+            if (!empty($fields['ArtDaten']->getPermittedvalues())) {
+                foreach ($fields['ArtDaten']->getPermittedvalues() as $field => $type) {
+                    $result[$field] = !empty($type) ? $type: $field;
+                }
+            }
+
+            return $result;
+        } catch (APIClientCredentialsException $pCredentialsException) {
+            return [];
+        }
+
+    }
+
 	/**
 	 * @return InputModelDB
 	 */

plugin/Model/InputModel/InputModelDBFactoryConfigForm.php

@@ -80,6 +80,9 @@ class InputModelDBFactoryConfigForm
 	/** */
 	const INPUT_FORM_ESTATE_CONTEXT_AS_HEADING = 'show_estate_context';
 
+    /** */
+    const INPUT_FORM_CONTACT_TYPE = 'contactType';
+
 
 	/** @var array */
 	private $_inputConfig = [
@@ -131,6 +134,10 @@ class InputModelDBFactoryConfigForm
 			self::KEY_TABLE => 'oo_plugin_forms',
 			self::KEY_FIELD => 'show_estate_context',
 		],
+		self::INPUT_FORM_CONTACT_TYPE => [
+			self::KEY_TABLE => 'oo_plugin_forms',
+			self::KEY_FIELD => 'contact_type',
+		],
 
 		InputModelDBFactory::INPUT_FIELD_CONFIG => [
 			self::KEY_TABLE => 'oo_plugin_form_fieldconfig',

tests/TestClassDataFormConfigurationFactory.php

@@ -362,6 +362,7 @@ private function getBasicFieldsArray(int $formId, string $formType): array
 				'individual_fieldname' => '0',
 				'availableOptions' => '0',
 				'required' => '1',
+				'contact_type' => '',
 			],
 			[
 				'form_fieldconfig_id' => '2',
@@ -373,6 +374,7 @@ private function getBasicFieldsArray(int $formId, string $formType): array
 				'individual_fieldname' => '0',
 				'availableOptions' => '0',
 				'required' => '1',
+				'contact_type' => '',
 			],
 			[
 				'form_fieldconfig_id' => '3',
@@ -384,6 +386,7 @@ private function getBasicFieldsArray(int $formId, string $formType): array
 				'individual_fieldname' => '0',
 				'availableOptions' => '1',
 				'required' => '0',
+				'contact_type' => '',
 			],
 		];
 
@@ -436,6 +439,7 @@ private function getBaseRow(int $formId, string $formType): array
 			'newsletter' => '1',
 			'availableOptions' => '1',
 			'show_estate_context' => '0',
+			'contact_type' => '',
 		];
 	}
 }

tests/TestClassDatabaseChanges.php

@@ -111,7 +111,7 @@ public function testInstall(): array
 		$this->assertGreaterThanOrEqual(self::NUM_NEW_TABLES, count($this->_createQueries));
 
 		$dbversion = $this->_pDbChanges->getDbVersion();
-		$this->assertEquals(20, $dbversion);
+		$this->assertEquals(21, $dbversion);
 		return $this->_createQueries;
 	}
 
@@ -191,7 +191,7 @@ public function testDeleteCommentFieldApplicantSearchForm()
 	 */
 	public function testMaxVersion()
 	{
-		$this->assertEquals(20, DatabaseChanges::MAX_VERSION);
+		$this->assertEquals(21, DatabaseChanges::MAX_VERSION);
 	}
 
 

tests/TestClassFormAddressCreator.php

@@ -208,7 +208,7 @@ private function addCreateAddressResponseToSKDWrapper(array $response)
 		$this->_pSDKWrapper->addResponseByParameters(onOfficeSDK::ACTION_ID_CREATE, 'address', '', [
 			'testaddressfield1varchar' => 'testValue',
 			'testaddressfield1multiselect' => ['hut','tut'],
-			'checkDuplicate' => false
+			'checkDuplicate' => false,
 		], null, $response);
 	}
 }