EXT: th_genericlist¶

Description

Set to “1” to get the SQL query-string that is executed displayed.

Default: 0

Description

See “TS Reference - View”.

Description

This name is shown in the plugin-module. Insert name of this view here.

example:

tables.detailview.beName = Detail View
tables.detailview.beName = LLL:[somepath]/locallang_db.xml:detail_view

Description

See “TS Reference - Table”.

Description

This name is shown in the plugin-module. Insert name of this view here.

example:

tables.detailview.beName = tt-content

tables.detailview.beName = LLL:[somepath]/locallang_db.xml:tt_content

Description

Page-ID where the records should be selected from.

This setting is overwritten by plugin-setting “start page”.

Description

If set to “1”: adds where-clause to select syntax: sys_language_uid= ..

Description

Path to HTML-template file taken for this view/table.

example:

[mytable].template_file = fileadmin/templates/ext/th_genericlist/tt_content.html

Description

DB-field taken for sorting.

example:

[mytable].defaultSorting = date desc

Description

Number of database records that are shown in one row (next to each other in one row).

The subpart ###ELEMENT### is repeated by the number of times configured in recordsPerRow.

Description

optional

example:

only show records not older than 2 days and 6 hours:

limit.ageDays = 2

limit.ageHours = 6

limit.dbField = tstamp

Description

Limit records per page to this number.

default: 10

Description

Only show records with maximum age of X days.

ATTENTION: “limit.dbField” must be set and of type “timestamp”.

Description

Only show records with maximum age of X hours.

ATTENTION: “limit.dbField” must be set and of type “timestamp”.

Description

DB-fieldname – must be of type “timestamp” if “ageDays” or “ageHours” is used.

Description

Limit result to a specific time range starting from this timestamp.

Only takes effect if value > 0.

example:

limit.timeRangeStart = TEXT
limit.timeRangeStart.data = GPvar:timeRangeStart

Description

Defines the time range (only if “timeRangeStart” is set and > 0).

example: only show records of a specific month:

limit.timeRangeSize.month = 1

only works if timeRangeStart is submitted via GET/POST with a timestamp value:

limit.timeRangeStart = TEXT
limit.timeRangeStart.data = GPvar:timeRangeStart

Description

Keep variables in "next"/"back" links.

example:

[mytable].keepVarsInLinks.1 = timeRangeStart

[mytable].keepVarsInLinks.2 = L

Description

optional

Select only these DB fields instead of * for better performance.

ATTENTION: make sure, all fields defined in .fieldConf are listed here!

Info: The primaryKey is added to the selectFields automatically.

default: *

example:

[mytable].selectFields = uid,pid,header,bodytext,tstamp

Description

optional

Primary Key of db-table. Will be sent along with every link (next/back). If your primary key consists of two database fields simply write them separated by “,”.

Info: the primaryKey is automatically added to the “selectFields”.

default: uid

Description

optional

Additional Where clause for select.

example:

[mytable].additionalWhere.1.value = starttime < now()
[mytable].additionalWhere.2.value = (endtime > now() OR endtime = 0)

Description

optional

Field config for each database table field.

ATTENTION: used fields must be selected by “selectFields” (see above).

example:

fieldConf.title = TEXT
fieldConf.title.field = title
fieldConf.title.typolink {
   target = _blank
   parameter.dataWrap = uploads/tx_thpressreleases/{field:file}
}

fieldConf.date = TEXT
fieldConf.date.field = tstamp
fieldConf.date.strftime = %d.%b.%Y

Description

optional

Markers replaced in every record row.

See “fieldConf” settings.

Description

optional

Markers to be used in HTML template.

See “fieldConf” settings.

Description

Name of GET/POST variablename.

example:

...&tx_a21glossary[uid]=12

detail.Parameter = tx_a21glossary|uid

Description

Added to select statement for detail view.

markers: ###Parameter###

example:

detail.additionalWhere = uid=###Parameter###

Description

Enable/Disable recalculation of offset value (pagebrowser).

Only necessary if you have a detail view of a record configured where “next” and “back” navigation to the next/previous record is possible and a list-view is shown below the detail view. The list view will always show the correct list of the selected detail-record.

See example screenshot of an image gallery in the “screenshot” chapter.

Description

Name of GET/POST variable containing the unique ID of the record to be shown (e.g. in detail view).

example: picid

Description

Usually the first value in an array is in [0]. Sometimes you don't want to start the pagebrowser with “0” but with “1” instead. Example : 1 2 [3] 4 .. 10 . If this is the case, you can correct the wrong parameter value (which is 1 instead of 0 for the first page) by setting recalculateOffset.startWith = 0;

set it to 0 ... if you start with numbering 0.

set it to 1 .. if you start with numbering 1.

Description

Number of pages to be shown left/right of current page.

example:

pagebrowser.numShowLeftRight = 2

output: 1 2 [3] 4 5

pagebrowser.numShowLeftRight = 3

output: 1 2 3 [4] 5 6 7

Description

Start numbering with 0 or 1? Only for FE-output – the offset parameter will still start with “0” if startWith is set to 1.

example:

pageBrowser.startWith = 1

output: 1 2 [3] 4 5

pageBrowser.startWith = 1

output: 0 1 [2] 3 4

Description

Show "first" and "last" page-link within pagination.

example:

pageBrowser.showFirstLast = 1

output: 1 ... 4 [5] 6 ... 10

pageBrowser.showFirstLast = 0

output: ... 4 [5] 6 ...

Description

Separator between first and last page.

Only used if showFirstLast = 1

example:

pageBrowser.firstLastSeparator = ...

Description

Separator between pages.

example:

pageBrowser.separator =  - 

Description

Wrap around not selected pages.

example:

pageBrowser.pageWrap = <b>|</b>

Description

Wrap around selected/current page.

example:

pageBrowser.pageWrapSelected = <b><i>[|]</b></i>

Description

0 ... add SQL-perms-clause to check FE-access rights (based on fe_groups level).

Info: if the fe_groups are not stored in the DB-field “fe_group”, you can configure the other fieldname (see below).

Description

Only necessary if checkAccessRights =1 and the FE-groups are stored in a different field than “fe_group”.

Description

Activate this setting if you want to display a list of files from a directory or a combination between DB-records and files (like DAM or KB-YAG).

Description

See “TS Reference – File Mode”.

Description

Calculate the sums of the given fields.

Attention:

• file mode (db/mixed/file) NOT activated (=DB-mode): sum is done via SQL query in DBso make sure the given field names exist in the DB!markers:###sum_[fieldname]### ... sum calculated via DB query
• file mode (db/mixed/file) ACTIVATED (=file-mode): sum is done via PHP loop of all affected records (see table “File Mode prefilled values/markers” below for available attriutes you might sum)markers:- ###total_sum_[fieldname]### ... sum calculated of ALL affected records/files (not only the one shown on the current page)- ###page_sum_[fieldname]### ... sum calculated of records/files shown on current page (if pagination is used)

formating a calculated sum:

markers.sum_[fieldname] = TEXT
markers.sum_[fieldname].field = [fieldname]

or

markers.total_sum_[fieldname] = TEXT
markers.total_sum_[fieldname].field = [fieldname]

or

markers.page_sum_[fieldname] = TEXT
markers.page_sum_[fieldname].field = [fieldname]

Info:

With the help of this setting, you can display the total size of all shown files listed.

Description

Directory the files get selected from. This setting is overwritten by the directory selected in the plugin-element.

path is extended by GP:directory:

[directory][GP:directory]

all "../" are cut of from GP:directory which makes sure, that only deeper dirs are available to the user - “../../typo3conf/” won't work.

example:

directory = fileadmin/beispielbilder/

Description

1 ... read and list files recursive from given directory.

0 ... read and list files only from the given directory.

example:

recursive = TEXT
recursive.value = 1

Description

Limit the read/listed files by filetype(s).

example:

allowedFileTypes = TEXT
allowedFileTypes.value = jpg,gif,png

Description

Default-values for file-record. Find a list of possible default- settings in the table below (“File Mode prefilled values/markers”).

Info: The fields can be used for sorting.

example:

List is sorted by "title" which comes from the correlating DB-record (DAM,KB_YAG,..).

If no db-record is found (or the "title" field is empty) the "title" field is filled with the filename.

defaultValue.title = TEXT
defaultValue.title.field = filename

Description

If you define a single-view for one file, you have to tell the system which file should be shown. This is done by adding the unique-ID of the file to the “detail”-link. In case you are using the fileMode = file setting, you have to use the “arrayID” for this. This unique-ID can be used and accessed as normal marker: ###arrayID### in your HTML- template or in TS via {field:arrayID} when building the detail-link.

See section “FileMode prefilled values/markers” for further information.

example (unique-ID is given in variable “picid”):

displaySingle = TEXT
displaySingle.value = {GPvar:picid}
displaySingle.insertData = 1

Description

Mapping-mechanism between files and records. Only needed in mode “db” or “mixed”.

Makes it possible to find the correlating DB-record (e.g. DAM) to the selected files.

Description

Database key(s) fieldnames. If the DB-key consists of two DB-fields, simply type them in separated by “,”.

example DAM:

file2db.dbField = file_name,file_path

example KB_YAG:

file2db.dbField = md5hash

Description

For each of the defined DB-keys (defined in “file2db.dbField”) you need to specify a user-function that is called to calculate the key.

For DAM or KB_YAG the user functions come along with th_genericlist.

example DAM:

file2db.key.file_name = USER
file2db.key.file_name.userFunc = user_genericlistFile2DBFunctions->user_DAMFileName
file2db.key.file_path = USER
file2db.key.file_path.userFunc = user_genericlistFile2DBFunctions->user_DAMFilePath

example KB_YAG:

file2db.key.md5hash = USER
file2db.key.md5hash.userFunc = user_genericlistFile2DBFunctions->user_kbyagFile

Description

The following methods are implemented:

• =
• !=
• <
• >
• like (PHP stristri method used)
• ereg
• eregi

example:

fileFilter.10.check = =
fileFilter.20.check = like

Description

Record-field that will be used for comparison. See table “File Mode prefilled values/markers” table below for a list of predefined fields that can be used for file-filtering.

You could also use a field of the correlating database-record e.g. “tx_dam” record if you have configured the fileMode to “db”.

example:

fileFilter.10.field = size
fileFilter.20.field = filename

Description

Value of “.field” is compared with the value of the given TS-TEXT- object.

example:

see complete examples below.

fileFilter.10.compareValue = TEXT

fileFilter.10.compareValue.value = 67000

fileFilter.20.compareValue = TEXT

fileFilter.20.compareValue.value = jeff

Description

Number of all found records.

Description

Pagebrowser if configured in TS:

plugin.tx_thgenericlist_pi1.tables.[view].[database table name].pageBrowser