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

Export configuration.

Summary

Methods
Properties
Constants
__construct()
getActionUrl()
getAssetsFolderPath()
getAssetsFolderUrl()
getCacheFolderPath()
getCancellationPolicyUrl()
getCaptchaUrl()
getCustomCssPath()
getCustomCssUrl()
getDataFolderPath()
getDataFolderUrl()
getDownloadUrl()
getExposeUrl()
getFavoriteUrl()
getFeedUrl()
getFilterObjects()
getImageUrl()
getListingUrl()
getLocaleFolderPath()
getOrderObjects()
getPrivacyPolicyUrl()
getTermsUrl()
getThemeFolderPath()
getThemeFolderUrl()
i18nGettext()
i18nGettextPlural()
newAction()
newLinkProvider()
newMailer()
newMapProvider()
newSession()
newTheme()
setupAction()
setupEnvironment()
setupExposeHtml()
setupFavoriteHtml()
setupLinkProvider()
setupListingHtml()
setupMailer()
setupMapProvider()
setupTheme()
$companyName
$themeName
$defaultLanguage
$allowLanguageSelection
$charset
$cacheLifeTime
$dynamicImageScaling
$favorites
$atomFeed
$atomFeedLimit
$atomFeedWithImage
$rssFeed
$rssFeedLimit
$rssFeedWithImage
$trovitFeed
$trovitFeedLimit
$sitemap
$debug
$statistics
$minimizeHtml
$compatibility
$basePath
$baseUrl
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$companyName

$companyName : string

Name of the company.

Type

string

$themeName

$themeName : string

Name of the theme used to render pages.

Type

string

$defaultLanguage

$defaultLanguage : string

Default language code.

Type

string

$allowLanguageSelection

$allowLanguageSelection : boolean

Allow users to change the language.

Type

boolean

$charset

$charset : string

Charset for generated text content.

Type

string

$cacheLifeTime

$cacheLifeTime : string

Default time, a file is kept in cache (in seconds).

Type

string

$dynamicImageScaling

$dynamicImageScaling : boolean

Generate thumbnail images via PHP.

This option requires the GD module to be available in PHP.

Type

boolean

$favorites

$favorites : boolean

Enable management of favored real estates.

Type

boolean

$atomFeed

$atomFeed : boolean

Enable atom feed.

Type

boolean

$atomFeedLimit

$atomFeedLimit : integer

Maximal number of objects shown in the atom feed.

Set the value to 0 to show all objects in the feed.

Type

integer

$atomFeedWithImage

$atomFeedWithImage : boolean

Show the first image of an object in the atom feed.

Type

boolean

$rssFeed

$rssFeed : boolean

Enable rss feed.

Type

boolean

$rssFeedLimit

$rssFeedLimit : integer

Maximal number of objects shown in the rss feed.

Set the value to 0 to show all objects in the feed.

Type

integer

$rssFeedWithImage

$rssFeedWithImage : boolean

Show the first image of an object in the rss feed.

Type

boolean

$trovitFeed

$trovitFeed : boolean

Enable trovit feed.

Type

boolean

$trovitFeedLimit

$trovitFeedLimit : integer

Maximal number of objects shown in the trovit feed.

Set the value to 0 to show all objects in the feed.

Type

integer

$sitemap

$sitemap : boolean

Enable xml sitemap.

Type

boolean

$debug

$debug : boolean

Enable debug output.

Type

boolean

$statistics

$statistics : boolean

Enable statistics output.

Type

boolean

$minimizeHtml

$minimizeHtml : boolean

Enable minimization of generated HTML code.

This is an experimental feature, that might lead to problems in certain situations.

Type

boolean

$compatibility

$compatibility : integer

Level of compatibility for data of older PHP exports.

Currently the values 0 and 1 may be used. Value 0 supports the processing of data, that was exported for PHP export 1.6.x or 1.7.x. Value 1 supports the processing of data, that was exported for the current version of PHP export.

Type

integer

$basePath

$basePath : string

Absolute path, that points to the root of the export environment.

Type

string

$baseUrl

$baseUrl : string

URL, that points to the root of the export environment.

Type

string

Methods

__construct()

__construct(string  $basePath, string  $baseUrl = '.')

Config constructor.

Parameters

string $basePath

absolute path of the export environment.
string $baseUrl

URL of the export environment.

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

getAssetsFolderPath()

getAssetsFolderPath() : string

Get path to the assets folder.

Returns

string —

path

getAssetsFolderUrl()

getAssetsFolderUrl() : string

Get URL for the assets folder.

Returns

string —

URL

getCacheFolderPath()

getCacheFolderPath() : string

Get path to the cache folder.

Returns

string —

path

getCancellationPolicyUrl()

getCancellationPolicyUrl(string  $lang) : string|null

Get URL for the cancellation policy.

Parameters

string $lang

language code

Returns

string|null —

cancellation policy url

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() : string

Get URL for the custom css file.

Returns

string —

URL

getDataFolderPath()

getDataFolderPath() : string

Get path to the data folder.

Returns

string —

path

getDataFolderUrl()

getDataFolderUrl() : string

Get URL for the data folder.

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

getFeedUrl()

getFeedUrl(string  $type, string  $lang) : string

Get URL for a real estate feed.

Parameters

string $type

type of feed (atom / rss / trovit)
string $lang

language code

Returns

string —

URL

getFilterObjects()

getFilterObjects() : array

Get available filters.

Returns

array —

list of filter objects

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

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

getLocaleFolderPath()

getLocaleFolderPath() : string

Get path to the locale folder.

Returns

string —

path

getOrderObjects()

getOrderObjects() : array

Get available orders.

Returns

array —

list of order objects

getPrivacyPolicyUrl()

getPrivacyPolicyUrl(string  $lang) : string|null

Get URL for the privacy policy.

Parameters

string $lang

language code

Returns

string|null —

privacy policy url

getTermsUrl()

getTermsUrl(string  $lang) : string|null

Get URL for the terms of use.

Parameters

string $lang

language code

Returns

string|null —

terms url

getThemeFolderPath()

getThemeFolderPath(string|null  $theme = null) : string

Get path to the theme folder.

Parameters

string|null $theme

theme name

Returns

string —

path to the requested theme folder or to the parent theme folder, if no theme name was provided

getThemeFolderUrl()

getThemeFolderUrl(string|null  $theme = null) : string

Get URL for a theme folder.

Parameters

string|null $theme

theme name

Returns

string —

URL

i18nGettext()

i18nGettext(string  $lang, string  $original) : string

Get a translation using the original string.

Parameters

string $lang

language code
string $original

original string to translate

Returns

string —

translation

i18nGettextPlural()

i18nGettextPlural(string  $lang, string  $original, string  $plural, string  $value) : string

Get a translation checking the plural form.

Parameters

string $lang

language code
string $original

original string to translate
string $plural

plural form of the original string
string $value

value to determine plural forms

Returns

string —

translation

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|null

Create a mailer instance.

Returns

\PHPMailer\PHPMailer\PHPMailer|null —

created mailer or null, if the configuration failed

setupEnvironment()

setupEnvironment(\OpenEstate\PhpExport\Environment  $env)

Configure the export environment.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment

setupExposeHtml()

setupExposeHtml(\OpenEstate\PhpExport\View\ExposeHtml  $view)

Set configuration for the HTML view with object details.

Parameters

\OpenEstate\PhpExport\View\ExposeHtml $view

view to configure

setupFavoriteHtml()

setupFavoriteHtml(\OpenEstate\PhpExport\View\FavoriteHtml  $view)

Set configuration for the HTML view with favorite listing.

Parameters

\OpenEstate\PhpExport\View\FavoriteHtml $view

view to configure

setupListingHtml()

setupListingHtml(\OpenEstate\PhpExport\View\ListingHtml  $view)

Set configuration for the HTML view with object listing.

Parameters

\OpenEstate\PhpExport\View\ListingHtml $view

view to configure

setupMailer()

setupMailer(\PHPMailer\PHPMailer\PHPMailer  $mailer, \OpenEstate\PhpExport\Environment  $env)

Configure the mailer.

Parameters

\PHPMailer\PHPMailer\PHPMailer $mailer

mailer instance
\OpenEstate\PhpExport\Environment $env

export environment

Throws

\PHPMailer\PHPMailer\Exception

if the configuration failed