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\ViewAbstractView

An abstract basic view.

Summary

Methods
Properties
Constants
__construct()
__destruct()
getContentType()
getEnvironment()
getHttpResponseCode()
getParameters()
getTheme()
getThemeFile()
getThemeUrl()
getUrl()
loadThemeFile()
isHtmlType()
isTextType()
process()
setHttpResponseCode()
No public properties found
No constants found
generate()
$env
N/A
No private methods found
$httpResponseCode
N/A

Properties

$httpResponseCode

$httpResponseCode : integer|null

HTTP response code for this view.

Type

integer|null

Methods

__destruct()

__destruct()

AbstractView destructor.

getContentType()

getContentType() : string

Get the content type of the current view.

Returns

string —

content type

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/*

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

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

generate()

generate() : string

Generate the view.

Returns

string —

generated output for the view