\OpenEstate\PhpExport\ViewExposeHtml

__construct()

__construct(\OpenEstate\PhpExport\Environment  $env) 

ExposeHtml constructor.

Parameters

__destruct()

__destruct() 

AbstractView destructor.

addHeader()

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

Register a header element.

Parameters

addHeaders()

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

Register multiple header elements.

Parameters

generateHeader()

generateHeader() : string

Generate HTML code for registered header elements.

Returns

generated HTML code

getContentType()

getContentType() : string

Get the content type of the current view.

Returns

content type

getCharset()

getCharset() : string

Get the charset of the current document.

Returns

document charset

getHeaders()

getHeaders() : array

Get ordered list of registered header elements.

Returns

registered header elements

getTitle()

getTitle() : string

Get the title of the current document.

Returns

document title

isBodyOnly()

isBodyOnly() : boolean

Determine, if only the HTML body should be printed.

Returns

true, if only the HTML body should be printed

process()

process(boolean  $sendHeaders = true) : mixed

Generate current view and return the response body.

Parameters

Returns

generated output for the view

removeHeader()

removeHeader(string  $elementId) 

Remove a previously registered header element.

Parameters

setBodyOnly()

setBodyOnly(boolean  $bodyOnly) 

Enable or disable output of HTML head elements.

Parameters

setCharset()

setCharset(string  $charset) 

Set the charset of the current document.

Parameters

setTitle()

setTitle(string  $title) 

Set the title of the current document.

Parameters

getEnvironment()

getEnvironment() : \OpenEstate\PhpExport\Environment

Get the export environment.

Returns

export environment

getHttpResponseCode()

getHttpResponseCode() : integer|null

Get the HTTP response code for this view.

Returns

HTTP response code or null, if it was not set

getParameters()

getParameters(string|null  $objectId = null) : array

Get parameter values for this view.

Parameters

Returns

associative array with parameter values

getTheme()

getTheme() : \OpenEstate\PhpExport\Theme\AbstractTheme

Get the theme.

Returns

theme

getThemeFile()

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

Get absolute path to a theme file.

Parameters

Returns

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

Returns

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

getUrl()

getUrl(\OpenEstate\PhpExport\Environment  $env, string|null  $objectId = null) : string

Get url for this view.

Parameters

Returns

url

loadThemeFile()

loadThemeFile(string  $file) : mixed

Execute a theme file and return its result.

Parameters

Throws

\Exception

if the theme file can't be processed

Returns

response from the theme file

isHtmlType()

isHtmlType() : boolean

Determine, if the content type is text/html.

Returns

true, if the content type is text/html

isTextType()

isTextType() : boolean

Determine, if the content type is text/*.

Returns

true, if the content type is text/*

setHttpResponseCode()

setHttpResponseCode(integer|null  $httpResponseCode) 

Set the HTTP response code for this view.

Parameters

getObjectData()

getObjectData() : array|null

Get data for the requested real estate object.

Returns

object data or null, if no valid object was requested

getObjectId()

getObjectId() : string|null

Get ID of the requested real estate object.

Returns

object ID or null, if no object was requested

getObjectTexts()

getObjectTexts() : array|null

Get texts for the requested real estate object.

Returns

object texts or null, if no valid object was requested

getFavorites()

getFavorites() : array

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

Returns

array of favored object ID's

setObjectId()

setObjectId(string  $objectId) 

Set ID of the object to show on this view.

Parameters

generate()

generate()