Download the PHP package xima/xima-typo3-recordlist without Composer
On this page you can find all versions of the php package xima/xima-typo3-recordlist. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xima/xima-typo3-recordlist
More information about xima/xima-typo3-recordlist
Files in xima/xima-typo3-recordlist
Package xima-typo3-recordlist
Short Description This package provides an abstract class for creating TYPO3 backend modules that display a feature-rich and easy-to-customize list view of records. It also includes built-in simplified TYPO3 workspace integration.
License GPL-2.0-or-later
Homepage https://www.xima.de
Informations about the package xima-typo3-recordlist
This package allows you to quickly create backend modules for advanced record listing.
Optional workspaces integration: More simple workflow for requesting and approving changes.
Features
- List records from any table
- Filter records by any field
- Sort records by any field
- Configurable + sortable columns
- Inline editing support
Install
Usage
Start by creating a new backend controller in your TYPO3 extension.
1. Extend new controller from AbstractBackendController
The controller implements the BackendControllerInterface
which requires you to add the
methods getTableName()
and getRecordPid()
:
2. Register Backend module
Add a new backend module via
the Backend module API.
You're free to adjust the settings as you like, the only important setting is the controllerActions
, which needs to point to your newly
created controller:
3. Configure template path
To use the template and partials, you need to add the template path to your sitepackge with TSconfig:
That's it. You can find working examples in the Example directory.
Customization
Template
To a customize the template, partials or sections, you need to configure an additional template path in your TSconfig:
Inside your TemplateOverrides folder, create a templates
directory, copy the Default.html file
into it and adjust it to your needs.
In case you have multiple backend modules, you can adjust the template name by overriding the TEMPLATE_NAME
constant in your controller:
Data
Each record item can be modified using the modifyRecord
method:
Add new filter options
Default columns
To change the default columns, you can override the modifyTableConfiguration
method:
Custom Columns
To add custom columns, you can override the modifyTableConfiguration
method:
Development and Contribution
For easy development, you can use the provided ddev setup. Simply run ddev start
and open the URL in your browser.
After a composer install
, you can run ddev init-typo3
to setup a TYPO3 installation with example data. Login with admin
/ Passw0rd!
and editor
/ Passw0rd!
.