P#50179 Show or hide reference estate in estate lis

js/onoffice-reference-estate-select.js

@@ -0,0 +1,15 @@
+jQuery(document).ready(function() {
+    const valueSelect = 'reference';
+    const mainElement = document.querySelector('select[name=oopluginlistviews-listtype');
+    const Element = document.querySelector('input[name=oopluginlistviews-showreferenceestate');
+    mainElement.addEventListener('change',function(event){
+       let val = event.target.value;
+       if (val === valueSelect) {
+            Element.setAttribute('disabled', 'disabled');
+            Element.checked = true;
+       } else {
+            Element.removeAttribute('disabled');
+            Element.checked = false;
+       }
+    });
+});

plugin/DataView/DataListView.php

@@ -127,6 +127,9 @@ class DataListView
 	/** @var bool */
 	private $_adjustableSorting = false;
 
+		/** @var bool */
+	private $_showReferenceStatus = false;
+
 
 	/**
 	 *
@@ -333,4 +336,20 @@ public function isAdjustableSorting(): bool
 	{
 		return $this->_adjustableSorting;
 	}
+
+	/**
+	 * @return bool
+	 */
+	public function getShowReferenceStatus(): bool
+	{
+		return $this->_showReferenceStatus;
+	}
+
+	/**
+	 * @param bool $showReferenceStatus
+	 */
+	public function setShowReferenceStatus(bool $showReferenceStatus)
+	{
+		$this->_showReferenceStatus = $showReferenceStatus;
+	}
 }

plugin/DataView/DataListViewFactory.php

@@ -75,6 +75,7 @@ public function createListViewByRow(array $row): DataViewFilterableFields
 		$pListView->setSortByUserDefinedDefault($row['sortByUserDefinedDefault']);
 		$pListView->setSortByUserDefinedDirection((int) $row['sortByUserDefinedDirection']);
 		$pListView->setSortByUserValues($row[DataListView::SORT_BY_USER_VALUES]);
+		$pListView->setShowReferenceStatus($row['show_reference_estate'] ?? 1);
 
 		$geoFieldsAll = [
 			InputModelDBFactoryConfigGeoFields::FIELDNAME_COUNTRY_ACTIVE => GeoPosition::ESTATE_LIST_SEARCH_COUNTRY,

plugin/EstateList.php

@@ -268,6 +268,10 @@ private function getEstateParameters(int $currentPage, bool $formatOutput)
 			];
 		}
 
+		if (!$this->getShowReferenceStatus()) {
+			$requestParams['filter']['referenz'][] = ['op' => '=', 'val' => 0];
+		}
+
 		$requestParams += $this->addExtraParams();
 
 		return $requestParams;
@@ -664,6 +668,15 @@ public function getShowEstateMarketingStatus(): bool
 			$this->_pDataView->getShowStatus();
 	}
 
+	/**
+	 * @return bool
+	 */
+	public function getShowReferenceStatus(): bool
+	{
+		return $this->_pDataView instanceof DataListView &&
+			$this->_pDataView->getShowReferenceStatus();
+	}
+
 	/**
 	 * @return array
 	 */

plugin/Gui/AdminPageEstateListSettings.php

@@ -93,6 +93,7 @@ protected function buildForms()
 		$pInputModelSortOrder = $pFormModelBuilder->createInputModelSortOrder();
 		$pInputModelListType = $pFormModelBuilder->createInputModelListType();
 		$pInputModelShowStatus = $pFormModelBuilder->createInputModelShowStatus();
+		$pInputModelShowReferenceEstate = $pFormModelBuilder->createInputModelShowReferenceEstate();
 		$pInputModelRandomSort = $pFormModelBuilder->createInputModelRandomSort();
 
 		$pInputModelSortBySetting = $pFormModelBuilder->createInputModelSortBySetting();
@@ -115,6 +116,8 @@ protected function buildForms()
 		$pFormModelRecordsFilter->addInputModel($pInputModelRandomSort);
 
 		$pFormModelRecordsFilter->addInputModel($pInputModelListType);
+		$pFormModelRecordsFilter->addInputModel($pInputModelShowStatus);
+		$pFormModelRecordsFilter->addInputModel($pInputModelShowReferenceEstate);
 		$this->addFormModel($pFormModelRecordsFilter);
 
 		$pInputModelTemplate = $pFormModelBuilder->createInputModelTemplate('estate');
@@ -262,6 +265,7 @@ public function doExtraEnqueues()
 	{
 		parent::doExtraEnqueues();
 		wp_enqueue_script('oo-checkbox-js');
+		wp_enqueue_script('oo-reference-estate-js');
 		wp_localize_script('oo-sanitize-shortcode-name', 'shortcode', ['name' => 'oopluginlistviews-name']);
 		wp_enqueue_script('oo-sanitize-shortcode-name');
 	}

plugin/Gui/AdminPageSettingsBase.php

@@ -439,6 +439,9 @@ public function doExtraEnqueues()
 		wp_register_script('admin-js', plugin_dir_url(ONOFFICE_PLUGIN_DIR.'/index.php').'/js/admin.js',
 			['jquery'], '', true);
 
+		wp_register_script('oo-reference-estate-js',
+			plugin_dir_url(ONOFFICE_PLUGIN_DIR.'/index.php').'/js/onoffice-reference-estate-select.js', ['jquery'], '', true);
+
 		wp_register_script('oo-checkbox-js',
 			plugin_dir_url(ONOFFICE_PLUGIN_DIR.'/index.php').'/js/checkbox.js', ['jquery'], '', true);
 		wp_register_script('onoffice-default-form-values-js',

plugin/Installer/DatabaseChanges.php

@@ -34,7 +34,7 @@
 class DatabaseChanges implements DatabaseChangesInterface
 {
 	/** @var int */
-	const MAX_VERSION = 21;
+	const MAX_VERSION = 22;
 
 	/** @var WPOptionWrapperBase */
 	private $_pWpOption;
@@ -132,7 +132,7 @@ public function install()
 			$this->updateSortByUserDefinedDefault();
 			$dbversion = 15;
 		}
-		
+
 		if ($dbversion == 15) {
 			dbDelta( $this->getCreateQueryFieldConfigDefaults() );
 			dbDelta( $this->getCreateQueryFieldConfigDefaultsValues() );
@@ -164,6 +164,11 @@ public function install()
 			$dbversion = 21;
 		}
 
+		if ($dbversion == 21) {
+			dbDelta($this->getCreateQueryListviews());
+			$dbversion = 22;
+		}
+
 		$this->_pWpOption->updateOption( 'oo_plugin_db_version', $dbversion, true);
 	}
 
@@ -234,6 +239,7 @@ private function getCreateQueryListviews()
 			`sortBySetting` ENUM('0','1') NOT NULL DEFAULT '0' COMMENT 'Sortierung nach Benutzerwahl: 0 means preselected, 1 means userDefined',
 			`sortByUserDefinedDefault` VARCHAR(200) NOT NULL COMMENT 'Standardsortierung',
 			`sortByUserDefinedDirection` ENUM('0','1') NOT NULL DEFAULT '0' COMMENT 'Formulierung der Sortierrichtung: 0 means highestFirst/lowestFirt, 1 means descending/ascending',
+			`show_reference_estate` tinyint(1) NOT NULL DEFAULT '0',
 			PRIMARY KEY (`listview_id`),
 			UNIQUE KEY `name` (`name`)
 		) $charsetCollate;";
@@ -296,19 +302,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);
 	}
@@ -788,4 +803,4 @@ protected function readTemplatePaths($directory, $pattern = '*')
 
 		return $templates;
 	}
-}
+}

plugin/Model/FormModelBuilder/FormModelBuilderDBEstateListSettings.php

@@ -326,6 +326,25 @@ public function createInputModelShowStatus()
 		return $pInputModelShowStatus;
 	}
 
+	/**
+	 *
+	 * @return InputModelDB
+	 *
+	 */
+
+	public function createInputModelShowReferenceEstate()
+	{
+		$labelShowReferenceEstate = __('Show reference estates', 'onoffice-for-wp-websites');
+
+		$pInputModelShowStatus = $this->getInputModelDBFactory()->create
+		(InputModelDBFactory::INPUT_SHOW_REFERENCE_ESTATE, $labelShowReferenceEstate);
+		$pInputModelShowStatus->setHtmlType(InputModelOption::HTML_TYPE_CHECKBOX);
+		$pInputModelShowStatus->setValue($this->getValue('show_reference_estate') ?? 1);
+		$pInputModelShowStatus->setValuesAvailable(1);
+
+		return $pInputModelShowStatus;
+	}
+
 
 	/**
 	 *

plugin/Model/InputModel/InputModelDBFactory.php

@@ -60,6 +60,9 @@ class InputModelDBFactory
 	/** */
 	const INPUT_SHOW_STATUS = 'showStatus';
 
+	/** */
+	const INPUT_SHOW_REFERENCE_ESTATE = 'showReferenceEstate';
+
 	/** */
 	const INPUT_RANDOM_ORDER = 'randomOrder';
 

plugin/Model/InputModel/InputModelDBFactoryConfigEstate.php

@@ -70,6 +70,10 @@ class InputModelDBFactoryConfigEstate
 			self::KEY_TABLE => 'oo_plugin_listviews',
 			self::KEY_FIELD => 'show_status',
 		],
+		InputModelDBFactory::INPUT_SHOW_REFERENCE_ESTATE => [
+			self::KEY_TABLE => 'oo_plugin_listviews',
+			self::KEY_FIELD => 'show_reference_estate',
+		],
 		InputModelDBFactory::INPUT_EXPOSE => [
 			self::KEY_TABLE => 'oo_plugin_listviews',
 			self::KEY_FIELD => 'expose',

tests/TestClassDataListView.php

@@ -297,4 +297,16 @@ public function testAdjustableSorting()
 		$this->_pSubject->setAdjustableSorting(true);
 		$this->assertTrue($this->_pSubject->isAdjustableSorting());
 	}
+
+
+	/**
+	 *
+	 */
+
+	public function testShowReferenceStatus()
+	{
+		$this->assertFalse($this->_pSubject->getShowReferenceStatus());
+		$this->_pSubject->setShowReferenceStatus(true);
+		$this->assertTrue($this->_pSubject->getShowReferenceStatus());
+	}
 }

tests/TestClassDataListViewFactory.php

@@ -61,6 +61,7 @@ class TestClassDataListViewFactory
 		'sortByUserDefinedDirection' => 1,
 		'sortbyuservalues' => ['kaufpreis,anzahl_zimmer'],
 		'radius' => '200',
+		'show_reference_estate' => 1
 	];
 
 	/**
@@ -104,6 +105,7 @@ public function testCreateListViewByRow()
 		$this->assertEquals($this->_baseRow['sortByUserDefinedDefault'], $pDataListView->getSortByUserDefinedDefault());
 		$this->assertEquals($this->_baseRow['sortByUserDefinedDirection'], $pDataListView->getSortByUserDefinedDirection());
 		$this->assertEquals($this->_baseRow['sortbyuservalues'], $pDataListView->getSortByUserValues());
+		$this->assertEquals($this->_baseRow['show_reference_estate'], $pDataListView->getShowReferenceStatus());
 		$pDataListView->getFilterableFields();
 	}
 }

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(21, $dbversion);
+		$this->assertEquals(22, $dbversion);
 		return $this->_createQueries;
 	}
 
@@ -191,7 +191,7 @@ public function testDeleteCommentFieldApplicantSearchForm()
 	 */
 	public function testMaxVersion()
 	{
-		$this->assertEquals(21, DatabaseChanges::MAX_VERSION);
+		$this->assertEquals(22, DatabaseChanges::MAX_VERSION);
 	}
 
 

tests/TestClassEstateList.php

@@ -662,6 +662,21 @@ public function testGeoSearchBuilder()
 		$this->assertInstanceOf(GeoSearchBuilderFromInputVars::class, $this->_pEstateList->getGeoSearchBuilder());
 	}
 
+	/**
+	 *
+	 */
+	public function testShowReferenceStatus()
+	{
+		$EstateListMock = $this->getMockBuilder(EstateList::class)
+			->disableOriginalConstructor()
+			->setMethods(['getShowReferenceStatus'])
+			->getMock();
+		$EstateListMock->method('getShowReferenceStatus')->willReturn(false);
+		$this->_pEstateList->loadEstates();
+		$result = $this->_pEstateList->estateIterator();
+		$this->assertEquals('', $result['vermarktungsstatus']);
+	}
+
 
 	/**
 	 *
@@ -771,6 +786,7 @@ private function getDataView(): DataListView
 		$pDataView->setPictureTypes(['Titelbild', 'Foto']);
 		$pDataView->setAddressFields(['Vorname', 'Name']);
 		$pDataView->setShowStatus(true);
+		$pDataView->setShowReferenceStatus(false);
 		$pDataView->setFilterableFields([GeoPosition::FIELD_GEO_POSITION]);
 		$pDataView->setExpose('testExpose');
 		return $pDataView;

tests/TestClassFormModelBuilderDBEstateListSettings.php

@@ -196,4 +196,23 @@ public function testCreateSortableFieldList()
         $instance = $pInstance->createSortableFieldList('address', 'checkbox', false);
         $this->assertEquals($instance->getReferencedInputModels(), null);
     }
-}
+
+	/**
+	 * @covers onOffice\WPlugin\Model\FormModelBuilder\FormModelBuilderDBEstateListSettings::createInputModelShowReferenceEstate
+	 */
+	public function testCreateInputModelShowReferenceEstate()
+	{
+		$pInstance = $this->getMockBuilder(FormModelBuilderDBEstateListSettings::class)
+			->disableOriginalConstructor()
+			->setMethods(['getInputModelDBFactory', 'getValue', 'getOnlyDefaultSortByFields'])
+			->getMock();
+
+		$pInstance->method('getInputModelDBFactory')->willReturn($this->_pInputModelFactoryDBEntry);
+		$pInstance->method('getValue')->willReturn('0');
+
+		$pInputModelDB = $pInstance->createInputModelShowReferenceEstate();
+		$this->assertInstanceOf(InputModelDB::class, $pInputModelDB);
+		$this->assertEquals($pInputModelDB->getValue(), '0');
+		$this->assertEquals('checkbox', $pInputModelDB->getHtmlType());
+	}
+}

tests/resources/ApiResponseReadEstatesPublishedENG.json

@@ -30,6 +30,12 @@
 					"op": "=",
 					"val": 1
 				}
+			],
+			"referenz": [
+				{
+					"op": "=",
+					"val": 0
+				}
 			]
 		},
 		"estatelanguage": "ENG",
@@ -214,4 +220,4 @@
 			"message": "OK"
 		}
 	}
-}
+}

tests/resources/ApiResponseReadEstatesPublishedENGRaw.json

@@ -18,6 +18,12 @@
 					"op": "=",
 					"val": 1
 				}
+			],
+			"referenz": [
+				{
+					"op": "=",
+					"val": 0
+				}
 			]
 		},
 		"estatelanguage": "ENG",
@@ -228,4 +234,4 @@
 			"message": "OK"
 		}
 	}
-}
+}