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

An abstract theme.

Summary

Methods
Properties
Constants
__construct()
__destruct()
getComponentIds()
getEnvironment()
getName()
i18nGettext()
i18nGettextPlural()
isComponentEnabled()
newExposeHtml()
newFavoriteHtml()
newListingHtml()
setComponentEnabled()
setupExposeHtml()
setupFavoriteHtml()
setupListingHtml()
No public properties found
No constants found
No protected methods found
$env
N/A
No private methods found
$name
$disabledComponents
N/A

Properties

$name

$name : string

Internal name of the theme.

Type

string

$disabledComponents

$disabledComponents : array

Header components, that should not be integrated by the theme.

Type

array

Methods

__construct()

__construct(string  $name, \OpenEstate\PhpExport\Environment  $env)

AbstractTheme constructor.

Parameters

string $name

internal name of the theme
\OpenEstate\PhpExport\Environment $env

export environment

__destruct()

__destruct()

AbstractTheme destructor.

getComponentIds()

getComponentIds() : array

Get a list of components, that are provided by this theme.

Returns

array —

list of components ID's

getName()

getName() : string

Get the internal name of the theme.

Returns

string —

theme name

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

isComponentEnabled()

isComponentEnabled(string  $componentId) : boolean

Test, if a certain component is enabled for this theme.

Parameters

string $componentId

ID of the component

Returns

boolean —

true, if the component is enabled

setComponentEnabled()

setComponentEnabled(string  $componentId, boolean  $enabled)

Enable or disable a certain component in the theme.

Parameters

string $componentId

ID of the component
boolean $enabled

true, if the component is enabled

setupExposeHtml()

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

Set default 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 default 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 default configuration for the HTML view with object listing.

Parameters

\OpenEstate\PhpExport\View\ListingHtml $view

view to configure