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

\OpenEstate\PhpExportEnvironment

Export environment.

Summary

Methods
Properties
Constants
__construct()
__destruct()
getActionUrl()
getAssets()
getAssetsPath()
getAssetsUrl()
getCachePath()
getCaptchaUrl()
getConfig()
getCustomCssPath()
getCustomCssUrl()
getDataPath()
getDataUrl()
getDownloadUrl()
getExposeUrl()
getFavoriteUrl()
getImageUrl()
getLanguage()
getLanguageCodes()
getLanguageName()
getListingUrl()
getLocalePath()
getObject()
getObjectIds()
getObjectPdf()
getObjectStamp()
getObjectText()
getSession()
getTheme()
getThemeName()
getThemePath()
getThemeUrl()
getTranslations()
getTranslator()
isDebugMode()
isSupportedLanguage()
isProductionMode()
isStatistics()
newAction()
newExposeHtml()
newFavoriteHtml()
newLinkProvider()
newListingHtml()
newMailer()
newMapProvider()
parameter()
processAction()
setLanguage()
shutdown()
$parameterPrefix
$objectsCacheSize
$objectTextsCacheSize
$actionParameter
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$config
$assets
$theme
$session
$objects
$objectTexts
$language
$languages
$translator
$translations
N/A

Properties

$parameterPrefix

$parameterPrefix : string

Prefix for parameter names.

This should be set before the environment is created.

Type

string

$objectsCacheSize

$objectsCacheSize : integer

Maximal number of objects to keep in the local cache.

Type

integer

$objectTextsCacheSize

$objectTextsCacheSize : integer

Maximal number of object texts to keep in the local cache.

Type

integer

$actionParameter

$actionParameter : string

Name of the action parameter.

Type

string

$objects

$objects : array

Internal cache with objects data.

Type

array

$objectTexts

$objectTexts : array

Internal cache with object texts.

Type

array

$language

$language : string

Current language.

Type

string

$languages

$languages : array

Available languages.

Type

array

$translator

$translator :

Translator.

var Translator

Type

$translations

$translations :

Translations loaded from data directory.

var array

Type

Methods

__construct()

__construct(\OpenEstate\PhpExport\Config  $config, boolean  $initSession = true)

Environment constructor.

Parameters

\OpenEstate\PhpExport\Config $config

configuration
boolean $initSession

load session during initialization

Throws

\Exception

if the environment is not valid

__destruct()

__destruct()

Environment destructor.

getActionUrl()

getActionUrl(array|null  $parameters = null) : string

Get URL for the action handler script.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getAssetsPath()

getAssetsPath(array|null  $path) : string

Get path to a file within the assets folder.

Parameters

array|null $path

path elements within the assets folder

Returns

string —

path

getAssetsUrl()

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

Get URL for a file within the assets folder.

Parameters

$path

path within the assets folder
array|null $parameters

associative array with URL parameters

Returns

string —

URL

getCachePath()

getCachePath(array|null  $path) : string

Get path to a file within the cache folder.

Parameters

array|null $path

path elements within the cache folder

Returns

string —

path

getCaptchaUrl()

getCaptchaUrl(array|null  $parameters = null) : string

Get URL for the captcha script.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getCustomCssPath()

getCustomCssPath() : string

Get path to the custom css file.

Returns

string —

path

getCustomCssUrl()

getCustomCssUrl(array|null  $parameters = null) : string

Get URL for the custom css file.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getDataPath()

getDataPath(array|null  $path) : string

Get path to a file within the data folder.

Parameters

array|null $path

path elements within the data folder

Returns

string —

path

getDataUrl()

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

Get URL for the data folder.

Parameters

$path

path within the data folder
array|null $parameters

associative array with URL parameters

Returns

string —

URL

getDownloadUrl()

getDownloadUrl(array|null  $parameters = null) : string

Get URL for the download script.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getExposeUrl()

getExposeUrl(array|null  $parameters = null) : string

Get URL for the expose view.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getFavoriteUrl()

getFavoriteUrl(array|null  $parameters = null) : string

Get URL for the favorite view.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getImageUrl()

getImageUrl(array|null  $parameters = null) : string

Get URL for the image script.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getLanguage()

getLanguage() : string

Get current language.

Returns

string —

ISO language code

getLanguageCodes()

getLanguageCodes() : array

Get ISO codes of available languages.

Returns

array —

ISO codes with available languages

getLanguageName()

getLanguageName(string  $code) : string|null

Get name of a language.

Parameters

string $code

ISO language code

Returns

string|null —

name of the language or null, if the code is unknown

getListingUrl()

getListingUrl(array|null  $parameters = null) : string

Get URL for the listing view.

Parameters

array|null $parameters

associative array with URL parameters

Returns

string —

URL

getLocalePath()

getLocalePath(array|null  $path) : string

Get path to the locale folder.

Parameters

array|null $path

path elements within the locale folder

Returns

string —

path

getObject()

getObject(string  $id = null) : array|null

Get the data of a real estate object.

Parameters

string $id

object ID

Returns

array|null —

an array with real estate data or null, if not found

getObjectIds()

getObjectIds() : array

Get ID's of available real estate objects.

Returns

array —

array with object ID's

getObjectPdf()

getObjectPdf(string  $objectId, string  $lang) : string

Get PDF expose for a real estate object.

Parameters

string $objectId

object ID
string $lang

language code

Returns

string —

path to PDF expose or null, if no expose exists

getObjectStamp()

getObjectStamp(string  $id = null) : integer|null

Get the timestamp, when a real estate object was last modified.

Parameters

string $id

object ID

Returns

integer|null —

timestamp of last modification or null, if not found

getObjectText()

getObjectText(string  $id = null) : array|null

Get the text data of a real estate object.

Parameters

string $id

object ID

Returns

array|null —

an array with real estate text data or null, if not found

getThemeName()

getThemeName() : string

Get name of the current theme.

Returns

string —

theme name

getThemePath()

getThemePath(array|null  $path) : string

Get path to the folder of the current theme.

Parameters

array|null $path

path elements within the theme folder

Returns

string —

path

getThemeUrl()

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

Get URL for a file of the current theme.

Parameters

$path

path within the current theme folder
array|null $parameters

associative array with URL parameters

Returns

string —

URL

getTranslations()

getTranslations() : array

Get translations provided in data directory.

Returns

array —

array with translations

getTranslator()

getTranslator() : \Gettext\BaseTranslator

Get the translator.

Returns

\Gettext\BaseTranslator —

translator

isDebugMode()

isDebugMode() : boolean

Test, if debug mode is enabled.

Returns

boolean —

true, if debug mode is enabled

isSupportedLanguage()

isSupportedLanguage(string  $languageCode) : boolean

Test, if a language is available in the export environment.

Parameters

string $languageCode

Returns

boolean —

true, if the language is available

isProductionMode()

isProductionMode() : boolean

Test, if production mode is enabled.

Returns

boolean —

true, if production mode is enabled

isStatistics()

isStatistics() : boolean

Test, if statistics are enabled.

Returns

boolean —

true, if statistics are enabled

newAction()

newAction(string  $name) : \OpenEstate\PhpExport\Action\AbstractAction

Create an action instance.

Parameters

string $name

name of requested action

Returns

\OpenEstate\PhpExport\Action\AbstractAction —

created action or null, if it is unknown

newLinkProvider()

newLinkProvider(string  $name) : \OpenEstate\PhpExport\Provider\AbstractLinkProvider

Create a link provider instance.

Parameters

string $name

name of requested provider

Returns

\OpenEstate\PhpExport\Provider\AbstractLinkProvider —

created link provider or null, if it is unknown

newMailer()

newMailer() : \PHPMailer\PHPMailer\PHPMailer

Create a mailer instance.

Throws

\PHPMailer\PHPMailer\Exception

if the mailer configuration failed

Returns

\PHPMailer\PHPMailer\PHPMailer —

created mailer instance

parameter()

parameter(string  $parameterName) : string

Constructs a parameter name with the configured a prefix.

Parameters

string $parameterName

parameter name

Returns

string —

parameter name with configured prefix

processAction()

processAction() : mixed|null

Process the requested action.

Throws

\Exception

if the execution of the action failed

Returns

mixed|null —

action result or null, if no action was executed

setLanguage()

setLanguage(string  $languageCode)

Set current language.

Parameters

string $languageCode

ISO language code

shutdown()

shutdown()

Shutdown export environment.