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

An abstract HTML document.

Summary

Methods
Properties
Constants
__construct()
__destruct()
getContentType()
getEnvironment()
getHttpResponseCode()
getParameters()
getTheme()
getThemeFile()
getThemeUrl()
getUrl()
loadThemeFile()
isHtmlType()
isTextType()
process()
setHttpResponseCode()
addHeader()
addHeaders()
generateHeader()
getCharset()
getHeaders()
getTitle()
isBodyOnly()
removeHeader()
setBodyOnly()
setCharset()
setTitle()
No public properties found
No constants found
generate()
$env
N/A
No private methods found
$httpResponseCode
$charset
$title
$headerElements
$headerElementsPriority
$bodyOnly
N/A

Properties

$httpResponseCode

$httpResponseCode : integer|null

HTTP response code for this view.

Type

integer|null

$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

Methods

__construct()

__construct(\OpenEstate\PhpExport\Environment  $env)

AbstractHtmlView constructor.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment

__destruct()

__destruct()

AbstractHtmlView 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

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

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

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

generate()

generate() : string

Generate the view.

Returns

string —

generated output for the view