OpenEstate-PHP-Export 2.0-beta2 API
\
Gettext
Extractors
Generators
Languages
Exporter
Utils
OpenEstate
PhpExport
Action
Filter
Html
Order
Provider
Session
Theme
View
PHPMailer
PHPMailer
TrueBV
Exception

\OpenEstate\PhpExport\ViewListingHtml

A view for a listing of real estate objects.

Summary

Methods
Properties
Constants
__construct()
__destruct()
addHeader()
addHeaders()
generateHeader()
getContentType()
getCharset()
getHeaders()
getTitle()
isBodyOnly()
process()
removeHeader()
setBodyOnly()
setCharset()
setTitle()
getEnvironment()
getHttpResponseCode()
getParameters()
getTheme()
getThemeFile()
getThemeUrl()
getUrl()
loadThemeFile()
isHtmlType()
isTextType()
setHttpResponseCode()
getFavorites()
getFilterValues()
getObjectColumns()
getObjectColumnValue()
getObjectIds()
getObjectIdsOnThisPage()
getOrder()
getOrderDirection()
getPage()
getPageCount()
getView()
$objectsPerPage
$filters
$defaultFilterValues
$orders
$defaultOrder
$defaultOrderDirection
$defaultView
$objectColumns
$objectColumnsLimit
No constants found
generate()
$env
N/A
No private methods found
$charset
$title
$headerElements
$headerElementsPriority
$bodyOnly
$httpResponseCode
N/A

Properties

$objectsPerPage

$objectsPerPage : integer

Maximal number of objects shown on a page.

Type

integer

$filters

$filters : array

Available filters in the listing.

Type

array

$defaultFilterValues

$defaultFilterValues : array

Default filter values of the listing.

Type

array

$orders

$orders : array

Available orderings in the listing.

Type

array

$defaultOrder

$defaultOrder : string

Default ordering of the listing.

Type

string

$defaultOrderDirection

$defaultOrderDirection : string

Default ordering direction of the listing.

Type

string

$defaultView

$defaultView : string

Default view of the listing.

Type

string

$objectColumns

$objectColumns : array

Array of columns with object attributes.

Type

array

$objectColumnsLimit

$objectColumnsLimit : integer

Maximal number of entries per attribute column.

Type

integer

$charset

$charset : string

Charset of the HTML document.

Type

string

$title

$title : string

Title of the HTML document.

Type

string

$headerElements

$headerElements : array

Array of header elements to include into the document.

Type

array

$headerElementsPriority

$headerElementsPriority : array

Container to store the priority of header elements.

Type

array

$bodyOnly

$bodyOnly : boolean

Only the HTML body should be printed.

Type

boolean

$httpResponseCode

$httpResponseCode : integer|null

HTTP response code for this view.

Type

integer|null

Methods

__destruct()

__destruct()

AbstractView destructor.

addHeader()

addHeader(\OpenEstate\PhpExport\Html\AbstractHeadElement  $element, integer  $priority = 100)

Register a header element.

Parameters

\OpenEstate\PhpExport\Html\AbstractHeadElement $element

header element
integer $priority

priority of the element

addHeaders()

addHeaders(array  $elements, integer  $priority = 100)

Register multiple header elements.

Parameters

array $elements

array of header elements
integer $priority

priority of the elements

generateHeader()

generateHeader() : string

Generate HTML code for registered header elements.

Returns

string —

generated HTML code

getContentType()

getContentType() : string

Get the content type of the current view.

Returns

string —

content type

getCharset()

getCharset() : string

Get the charset of the current document.

Returns

string —

document charset

getHeaders()

getHeaders() : array

Get ordered list of registered header elements.

Returns

array —

registered header elements

getTitle()

getTitle() : string

Get the title of the current document.

Returns

string —

document title

isBodyOnly()

isBodyOnly() : boolean

Determine, if only the HTML body should be printed.

Returns

boolean —

true, if only the HTML body should be printed

process()

process(boolean  $sendHeaders = true) : mixed

Generate current view and return the response body.

Parameters

boolean $sendHeaders

send header before returning the generated output

Returns

mixed —

generated output for the view

removeHeader()

removeHeader(string  $elementId)

Remove a previously registered header element.

Parameters

string $elementId

ID of the header element to remove

setBodyOnly()

setBodyOnly(boolean  $bodyOnly)

Enable or disable output of HTML head elements.

Parameters

boolean $bodyOnly

true, if only the HTML body should be printed

setCharset()

setCharset(string  $charset)

Set the charset of the current document.

Parameters

string $charset

document charset

setTitle()

setTitle(string  $title)

Set the title of the current document.

Parameters

string $title

document title

getHttpResponseCode()

getHttpResponseCode() : integer|null

Get the HTTP response code for this view.

Returns

integer|null —

HTTP response code or null, if it was not set

getParameters()

getParameters() : array

Get parameter values for this view.

Returns

array —

associative array with parameter values

getThemeFile()

getThemeFile(string  $path = null) : string|null

Get absolute path to a theme file.

Parameters

string $path

relative path within the theme directory

Returns

string|null —

absolute path to the theme file or null, if it is not available

getThemeUrl()

getThemeUrl(string  $path = null, array|null  $parameters = null) : string|null

Get URL to a theme file.

Parameters

string $path

relative path within the theme directory
array|null $parameters

associative array of URL parameters

Returns

string|null —

URL to the theme file or null, if it is not available

getUrl()

getUrl(\OpenEstate\PhpExport\Environment  $env) : string

Get url for this view.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment

Returns

string —

url

loadThemeFile()

loadThemeFile(string  $file) : mixed

Execute a theme file and return its result.

Parameters

string $file

file from the theme directory to include

Throws

\Exception

if the theme file can't be processed

Returns

mixed —

response from the theme file

isHtmlType()

isHtmlType() : boolean

Determine, if the content type is text/html.

Returns

boolean —

true, if the content type is text/html

isTextType()

isTextType() : boolean

Determine, if the content type is text/*.

Returns

boolean —

true, if the content type is text/*

setHttpResponseCode()

setHttpResponseCode(integer|null  $httpResponseCode)

Set the HTTP response code for this view.

Parameters

integer|null $httpResponseCode

HTTP response code or null to send the default code

getFavorites()

getFavorites() : array

Get an array of object ID's, that were marked as favorites by the user.

Returns

array —

array of favored object ID's

getFilterValues()

getFilterValues() : array

Get currently selected filters.

Returns

array —

array of filter values, defaults to the specified defaultFilterValues

getObjectColumns()

getObjectColumns(array  $object, string  $lang) : array

Get column definitions for a specific object.

Parameters

array $object

object data
string $lang

language code

Returns

array —

column definitions

getObjectColumnValue()

getObjectColumnValue(array  $object, string  $field, array  $i18n, string  $lang) : null|string

Get a column value for a specific object.

Parameters

array $object

object data
string $field

name of the field to show
array $i18n

translations
string $lang

language code

Returns

null|string —

HTML encoded value for the requested field

getObjectIds()

getObjectIds() : array

Get list of filtered object ID's in the specified order.

Returns

array —

array of object ID's

getObjectIdsOnThisPage()

getObjectIdsOnThisPage(array  $objectIds) : array

Reduce the list of object ID's to the current page.

Parameters

array $objectIds

array of object ID's

Returns

array —

array of object ID's to show on the current page

getOrder()

getOrder() : string

Get currently selected ordering.

Returns

string —

internal name of the ordering, defaults to the specified defaultOrder

getOrderDirection()

getOrderDirection() : string

Get direction of the currently selected ordering.

Returns

string —

ordering direction ("asc" for ascending or "desc" for descending), defaults to the specified defaultOrderDirection

getPage()

getPage() : integer

Get currently selected page number.

Returns

integer —

page number, defaults to 1

getPageCount()

getPageCount(integer  $numberOfObjects) : integer

Get the number of pages to show the objects on this view.

Parameters

integer $numberOfObjects

total number of objects

Returns

integer —

number of pages

getView()

getView() : string

Get currently selected listing view.

Returns

string —

name of the listing view, defaults to the specified defaultView

generate()

generate()