https://github.com/heimrichhannot/contao-be_explanation-bundle

This bundle offers a simple backend explanation form field (inputType).
https://github.com/heimrichhannot/contao-be_explanation-bundle

Last synced: about 1 month ago
JSON representation

This bundle offers a simple backend explanation form field (inputType).

• Host: GitHub
• URL: https://github.com/heimrichhannot/contao-be_explanation-bundle
• Owner: heimrichhannot
• Created: 2018-03-06T13:18:53.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T08:19:32.000Z (10 months ago)
• Last Synced: 2024-11-15T20:29:04.579Z (about 1 month ago)
• Language: PHP
• Homepage:
• Size: 171 KB
• Stars: 0
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
![](https://img.shields.io/packagist/v/heimrichhannot/contao-be_explanation-bundle.svg)

![](https://img.shields.io/packagist/dt/heimrichhannot/contao-be_explanation-bundle.svg)

# Backend Explanation Bundle

This bundle offers a simple backend explanation form field (inputType).

## Technical instructions

Just add the field to some of your data container arrays as follows:

```php

use AppBundle\EventListener\Dca\TableListener;

$GLOBALS['TL_DCA']['tl_table']['fields']['myExplanation'] = [

    'inputType' => 'explanation',

    'eval'      => [

        'text'          => &$GLOBALS['TL_LANG']['tl_table']['explanation']['myExplanation'], // this is a string, not an array

        'text_callback' => [TableListener::class, 'onTextCallback'], // a callback to dynamical generate text. Can also be a callable.

        'class'         => 'tl_info', // all contao message css classes are possible

        'tl_class'      => 'w50 long',

        'collapsible'   => true // If text is to long, if will be collapsed

    ]

];

```

#### Text Callback

The callback gets the `$attributes` array from the widget constructor as parameter, which containers the widget config and the current DataContainer.

Example: 

```php

public function textCallback(array $attributes): string {

    $dc = $attributes["dataContainer"];

    $text = $attributes["text"];

    return "My new text";

}

```