heimrichhannot/contao-fieldpalette

FieldPalette is a contao widget like [MultiColumnWizard] (https://github.com/menatwork/MultiColumnWizard) with its own database table.

FieldPalette

FieldPalette is a contao widget similar to [MultiColumnWizard] (https://github.com/menatwork/MultiColumnWizard). Unlike MultiColumnWizard, fields are stored flatly into 'tl_fieldpalette' table and synced with its parent field., _(*1)

The fieldpalette configuration is based on Contao's Data Container Arrays., _(*2)

FieldPalette Wizard - ListView, _(*3)

FieldPalette Wizard - Edit item, _(*4)

Technical instructions

Default Setup (tl_fieldpalette table)

This example shows the setup of an fieldpalette field within tl_news by using it within an subpalette. That example is available within the module [heimrichhannot/contao-plus] (https://packagist.org/packages/heimrichhannot/contao-news_plus)., _(*5)

#/system/modules/[MyModule]/dca/tl_news.php

$dc = &$GLOBALS['TL_DCA']['tl_news'];

/**
 * Selectors
 */
$dc['palettes']['__selector__'][] = 'addVenues';

/**
 * Subpalettes
 */
$dc['subpalettes']['addVenues'] = 'venues';

/**
 * Fields
 */
$arrFields = array
(
    // venue
    'addVenues'           => array
    (
        'label'     => &$GLOBALS['TL_LANG']['tl_news']['addVenues'],
        'exclude'   => true,
        'inputType' => 'checkbox',
        'eval'      => array('submitOnChange' => true),
        'sql'       => "char(1) NOT NULL default ''",
    ),
    'venues'              => array
    (
        'label'        => &$GLOBALS['TL_LANG']['tl_news']['venues'],
        'inputType'    => 'fieldpalette',
        'foreignKey'   => 'tl_fieldpalette.id',
        'relation'     => array('type' => 'hasMany', 'load' => 'eager'),
        'sql'          => "blob NULL",
        'fieldpalette' => array
        (
            'config' => array(
                'hidePublished' => false
            ),
            'list'     => array
            (
                'label' => array
                (
                    'fields' => array('venueName', 'venueStreet', 'venuePostal', 'venueCity'),
                    'format' => '%s <span style="color:#b3b3b3;padding-left:3px">[%s, %s %s]</span>',
                ),
            ),
            'palettes' => array
            (
                'default' => 'venueName,venueStreet,venuePostal,venueCity,venueCountry,venueSingleCoords,venuePhone,venueFax,venueEmail,venueWebsite,venueText',
            ),
            'fields'   => array
            (
                'venueName'         => array
                (
                    'label'     => &$GLOBALS['TL_LANG']['tl_news']['venueName'],
                    'exclude'   => true,
                    'search'    => true,
                    'inputType' => 'text',
                    'eval'      => array('maxlength' => 255, 'tl_class' => 'long'),
                    'sql'       => "varchar(255) NOT NULL default ''",
                ),
                'venueStreet'       => array
                (
                    'label'     => &$GLOBALS['TL_LANG']['tl_news']['venueStreet'],
                    'exclude'   => true,
                    'search'    => true,
                    'inputType' => 'text',
                    'eval'      => array('maxlength' => 255, 'tl_class' => 'w50'),
                    'sql'       => "varchar(255) NOT NULL default ''",
                ),
                'venuePostal'       => array
                (
                    'label'     => &$GLOBALS['TL_LANG']['tl_news']['venuePostal'],
                    'exclude'   => true,
                    'search'    => true,
                    'inputType' => 'text',
                    'eval'      => array('maxlength' => 32, 'tl_class' => 'w50'),
                    'sql'       => "varchar(32) NOT NULL default ''",
                ),
                'venueCity'         => array
                (
                    'label'     => &$GLOBALS['TL_LANG']['tl_news']['venueCity'],
                    'exclude'   => true,
                    'filter'    => true,
                    'search'    => true,
                    'sorting'   => true,
                    'inputType' => 'text',
                    'eval'      => array('maxlength' => 255, 'tl_class' => 'w50'),
                    'sql'       => "varchar(255) NOT NULL default ''",
                ),
                'venueCountry'      => array
                (
                    'label'     => &$GLOBALS['TL_LANG']['tl_news']['venueCountry'],
                    'exclude'   => true,
                    'filter'    => true,
                    'sorting'   => true,
                    'inputType' => 'select',
                    'options'   => System::getCountries(),
                    'eval'      => array('includeBlankOption' => true, 'chosen' => true, 'tl_class' => 'w50'),
                    'sql'       => "varchar(2) NOT NULL default ''",
                ),
                'venueSingleCoords' => array
                (
                    'label'         => &$GLOBALS['TL_LANG']['tl_news']['venueSingleCoords'],
                    'exclude'       => true,
                    'search'        => true,
                    'inputType'     => 'text',
                    'eval'          => array('maxlength' => 64),
                    'sql'           => "varchar(64) NOT NULL default ''",
                    'save_callback' => array
                    (
                        array('tl_news_plus', 'generateVenueCoords'),
                    ),
                ),
                'venueText'         => array
                (
                    'label'     => &$GLOBALS['TL_LANG']['tl_news']['venueText'],
                    'exclude'   => true,
                    'search'    => true,
                    'inputType' => 'textarea',
                    'eval'      => array('rte' => 'tinyMCE', 'tl_class' => 'clr'),
                    'sql'       => "text NULL",
                ),
            ),
        ),
    ),
);

$dc['fields'] = array_merge($dc['fields'], $arrFields);

Custom table setup (e.g. tl_member_address)

In order to use Fieldpalette with your own table, create a Data Container Array that extends from $GLOBALS['TL_DCA']['tl_fieldpalette'], as the following example describes., _(*6)

<?php
/* /dca/tl_member_address.php */

\Controller::loadLanguageFile('tl_fieldpalette');
\Controller::loadDataContainer('tl_fieldpalette');
\Controller::loadDataContainer('tl_member');

$GLOBALS['TL_DCA']['tl_member_address'] = $GLOBALS['TL_DCA']['tl_fieldpalette'];
$dca                                    = &$GLOBALS['TL_DCA']['tl_member_address'];

$fields = [
    'company'     => $GLOBALS['TL_DCA']['tl_member']['fields']['company'],
    'phone'       => $GLOBALS['TL_DCA']['tl_member']['fields']['phone'],
    'fax'         => $GLOBALS['TL_DCA']['tl_member']['fields']['fax'],
    'street'      => $GLOBALS['TL_DCA']['tl_member']['fields']['street'],
    'street2'     => $GLOBALS['TL_DCA']['tl_member']['fields']['street2'],
    'postal'      => $GLOBALS['TL_DCA']['tl_member']['fields']['postal'],
    'city'        => $GLOBALS['TL_DCA']['tl_member']['fields']['city'],
    'state'       => $GLOBALS['TL_DCA']['tl_member']['fields']['state'],
    'country'     => $GLOBALS['TL_DCA']['tl_member']['fields']['country'],
    'addressText' => $GLOBALS['TL_DCA']['tl_member']['fields']['addressText'],
];

$dca['fields'] = array_merge($dca['fields'], $fields);

Than add the following fieldpalette input to your parent table (e.g. tl_member)., _(*7)

/* /dca/tl_member.php */

$dca = &$GLOBALS['TL_DCA']['tl_member'];

/**
* Adjust palettes
*/
$dca['palettes']['default'] = str_replace('country', 'country,additionalAddresses', $dca['palettes']['default']);

/**
* Adjust fields
*/
$dca['fields']['additionalAddresses'] = [
    'label'        => &$GLOBALS['TL_LANG']['tl_member']['additionalAddresses'],
    'inputType'    => 'fieldpalette',
    'foreignKey'   => 'tl_member_address.id',
    'relation'     => ['type' => 'hasMany', 'load' => 'eager'],
    'sql'          => "blob NULL",
    'fieldpalette' => [
        'config'   => [
            'hidePublished' => false,
            'table'         => 'tl_member_address',
        ],
        'list'     => [
            'label' => [
                'fields' => ['city'],
                'format' => '%s',
            ],
        ],
        'palettes' => [
            'default' => '{contact_legend},phone,fax;{address_legend},company,street,street2,postal,city,state,country,addressText',
        ],
    ],
];

Additional dca reference

All attributes from https://docs.contao.org/books/api/dca/reference.html supported, if they are implemented yet. Additional attributes will be listed here, _(*8)

Listing records

Sorting

| Key | Value | Description | --- | --- | --- viewMode | View mode (integer) | 0 Table (default)
1 List, _(*9)

Support recursive copying of fieldpalette records by copying their parent record

Simply add a oncopy_callback to the dca containing fields of type "fieldpalette":, _(*10)

$GLOBALS['TL_DCA']['tl_*'] = array
(
    'config'   => array
    (
        // ...
        'oncopy_callback' => array(
            array('HeimrichHannot\FieldPalette\FieldPalette', 'copyFieldPaletteRecords')
        ),
    )
)

Manipulate fieldpalette records about to be copied on the fly

Sometimes your fieldpalette records contain references to other fieldpalette records. When copying them, reference ids don't match the new (copied) ids anymore. You can adjust that by using the copy_callback definable in your field's dca (the field of type "fieldpalette"):, _(*11)

'inputType' => 'fieldpalette',
'eval'       => array(
    'fieldpalette' => array(
        'copy_callback' => array(
            array('tl_selection_model', 'updateOptionValuesOnCopy')
        )
    ),
    // ...
)

Example for such a callback:, _(*12)

public static function updateOptionValuesOnCopy($objFieldpalette, $intPid, $intNewId, $strTable, $arrData)
{
    $objFilter = \HeimrichHannot\FieldPalette\FieldPaletteModel::findByPk($objFieldpalette->selectionModel_questionData_options_filter);

    if ($objFilter === null)
        return;

    $objFilterNew = \HeimrichHannot\FieldPalette\FieldPaletteModel::findBy(
        array('selectionModel_questionData_filters_title=?', 'pid=?'),
        array($objFilter->selectionModel_questionData_filters_title, $intNewId)
    );

    if ($objFilterNew !== null)
    {
        $objFieldpalette->selectionModel_questionData_options_filter = $objFilterNew->id;
    }
}

Features

Widgets

Fields

tl_fieldpalette:, _(*13)

Form Callbacks

tl_fieldpalette:, _(*14)

Hooks

Restrictions

• only supports DC_Table DataContainers