README

A bundle to add more flexibility to the contao backend dashboard.

Features

replaces the contao dashboard with a more customizable one
customize the dashboard versions list to your need, like changing the visibility of user and tables or add custom columns

Usage

Install

Install with composer or contao manager

 composer require heimrichhannot/contao-advanced-dashboard-bundle

Update database

Customize dashboard versions list.

A main feature of this bundle is the customization of the versions log in the contao dashboard. After installing this bundle, you'll find, that there is no difference to the original contao dashboard, as the default configurations are the same. But now you can create configurations thats specify which logs are displayed to a user filtered by user or table. You can also specify which columns are displayed.

Setup a versions_right configuration in your projekt config, typically config/config.yml

huh_advanced_dashboard:
  versions_rights:
    # All user changes visible for table tl_news.
    editor_news:
      user_access_level: all
      columns:
        - date
        - user
        - table
        - id
        - description
        - version
        - actions
      tables:
        - tl_news

Clear your cache if not in dev mode
Apply the created right in user or user group settings to a user or user group.

Additional notes:

If no configuration is defined, or a user has no configuration added, a default configuration is used. You can customize the default configuration by creating a configuation with the name default.
Restriction are not applied to admin user.

Add custom content/sections to backend template

The dashboard template comes with this bundle contains some customization options. You can add custom section or content and disable existing sections.

Following postions are available (as template variables):

positionTop
positionBeforeShortcuts
positionBeforeVersions
positonBottom

Skip existing sections by settings these variables to false (available as template variables:

showMessages
showShortcuts
showVersions

To set these template variables, you can use the contao parseTemplate hook or the BeforeParseTwigTemplateEvent and BeforeRenderTwigTemplateEvent events of Twig Support Bundle. For the twig support bundle events, the template name is be_advanced_dashboard.

If you use the parseTemplate hook to add your custom content, keep in mind it should have a priority higher than -10!

/**
 * @Hook("parseTemplate")
 */
class ParseTemplateListener 
{
    public function __invoke(Template $template): void 
    {
        if ('be_welcome' === $template->getName()) {
            $template->positionTop = '<div id="tl_custom_welcome">
            <h2 style="margin-top: 18px;">Welcome</h2>
            <p style="margin-top: 6px;">This could be your message!</p>
        </div>';
            $template->showShortcuts = false;
        }
    }
}

Developers

Add new columns or change the appearance of existing columns

There are two events to add custom columns to the versions log or change existing columns.

Maybe you have an extension that expands the version table and adds more information to a version database log entry and want to output that information in the dashboard version log. We recommend creating a Subscriber for VersionListDatabaseColumnsEvent and VersionListTableColumnsEvent.

use HeimrichHannot\AdvancedDashboardBundle\Event\VersionListDatabaseColumnsEvent;
use HeimrichHannot\AdvancedDashboardBundle\Event\VersionListTableColumnsEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class AdvancedDashboardEventSubscriber implements EventSubscriberInterface {
    
    public static function getSubscribedEvents(){
        return [
            VersionListDatabaseColumnsEvent::class => 'onVersionListDatabaseColumnsEvent',
            VersionListTableColumnsEvent::class => 'onVersionListTableColumnsEvent',
        ];
    }
    
    // Add additional database columns that should be fetched (or modify existing values)
    public function onVersionListDatabaseColumnsEvent(VersionListDatabaseColumnsEvent $event) {
        $event->addColumn('custom_information');
    }
    
    // Add additional columns to the version list.
    // `label` is the table column headline
    // `renderCallback` is the method that renders the content of the current column.
    //                  Gets the database values for the current row as parameter.
    public function onVersionListTableColumnsEvent(VersionListTableColumnsEvent $event) {
        $event->setColumn('custom_colum', [
            'label' => 'Custom information', 
            'renderCallback' => function(array $version) {
                return $version['custom_information'] ?: 'No custom information';
            }
         ]);
    }
}

Configuration reference

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

    # Configure user rights for version list. Can be selected in the user and user group settings.
    versions_rights:

        # Prototype: The title of the configuration. Should be a unique alias/name containing just 'a-z0-9-_' like 'all_users','editor_news'.
        name:

            # Allowed version table columns. Empty means all columns are allowed.
            columns:

                # Defaults:
                - date
                - user
                - table
                - id
                - description
                - version
                - actions

            # Allowed database tables. Empty means all tables are allowed.
            tables:               []

            # Access rights for other users version logs.
            user_access_level:    [self] # One of "all"; "self"

heimrichhannot / contao-advanced-dashboard-bundle

Maintainers

Details