((generated))¶
Setup for the Realty Manager front-end plugin¶
You can configure the plugin using your TS template setup in the form plugin.tx_realty_pi1. property = value. Some values can also be configures using flexforms.
If your want to set a value for all instances of the plugin in one place, use the TS template setup. If you use flexforms, make sure to set the values at all relevant instances of the plug in: It doesn’t do to specify the fields for the FE editor in the realty list front end plugin—you need to set these fields in the FE editor front-end plugin.
Note: If you set any non-empty value in the flexforms, this will override the corresponding value from TS Setup.
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
what_to_display
Data type
string
Description
The kind of front end plugin to display. This must be set using flexforms.
Default
realty_list
Property
templateFile
Data type
string
Description
File name of the HTML template
Default
EXT:realty/Resources/Private/Templates/FrontEnd/Plugin.html
Property
salutation
Data type
string
Description
Switch whether to use formal/informal language on the front end.Allowed values are:formal | informal
Note: Currently, there only are texts for the formal salutation.
Default
formal
Property
currencyUnit
Data type
string
Description
currency symbol, must be a valid ISO alpha 3 code, e.g. “EUR” for Euro, “USD” for US dollars
Default
EUR
Property
dateFormat
Data type
string
Description
format for all dates (as required for strftime)
Default
%d.%m.%Y
Property
listImageMaxX
Data type
integer
Description
maximum X size of images in the list view (in pixels)
Default
98
Property
listImageMaxY
Data type
integer
Description
maximum Y size of images in the list view (in pixels)
Default
98
Property
singleImageMaxX
Data type
integer
Description
maximum X size of images in the single view (in pixels)
Default
137
Property
singleImageMaxY
Data type
integer
Description
maximum Y size of images in the single view (in pixels)
Default
137
Property
imageUploadThumbnailWidth
Data type
integer
Description
maximum width of thumbnails in the front-end image upload
Default
200
Property
imageUploadThumbnailHeight
Data type
integer
Description
maximum height of thumbnails in the front-end image upload
Default
75
Property
lightboxImageWidthMax
Data type
integer
Description
maximum width of the images shown in the lightbox gallery
Default
1024
Property
lightboxImageHeightMax
Data type
integer
Description
maximum height of the images shown in the lightbox gallery
Default
768
Property
enableLightbox
Data type
boolean
Description
whether the lightboxshould be enabled
Default
1
Property
fieldsInSingleViewTable
Data type
string
Description
ordered, comma-separated list of fields from tx_realty_objects that will be shown in the table in the single view
Default
house_type, apartment_type, total_area, total_usable_area, living_area, office_space, shop_area, sales_area, site_occupancy_index, floor_space_index, window_bank, storage_area, other_area, estate_size, garage_type, parking_spaces, state, status, usable_from, number_of_rooms, bedrooms, bathrooms, heating_type, furnishing_category, flooring, construction_year, floor, floors, layout, pets, balcony, garden, barrier_free, wheelchair_accessible, elevator, ramp, lifting_platform, suitable_for_the_elderly, assisted_living, fitted_kitchen, has_air_conditioning, has_pool, has_community_pool, distance_to_the_sea, sea_view, buying_price, rent_excluding_bills, rent_with_additional_costs, year_rent, rental_income_target, rent_per_square_meter, extra_charges, heating_included, deposit, hoa_fee, provision, garage_rent, garage_price, energy_certificate_type, energy_certificate_valid_until, energy_consumption_characteristic, with_hot_water, ultimate_energy_demand, primary_energy_carrier, electric_power_consumption_characteristic, heat_energy_consumption_characteristic, value_category, year_of_construction, energy_certificate_issue_date, energy_certificate_year, building_type, energy_certificate_text, heat_energy_requirement_value, heat_energy_requirement_class, total_energy_efficiency_value, total_energy_efficiency_class
Property
defaultContactEmail
Data type
string
Description
default e-mail address for requests, used without validation
Default
Property
contactEmailLanguage
Data type
string
Description
lowercase ISO code of the language to be used for the contact form email, e.g., “en” or “nl”
Default
Property
blindCarbonCopyAddress
Data type
string
Description
e-mail address where to send a BCC of each request, leave empty to disable
Default
Property
showContactPageLink
Data type
boolean
Description
whether the contact form should be displayed (applicable in single and favorites view)
Default
0
Property
visibleContactFormFields
Data type
string
Description
Comma-separated list of fields to show in the contact form, allowed values are:name, street, zip_and_city, telephone, request, viewing, information, callback, terms, law
Default
name,street,zip_and_city,telephone,request
Property
requiredContactFormFields
Data type
string
Description
Comma-separated list of required fields for the contact form; allowed values are:name, street, zip, city, telephone, request
Default
name,request
Property
termsPID
Data type
page_id
Description
PID of the page containing the terms linked from the contact form
Default
Property
favoriteFieldsInSession
Data type
string
Description
ordered, comma-separated list of field names that will be stored in the session when displaying the favorites list, leave empty to disable; all DB column names from tx_realty_objects are allowed
Default
Property
requireLoginForSingleViewPage
Data type
boolean
Description
whether the single view page may only be viewed by logged-in FE users
Default
0
Property
loginPID
Data type
page_id
Description
PID of the login page (only necessary if you set requireLoginForDetailsPage to 1)
Default
none
Property
contactPID
Data type
page_id
Description
PID of the contact page which will be linked from the favorites list (leave empty to disable this link)
Default
none
Property
pages
Data type
string
Description
Starting point: comma-separated list of PIDs that contain the realty records to be displayed; usually this is selected via flexforms
Default
Property
recursive
Data type
integer
Description
recursion level for the starting point/pages list; usually this is selected via flexforms
Default
0
Property
staticSqlFilter
Data type
string
Description
static SQL filter (will be appended to the WHERE clause using ” AND “)
Default
Property
checkboxesFilter
Data type
string
Description
name of the DB field to create the search filter checkboxes from
Default
Property
orderBy
Data type
string
Description
which DB field is used for the default sorting in the list view
Default
tstamp
Property
sortCriteria
Data type
string
Description
DB fields by which a FE user can sort the list view
Default
Property
displayedSearchWidgetFields
Data type
String
Description
list of search fields which should be displayed in the search widget available fields are: site, priceRanges, uid, objectNumber, city, district, objectType, rent, livingArea, houseType, numberOfRooms
Default
sites
Property
singleViewPartsToDisplay
Data type
string
Description
keys of the single View parts to display, should be set via flexforms
Default
heading,address,description,documents,furtherDescription,price,overvie wTable,imageThumbnails,addToFavoritesButton,contactButton,offerer,prin tPageButton,backButton
Property
singlePID
Data type
page_id
Description
PID of the page for the single view (leave empty to use the same page as the list view)
Default
Property
favoritesPID
Data type
page_id
Description
PID of the page with the favorites list
Default
Property
filterFormTargetPID
Data type
page_id
Description
PID of the target page for the search form and the city selector
Default
Property
editorPID
Data type
page_id
Description
PID of the page with the FE editor
Default
Property
imageUploadPID
Data type
page_id
Description
PID of the page with the image upload
Default
Property
objectsByOwnerPID
Data type
page_id
Description
PID of the target page for the list of objects by one owner
Default
Property
offererImageMaxWidth
Data type
Integer
Description
the maximum width for the offerer image
Default
150
Property
offererImageMaxHeight
Data type
integer
Description
the maximum height for the offerer image
Default
100
Property
userGroupsForOffererList
Data type
string
Description
Comma-separated list of FE user group UIDs for the offerer list
Default
Property
displayedContactInformation
Data type
string
Description
Comma-separated list of contact information to display
Default
offerer_label,telephone
Property
displayedContactInformationSpecial
Data type
string
Description
Comma-separated list of contact information to display of the offerers in the groups in groupsWithSpeciallyDisplayedContactInformation
Default
offerer_label,telephone
Property
groupsWithSpeciallyDisplayedContactInformation
Data type
string
Description
Comma-separated list of user group UIDs of which to display special offerer information
Default
Property
sysFolderForFeCreatedRecords
Data type
page_id
Description
PID of the system folder for FE-created records
Default
Property
sysFolderForFeCreatedAuxiliaryRecords
Data type
page_id
Description
PID of the system folder for FE-created auxiliary records
Default
Property
feEditorRedirectPid
Data type
page_id
Description
PID of the FE page to redirect to after saving a FE-created record
Default
Property
feEditorNotifyEmail
Data type
string
Description
e-mail address that receives a message if a new record has been FE- created
Default
Property
feEditorTemplateFile
Data type
string
Description
location of the HTML template file for the FE editor and image upload
Default
EXT:realty/Resources/Private/Templates/FrontEnd/Editor.html
Property
showGoogleMaps
Data type
boolean
Description
whether Google Maps should be displayed in the list view
Default
0
Property
defaultCountryUID
Data type
Integer
Description
default country for objects that have no country set (a UID from the static_countries table, 54 = Germany)
Default
54
Property
showIdSearchInFilterForm
Data type
string
Description
Show ID search in search view. If set to ‘uid’ the UID search form will be displayed, if set to ‘objectNumber’ the object number search form will be shown. If left empty the search field will be hidden.
Default
Property
advertisementPID
Data type
page_id
Description
the page ID with an advertisement form for realty objects, leave empty to disable the link
Default
Property
advertisementParameterForObjectUid
Data type
string
Description
he GET parameter name that will contain the UID of realty object for the “advertise” link, e.g. “tx_foo[uid]”
Default
Property
advertisementExpirationInDays
Data type
integer
Description
the number of days after which an advertisement expires, set to 0 to have no expiration
Default
Property
priceOnlyIfAvailable
Data type
boolean
Description
whether the price (buying price or rent) should only be visible if an object is vacant or reserved, but not if it is sold of rented
Default
0
[tsref:plugin.tx_realty_pi1]
Setup for the list view¶
For the list view, there are some additional configuration option that can only be set using the TS setup (not with flexforms) in the form plugin.tx_realty_pi1.listView. property = value.
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
results_at_a_time
Data type
integer
Description
the number of realty objects that will be displayed per page
Default
10
Property
maxPages
Data type
integer
Description
how many pages should be displayed in the list view page navigation
Default
5
Property
descFlag
Data type
boolean
Description
the default sort order in the list view: 0 = ascending, 1 = descending
Default
1
[tsref:plugin.tx_realty_pi1.listView]
Constants for the Realty Manager front-end plug-in in plugin.tx_realty_pi1¶
You can configure the plug-in using your TS template constant in the form plugin.tx_realty_pi1. property = value.
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
cssFile
Data type
string
Description
location of the general CSS file (set as empty to not include the file)
Default
EXT:realty/pi1/tx_realty_pi1.tpl.css
Property
cssFileScreen
Data type
string
Description
location of the screen-only CSS file (leave empty to include no CSS file)
Default
EXT:realty/pi1/tx_realty_pi1_screen.css
Property
cssFilePrint
Data type
string
Description
location of the print-only CSS file (leave empty to include no CSS file)
Default
EXT:realty/pi1/tx_realty_pi1_print.css