heimrichhannot/contao-archive-palettes-bundle

This bundle offers functionality for selecting custom palettes depending on the parent archive for the backend of the Contao CMS.

1.2.0 2023-07-17 14:54 UTC

Requires

• php: ^7.4 || ^8.0
• contao/core-bundle: ^4.9
• heimrichhannot/contao-utils-bundle: ^2.164
• symfony/dependency-injection: ^4.4 || ^5.0
• symfony/polyfill-php80: ^1.26

LGPL-3.0-or-later

README

This bundle offers functionality for selecting custom palettes depending on the parent archive for the backend of the Contao CMS.

Features

• add custom palettes to your DCA files
• select them in the parent archive

Setup

1. Install via composer: composer require heimrichhannot/contao-archive-palettes-bundle.

2. Adjust your project configuration

   Example for tl_news:

   # config/config.yml
   huh_archive_palettes:
     tables:
        tl_news: # The table where the custom palettes should be applied
           parent: "tl_news_archive" # The archive table where custom palette should be selected
           palette_parent: "comments_legend" # A legend or a field after which the palette selector should be inserted in the parent table palette

3. Clear cache and update your database

Configuration

Configuration via yaml

# Default configuration for extension with alias: "huh_archive_palettes"
huh_archive_palettes:

   # The tables that should be extended with the archive palette.
   tables:               # Example: tl_news

      # Prototype
      name:

         # The parent (archive) table.
         parent:               ~ # Required, Example: tl_news_archive

         # A field or a parent where the should be added after.
         palette_parent:       ~ # Required

Configuration via PHP

1. Open the DCA file you'd like to extend. As an example we use tl_news. It should be located in your project bundle.
2. Create the custom field palettes as you would normally:

   // ...
   $dca['palettes']['custom_palette1'] = '{general_legend},field1,field2;';
   $dca['palettes']['custom_palette2'] = '{general_legend},field3,field4;';

3. Paste the following code at the end of the DCA file in order to insert the palette manipulation logic:

   System::getContainer()->get(\HeimrichHannot\ArchivePalettesBundle\Manager\ArchivePalettesManager::class)->addArchivePalettesSupportForChild(
       'tl_news', 'tl_news_archive'
   );

4. Open the parent DCA file, i.e. the archive DCA file. In the case of tl_news this would be tl_news_archive.
5. Paste the following code at the end of the DCA file in order to insert the palette manipulation logic:

   System::getContainer()->get(\HeimrichHannot\ArchivePalettesBundle\Manager\ArchivePalettesManager::class)->addArchivePalettesSupportForArchive(
       'tl_news', 'tl_news_archive'
   );

6. Add the following code at the end of the file in order to add the palette selector field (the field as been added in the step before):

   // ...
   $dca['palettes']['default'] = $dca['palettes']['default'] . ';{archive_palettes_legend},addArchivePalette;';

7. Clear the project cache and update the database in order to add the needed fields.
8. Open archive's configuration (editheader operation in most cases) and set the custom palette to your needs.