Display settings

Use full width
Color scheme of code blocks:
dark light
Make settings permanent

TypoScript Configuration¶

The TypoScript configuration properties for the extension can be found in plugin.tx_pxadealers.settings.

Root level¶

TypoScript properties defined in plugin.tx_pxadealers.settings, e.g. plugin.tx_pxadealers.settings.categoryPid.

categoryPid¶

Property: categoryPid
Data type: t3tsref:data-type-integer
Description: The page ID where category records are stored.

cssFile¶

Property: cssFile
Data type: t3tsref:data-type-file
Default: EXT:pxa_dealers/Resources/Public/Css/pxa_dealers.css
Description: File to the CSS file. Included in the Map.html template.

Tip

Setting this property to an empty string or clearing it with the TypoScript > operand will not lead to an error. Instead, no file will be included.

markerClustererFile¶

Property: markerClustererFile
Data type: t3tsref:data-type-file
Default: EXT:pxa_dealers/Resources/Public/JavaScript/markerclusterer.js
Description: File to the JavaScript file handling marker clusters. Included in the Map.html template.

Tip

Setting this property to an empty string or clearing it with the TypoScript > operand will not lead to an error. Instead, no file will be included.

pluginFile¶

Property: pluginFile
Data type: t3tsref:data-type-file
Default: EXT:pxa_dealers/Resources/Public/JavaScript/pxa_dealers_plugin.js
Description: File to the JavaScript file handling the main plugin functionality. Included in the Map.html template.

Tip

Setting this property to an empty string or clearing it with the TypoScript > operand will not lead to an error. Instead, no file will be included.

dealersFile¶

Property: dealersFile
Data type: t3tsref:data-type-file
Default: EXT:pxa_dealers/Resources/Public/JavaScript/pxa_dealers_plugin.js
Description: File to the JavaScript file handling the dealer functionality. Included in the Map.html template.

Tip

Setting this property to an empty string or clearing it with the TypoScript > operand will not lead to an error. Instead, no file will be included.

searchFile¶

Property: searchFile
Data type: t3tsref:data-type-file
Default: EXT:pxa_dealers/Resources/Public/JavaScript/pxa_dealers_search.js
Description: File to the JavaScript file handling search functionality. Included in the Form.html template.

Tip

Setting this property to an empty string or clearing it with the TypoScript > operand will not lead to an error. Instead, no file will be included.

awesompleteCssFile¶

Property: awesompleteCssFile
Data type: t3tsref:data-type-file
Default: EXT:pxa_dealers/Resources/Public/Css/awesomplete.css
Description: CSS file for the Awesomeplete autocomplete plugin. Included in the Form.html template.

Tip

Setting this property to an empty string or clearing it with the TypoScript > operand will not lead to an error. Instead, no file will be included.

awesompleteJavaScriptFile¶

Property: awesompleteJavaScriptFile
Data type: t3tsref:data-type-file
Default: EXT:pxa_dealers/Resources/Public/JavaScript/awesomplete.min.js
Description: JavaScript file for the Awesomeplete autocomplete plugin. Included in the Form.html template.

Tip

Setting this property to an empty string or clearing it with the TypoScript > operand will not lead to an error. Instead, no file will be included.

Map¶

TypoScript properties used to configure the map display can be found in plugin.tx_pxadealers.settings.map.*.

stylesJSON¶

Property

stylesJSON

Data type

JSON string

Description

Custom colors and styles for the Google Map display. If set, this property must be a JSON string, as defined in Google Map's API.

stylesJSON = [ { elementType: "geometry", stylers: [{ color: "#ebe3cd" }] } ]

name¶

Property: name
Data type: tsref:data-type-string
Description: The display name for the map.

zoomOnShow¶

Property: zoomOnShow
Data type: tsref:data-type-integer
Default: 14
Description: The default zoom level for the map. More about zoom levels

markerClusterer.imagePath¶

Property: markerClusterer.imagePath
Data type: tsref:data-type-integer
Default: /typo3conf/ext/pxa_dealers/Resources/Public/Images/markerClusterer/m
Description: A path prefix for marker cluster icons. More about marker clustering

markerTypes¶

Property: markerTypes
Data type: array
Default: default = /typo3conf/ext/pxa_dealers/Resources/Public/Icons/map_marker_icon_blue.png
Description: An array of marker icons for custom markers. default should always be defined. More about custom markers

googleJavascriptApiKey¶

Property: googleJavascriptApiKey
Data type: tsref:data-type-string
Description: A Google API key for frontend use only.

Warning

googleJavascriptApiKey and googleServerApiKey must be unique. Do not use the same code for both. The two keys should have different permissions. Calls made using the server side should not be possible with the JavaScript (frontend) key.

googleServerApiKey¶

Property: googleServerApiKey
Data type: tsref:data-type-string
Description: A Google API key for backend use only.

Warning

googleJavascriptApiKey and googleServerApiKey must be unique. Do not use the same code for both. The two keys should have different permissions. Calls made using the server side should not be possible with the JavaScript (frontend) key.

scrollFix¶

Property: scrollFix
Data type: tsref:data-type-integer
Default: 0
Description: The number of extra pixels to scroll down when clicking Show on map. This is useful if you are using a sticky header menu that covers apart of the top of the page.

scrollFixMobile¶

Property: scrollFixMobile
Data type: tsref:data-type-integer
Default: 0
Description: The number of extra pixels to scroll down when clicking Show on map on a mobile device (small screen sizes with a width 990px and less). This is useful if you are using a sticky header menu that covers apart of the top of the page.

scrollFixMobile¶

Property: hideIfEmpty
Data type: tsref:data-type-boolean
Default: false
Description: If true, the map is hidden if there are no visible markers.

Demand¶

TypoScript properties used to configure search demand settings can be found in. plugin.tx_pxadealers.settings.demand.*. These settings are also available in the plugin flexForm, and configurations made there take presedence.

orderBy¶

Property

orderBy

Data type

tsref:data-type-string

Default

crdate

Description

Order dealers records by this field. Recommended fields to use for this field:

crdate: Creation date
name: The dealer's name
tstamp: Last updated date

orderDirection¶

Property

orderDirection

Data type

tsref:data-type-string

Default

asc

Description

Order direction for dealer records. Available options:

asc: Ascending
desc: Descending

countries¶

Property: countries
Data type: tsref:data-type-list
Description: Limit to these countries. Comma-separated list of country UIDs from the static_countries table.

categories¶

Property: categories
Data type: tsref:data-type-list
Description: Limit to these categories. Comma-separated list of category UIDs.

Search¶

TypoScript properties used to configure the dealers search can be found in plugin.tx_pxadealers.settings.search.*.

searchFields¶

Property

searchFields

Data type

tsref:data-type-list

Default

name, zipcode, city

Description

Database fields to include in free text search.

Typical acceptable search fields

Dealer record
- address
- city
- description
- email
- link
- name
- phone
- website
- zipcode
Dealer country record
- country.cn_iso_2: 2-character ISO code
- country.cn_iso_3: 3-character ISO code
- country.cn_iso_nr: ISO country number
- country.cn_official_name_en: The official country name in English, e.g. "Kingdom of Sweden".
- country.cn_official_name_local: The official country name in the country's local language(s), e.g. "Konungariket Sverige".
- country.cn_short_en: The country's short (common) name in English, e.g. "Sweden".
- country.cn_short_local: The country's short (common) name in the country's local language(s), e.g. "Sverige".

secondarySearchFields¶

Property

secondarySearchFields

Data type

tsref:data-type-list

Default

country.shortNameLocal, country.shortNameEn

Description

Search fields used if there are no results from an initial search using searchFields. Performing a secodn search using new fields årevents lots of results, e.g. if the country name is part of the search phrase. These fields are typically fields with potentially broad search matches.

See searchFields for a list of typical fields available.

searchInRadius¶

Property: searchInRadius
Data type: tsref:data-type-boolean
Default: false
Description: If enabled, search is limited to results within a radius around the geographic coordinates of the location provided by the user. See also radius.

radius¶

Property: radius
Data type: tsref:data-type-integer
Default: 50
Description: The search radius in kilometers. Used when geographic coordinates are provided or the coordinates of the place name given in the search string.

searchClosest¶

Property: searchClosest
Data type: tsref:data-type-boolean
Default: false
Description: When true, the plugin will try to acquire the user's coordinates through the browser.

zipcodeInexactness¶

Property

zipcodeInexactness

Data type

tsref:data-type-integer

Default

2

Description

Search for zip codes in database with X number of digits flexibility. E.g. searching for zipcode 12345 with zipcodeInexactness = 3 will search within 12XXX, i.e. any zipcode between 12000 and 12999.

This feature presumes that zip codes are similar within the same geographic region. Swedish zip codes 85000-85999 belong to the area around Sundsvall. We can therefore assume that a users that search for "85229" will be close to a dealer with zip code "85350".

splitSearchString¶

Property

splitSearchString

Data type

tsref:data-type-boolean

Default

true

Description

If true, the search string is split and each word is matched agains the contents of each search field. The string is split using splitSearchStringRegex.

Example: Let's say searchFields is set to name, address. Searching for "elephant zebra" will return a dealer the name "Big Elephants, Inc." and a dealer with the address "9 Zebra Lane" because they both have "elephant" or "zebra" in the defined search fields.

Setting this property to false will only return dealers with exact matches, e.g. a dealer with a name like "Lion Elephant Zebra Foods, Inc" because the name contains the exact string "elephant zebra".

splitSearchStringRegex¶

Property: splitSearchStringRegex
Data type: Regular expression
Default: /[s,-]+/
Description: A regular expression search pattern matching all characters that should be used to split a search string (if splitSearchString is enabled).

joinSearchStringRegex¶

Property

joinSearchStringRegex

Data type

Regular expression

Default

/^d+$/

Description

Adjacent search strings matching this pattern are re-joined if splitSearchString is enabled.

The default pattern matches numbers, which helps with zip code search with numbers only. Some countries prefer to split zip codes, e.g. using spaces. When we split the search string, a zip code written as "123 45" will lead to a search for text containing "123" or "45", which will lead to less exact matches for zip codes than if the code was written "12345".

This pattern allows us to merge strings we presume are formatted zip codes, such as "123" and "45", into "12345".

enableAutocomplete¶

Property: enableAutocomplete
Data type: tsref:data-type-boolean
Default: true
Description: Enables the autocomplete dropdown menu in the search results.

limitToCountries¶

Property

limitToCountries

Data type

tsref:data-type-list (2-char ISO country codes <https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>)

Max items

5

Description

Limit the autocomplete to results within these countries. Google's Place Autocomplete API supports maximum 5 countries.

Example: Ensure that the autocomplete only returns autocomplete suggestions for places within Denmark, Norway, and Sweden. This means the user searching for "Oslo" will not see suggestions for "Oslo, Minnesota, USA".

limitToCountries = dk, no, se

searchResultPage¶

Property: searchResultPage
Data type: tsref:data-type-page-id
Description: The ID of the page to display the search results on.

Dealers' list¶

TypoScript properties used to configure the dealer listing can be found in plugin.tx_pxadealers.settings.dealersList.*.

noImagePath¶

Property: noImagePath
Data type: tsref:data-type-path
Default: EXT:pxa_dealers/Resources/Public/Images/noimage.png
Description: Path to the image that is displayed if a dealer record doesn't have any image defined and showDefaultImageIfNoLogo is false.

showLogo¶

Property: showLogo
Data type: tsref:data-type-boolean
Default: true
Description: If true, display a dealer's logo in the list.

showDefaultImageIfNoLogo¶

Property: showDefaultImageIfNoLogo
Data type: tsref:data-type-boolean
Default: true
Description: If true, display the image defined in noImagePath if the dealer record has no logo image defined.

imageWidth¶

Property: imageWidth
Data type: tsref:data-type-pixels
Default: 150m
Description: The width of images in the list.

imageHeight¶

Property: imageHeight
Data type: tsref:data-type-pixels
Default: 150m
Description: The height of images in the list.