onOffice WP Plugin

EstateList
in package
implements EstateListBase

Interfaces, Classes, Traits and Enums

EstateListBase

Table of Contents

$_currentEstate  : array<string|int, mixed>
$_currentEstatePage  : int
$_estateContacts  : array<string|int, mixed>
$_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>
getEstateIds()  : array<string|int, mixed>
getEstateLink()  : string
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
getMovieEmbedPlayers()  : array<string|int, mixed>
Not supported in list view
getRawValues()  : ArrayContainerEscape
getShowEstateMarketingStatus()  : bool
getShowReferenceEstate()  : bool
getShowReferenceStatus()  : bool
getUnitsViewName()  : string
getViewRestrict()  : bool
getVisibleFilterableFields()  : array<string|int, string>
hasDetailView()  : bool
loadEstates()  : mixed
performs the request
resetEstateIterator()  : mixed
resets internal iterator handle
setDefaultFilterBuilder()  : 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 = []

$_formatOutput

private bool $_formatOutput = true

$_numEstatePages

private int $_numEstatePages = null

$_pWPOptionWrapper

private mixed $_pWPOptionWrapper

$_records

private array<string|int, mixed> $_records = []

$_recordsRaw

private array<string|int, mixed> $_recordsRaw = []

$_unitsViewName

private string $_unitsViewName = null

Methods

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
throws
UnknownFieldException
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

getDocument()

public getDocument() : string
Return values
string

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>

getEstateIds()

public getEstateIds() : array<string|int, mixed>
Return values
array<string|int, mixed>
public getEstateLink() : string
Tags
throws
DependencyException
throws
NotFoundException
Return values
string

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

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>

getFieldLabel()

public getFieldLabel(string $field) : string
Parameters
$field : string
Return values
string

getFormatOutput()

public getFormatOutput() : bool
Return values
bool

getMovieEmbedPlayers()

Not supported in list view

public getMovieEmbedPlayers([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getShowEstateMarketingStatus()

public getShowEstateMarketingStatus() : bool
Return values
bool

getShowReferenceEstate()

public getShowReferenceEstate() : bool
Return values
bool

getShowReferenceStatus()

public getShowReferenceStatus() : bool
Return values
bool

getUnitsViewName()

public getUnitsViewName() : string
Return values
string

getViewRestrict()

public getViewRestrict() : bool
Tags
throws
DependencyException
throws
NotFoundException
Return values
bool

getVisibleFilterableFields()

public getVisibleFilterableFields() : array<string|int, string>
Tags
throws
DependencyException
throws
NotFoundException
throws
UnknownFieldException
Return values
array<string|int, string>

An array of visible fields

hasDetailView()

public hasDetailView() : bool
Tags
throws
DependencyException
throws
NotFoundException
Return values
bool

resetEstateIterator()

resets internal iterator handle

public resetEstateIterator() : mixed
Return values
mixed

setFormatOutput()

public setFormatOutput(bool $formatOutput) : mixed
Parameters
$formatOutput : bool
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>

getPreloadEstateFileCategories()

protected getPreloadEstateFileCategories() : array<string|int, mixed>
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
throws
DependencyException
throws
NotFoundException
throws
ApiClientException
Return values
mixed

getEstateContactPerson()

private getEstateContactPerson(array<string|int, mixed> $estateIds) : mixed
Parameters
$estateIds : array<string|int, mixed>
Tags
throws
DependencyException
throws
NotFoundException
throws
ApiClientException
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
throws
UnknownViewException
Return values
array<string|int, mixed>

Search results