EstateDetail
extends EstateList
in package
Tags
Table of Contents
- $_currentEstate : array<string|int, mixed>
- $_currentEstatePage : int
- $_estateContacts : array<string|int, mixed>
- $_estateId : int
- $_formatOutput : bool
- $_numEstatePages : int
- $_pApiClientAction : APIClientActionGeneric
- $_pDataView : DataView
- $_pEnvironment : EstateListEnvironment
- $_pEstateFiles : EstateFiles
- $_pGeoSearchBuilder : GeoSearchBuilder
- $_pLanguageSwitcher : EstateDetailUrl
- $_pWPOptionWrapper : mixed
- $_records : array<string|int, mixed>
- $_recordsRaw : array<string|int, mixed>
- $_redirectIfOldUrl : Redirector
- $_unitsViewName : string
- __construct() : mixed
- custom_pre_get_document_title() : mixed
- estateIterator() : ArrayContainerEscape
- getAddressFields() : array<string|int, mixed>
- getCurrentEstateId() : int
- getCurrentMultiLangEstateMainId() : int
- getDataView() : DataView
- getDefaultFilterBuilder() : DefaultFilterBuilder
- getDocument() : string
- getEnvironment() : EstateListEnvironment
- getEstateContactIds() : array<string|int, mixed>
- getEstateContacts() : array<string|int, mixed>
- getEstateId() : int
- getEstateIds() : array<string|int, mixed>
- getEstateLink() : string
- getEstateLinks() : array<string|int, mixed>
- getEstateMovieLinks() : array<string|int, mixed>
- Not supported in list view
- getEstateOverallCount() : int
- getEstatePictures() : array<string|int, mixed>
- getEstatePictureText() : string
- getEstatePictureTitle() : string
- getEstatePictureUrl() : string
- getEstatePictureValues() : array<string|int, mixed>
- getEstateUnits() : string
- getFieldLabel() : string
- getFormatOutput() : bool
- getGeoSearchBuilder() : GeoSearchBuilder
- getLinkEmbedPlayers() : mixed
- getMovieEmbedPlayers() : array<string|int, mixed>
- Not supported in list view
- getRawValues() : ArrayContainerEscape
- getShortCodeForm() : string
- getShowEstateMarketingStatus() : bool
- getShowReferenceEstate() : bool
- getShowReferenceStatus() : bool
- getSimilarEstates() : string
- getUnitsViewName() : string
- getViewRestrict() : bool
- getVisibleFilterableFields() : array<string|int, string>
- hasDetailView() : bool
- loadEstates() : mixed
- performs the request
- loadSingleEstate() : mixed
- resetEstateIterator() : mixed
- resets internal iterator handle
- setDefaultFilterBuilder() : mixed
- setEstateId() : mixed
- setFormatOutput() : mixed
- setGeoSearchBuilder() : mixed
- setUnitsViewName() : mixed
- addExtraParams() : array<string|int, mixed>
- getEstateFiles() : EstateFiles
- getNumEstatePages() : int
- getPreloadEstateFileCategories() : array<string|int, mixed>
- getRecordsPerPage() : int
- collectEstateContactPerson() : mixed
- getEstateContactPerson() : mixed
- getEstateIdToForeignMapping() : array<string|int, mixed>
- getEstateParameters() : array<string|int, mixed>
- loadRecords() : mixed
Properties
$_currentEstate
private
array<string|int, mixed>
$_currentEstate
= []
$_currentEstatePage
private
int
$_currentEstatePage
= 1
$_estateContacts
private
array<string|int, mixed>
$_estateContacts
= []
$_estateId
private
int
$_estateId
= null
$_formatOutput
private
bool
$_formatOutput
= true
$_numEstatePages
private
int
$_numEstatePages
= null
$_pApiClientAction
private
APIClientActionGeneric
$_pApiClientAction
= null
$_pDataView
private
DataView
$_pDataView
= null
$_pEnvironment
private
EstateListEnvironment
$_pEnvironment
= null
$_pEstateFiles
private
EstateFiles
$_pEstateFiles
= null
$_pGeoSearchBuilder
private
GeoSearchBuilder
$_pGeoSearchBuilder
= null
$_pLanguageSwitcher
private
EstateDetailUrl
$_pLanguageSwitcher
$_pWPOptionWrapper
private
mixed
$_pWPOptionWrapper
$_records
private
array<string|int, mixed>
$_records
= []
$_recordsRaw
private
array<string|int, mixed>
$_recordsRaw
= []
$_redirectIfOldUrl
private
Redirector
$_redirectIfOldUrl
$_unitsViewName
private
string
$_unitsViewName
= null
Methods
__construct()
public
__construct(DataView $pDataView[, EstateListEnvironment $pEnvironment = null ]) : mixed
Parameters
- $pDataView : DataView
- $pEnvironment : EstateListEnvironment = null
Tags
Return values
mixed —custom_pre_get_document_title()
public
custom_pre_get_document_title(mixed $title_parts_array, mixed $recordModified) : mixed
Parameters
- $title_parts_array : mixed
- $recordModified : mixed
Return values
mixed —estateIterator()
public
estateIterator([string $modifier = EstateViewFieldModifierTypes::MODIFIER_TYPE_DEFAULT ][, bool $checkEstateIdRequestGuard = false ]) : ArrayContainerEscape
Parameters
- $modifier : string = EstateViewFieldModifierTypes::MODIFIER_TYPE_DEFAULT
- $checkEstateIdRequestGuard : bool = false
Tags
Return values
ArrayContainerEscape —getAddressFields()
public
getAddressFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCurrentEstateId()
public
getCurrentEstateId() : int
Return values
int —getCurrentMultiLangEstateMainId()
public
getCurrentMultiLangEstateMainId() : int
Return values
int —getDataView()
public
getDataView() : DataView
Return values
DataView —getDefaultFilterBuilder()
public
getDefaultFilterBuilder() : DefaultFilterBuilder
Tags
Return values
DefaultFilterBuilder —getDocument()
public
getDocument() : string
Return values
string —getEnvironment()
public
getEnvironment() : EstateListEnvironment
Return values
EstateListEnvironment —getEstateContactIds()
public
getEstateContactIds() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEstateContacts()
public
getEstateContacts() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEstateId()
public
getEstateId() : int
Return values
int —getEstateIds()
public
getEstateIds() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEstateLink()
public
getEstateLink() : string
Tags
Return values
string —getEstateLinks()
public
getEstateLinks(mixed $type) : array<string|int, mixed>
Parameters
- $type : mixed
Return values
array<string|int, mixed> —Returns an array if Movie Links are active and displayed as Link
getEstateMovieLinks()
Not supported in list view
public
getEstateMovieLinks() : array<string|int, mixed>
Return values
array<string|int, mixed> —Returns an array if Movie Links are active and displayed as Link
getEstateOverallCount()
public
getEstateOverallCount() : int
Tags
Return values
int —getEstatePictures()
public
getEstatePictures([array<string|int, mixed> $types = null ]) : array<string|int, mixed>
Parameters
- $types : array<string|int, mixed> = null
Return values
array<string|int, mixed> —getEstatePictureText()
public
getEstatePictureText(int $imageId) : string
Parameters
- $imageId : int
Return values
string —getEstatePictureTitle()
public
getEstatePictureTitle(int $imageId) : string
Parameters
- $imageId : int
Return values
string —getEstatePictureUrl()
public
getEstatePictureUrl(int $imageId[, array<string|int, mixed> $options = null ]) : string
Parameters
- $imageId : int
- $options : array<string|int, mixed> = null
Return values
string —getEstatePictureValues()
public
getEstatePictureValues(int $imageId) : array<string|int, mixed>
Parameters
- $imageId : int
Return values
array<string|int, mixed> —getEstateUnits()
public
getEstateUnits() : string
Tags
Return values
string —getFieldLabel()
public
getFieldLabel(string $field) : string
Parameters
- $field : string
Return values
string —getFormatOutput()
public
getFormatOutput() : bool
Return values
bool —getGeoSearchBuilder()
public
getGeoSearchBuilder() : GeoSearchBuilder
Return values
GeoSearchBuilder —getLinkEmbedPlayers()
public
getLinkEmbedPlayers(mixed $type[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $type : mixed
- $options : array<string|int, mixed> = []
Return values
mixed —getMovieEmbedPlayers()
Not supported in list view
public
getMovieEmbedPlayers([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed> = []
-
key-value array of options (supports width and/or height)
Return values
array<string|int, mixed> —getRawValues()
public
getRawValues() : ArrayContainerEscape
Return values
ArrayContainerEscape —getShortCodeForm()
public
getShortCodeForm() : string
Return values
string —getShowEstateMarketingStatus()
public
getShowEstateMarketingStatus() : bool
Return values
bool —getShowReferenceEstate()
public
getShowReferenceEstate() : bool
Return values
bool —getShowReferenceStatus()
public
getShowReferenceStatus() : bool
Return values
bool —getSimilarEstates()
public
getSimilarEstates() : string
Tags
Return values
string —getUnitsViewName()
public
getUnitsViewName() : string
Return values
string —getViewRestrict()
public
getViewRestrict() : bool
Tags
Return values
bool —getVisibleFilterableFields()
public
getVisibleFilterableFields() : array<string|int, string>
Tags
Return values
array<string|int, string> —An array of visible fields
hasDetailView()
public
hasDetailView() : bool
Tags
Return values
bool —loadEstates()
performs the request
public
loadEstates([int $currentPage = 1 ][, DataView $pDataListView = null ]) : mixed
Parameters
- $currentPage : int = 1
- $pDataListView : DataView = null
Tags
Return values
mixed —loadSingleEstate()
public
loadSingleEstate(int $id) : mixed
Parameters
- $id : int
Return values
mixed —resetEstateIterator()
resets internal iterator handle
public
resetEstateIterator() : mixed
Return values
mixed —setDefaultFilterBuilder()
public
setDefaultFilterBuilder(DefaultFilterBuilder $pDefaultFilterBuilder) : mixed
Parameters
- $pDefaultFilterBuilder : DefaultFilterBuilder
Return values
mixed —setEstateId()
public
setEstateId(int $estateId) : mixed
Parameters
- $estateId : int
Return values
mixed —setFormatOutput()
public
setFormatOutput(bool $formatOutput) : mixed
Parameters
- $formatOutput : bool
Return values
mixed —setGeoSearchBuilder()
public
setGeoSearchBuilder(GeoSearchBuilder $pGeoSearchBuilder) : mixed
Parameters
- $pGeoSearchBuilder : GeoSearchBuilder
Return values
mixed —setUnitsViewName()
public
setUnitsViewName(string $unitsViewName) : mixed
Parameters
- $unitsViewName : string
Return values
mixed —addExtraParams()
protected
addExtraParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEstateFiles()
protected
getEstateFiles() : EstateFiles
Return values
EstateFiles —getNumEstatePages()
protected
getNumEstatePages() : int
Return values
int —getPreloadEstateFileCategories()
protected
getPreloadEstateFileCategories() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getRecordsPerPage()
protected
getRecordsPerPage() : int
Return values
int —collectEstateContactPerson()
private
collectEstateContactPerson(array<string|int, mixed> $responseArrayContacts, array<string|int, mixed> $estateIds) : mixed
Parameters
- $responseArrayContacts : array<string|int, mixed>
- $estateIds : array<string|int, mixed>
Tags
Return values
mixed —getEstateContactPerson()
private
getEstateContactPerson(array<string|int, mixed> $estateIds) : mixed
Parameters
- $estateIds : array<string|int, mixed>
Tags
Return values
mixed —getEstateIdToForeignMapping()
private
getEstateIdToForeignMapping(array<string|int, mixed> $estateResponseArray) : array<string|int, mixed>
Parameters
- $estateResponseArray : array<string|int, mixed>
Return values
array<string|int, mixed> —Mapping: mainEstateId => multiLangId
getEstateParameters()
private
getEstateParameters(int $currentPage, bool $formatOutput) : array<string|int, mixed>
Parameters
- $currentPage : int
- $formatOutput : bool
Tags
Return values
array<string|int, mixed> —loadRecords()
private
loadRecords(int $currentPage) : mixed
Parameters
- $currentPage : int