Be.tableList ViewHelper <f:be.tableList>
¶
ViewHelper which renders a record list as known from the TYPO3 list module.
Note
This feature is experimental!
Examples¶
Minimal:
<f:be.tableList tableName="fe_users" />
List of all "Website user" records stored in the configured storage PID.
Records will be editable, if the current backend user has got edit rights for the table fe_users
.
Only the title column (username) will be shown.
Context menu is active.
Full:
<f:be.tableList tableName="fe_users" fieldList="{0: 'name', 1: 'email'}"
storagePid="1"
levels="2"
filter="foo"
recordsPerPage="10"
sortField="name"
sortDescending="true"
readOnly="true"
enableClickMenu="false"
enableControlPanels="true"
clickTitleMode="info"
/>
List of "Website user" records with a text property of foo
stored on PID 1
and two levels down.
Clicking on a username will open the TYPO3 info popup for the respective record
Source code
Go to the source code of this ViewHelper: Be\TableListViewHelper.php (GitHub).
Arguments
The following arguments are available for the be.tableList ViewHelper:
-
clickTitleMode
¶ -
- Type
- string
- Default
- ''
one of "edit", "show" (only pages, tt_content), "info
-
- Type
- bool
- Default
- true
enables context menu
-
enableControlPanels
¶ -
- Type
- bool
- Default
- false
enables control panels
-
fieldList
¶ -
- Type
- array
- Default
- array ( )
list of fields to be displayed. If empty, only the title column (configured in $TCA[$tableName]['ctrl']['title']) is shown
-
filter
¶ -
- Type
- string
- Default
- ''
corresponds to the "Search String" textbox of the TYPO3 list module. If not empty, only records matching the string will be fetched
-
levels
¶ -
- Type
- int
- Default
- 0
corresponds to the level selector of the TYPO3 list module. By default only records from the current storagePid are fetched
-
readOnly
¶ -
- Type
- bool
- Default
- false
if TRUE, the edit icons won't be shown. Otherwise edit icons will be shown, if the current BE user has edit rights for the specified table!
-
recordsPerPage
¶ -
- Type
- int
- Default
- 0
amount of records to be displayed at once. Defaults to $TCA[$tableName]['interface']['maxSingleDBListItems'] or (if that's not set) to 100
-
sortDescending
¶ -
- Type
- bool
- Default
- false
if TRUE records will be sorted in descending order
-
sortField
¶ -
- Type
- string
- Default
- ''
table field to sort the results by
-
storagePid
¶ -
- Type
- int
by default, records are fetched from the storage PID configured in persistence.storagePid. With this argument, the storage PID can be overwritten
-
tableName
¶ -
- Type
- string
- Required
- 1
name of the database table