heimrichhannot / contao-be_explanation-bundle
This bundle offers a simple backend explanation form field (inputType).
Installs: 4 439
Dependents: 8
Suggesters: 0
Security: 0
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 0
Type:contao-bundle
Requires
- php: ^7.1|^8.0
- contao/core-bundle: ^4.4
Requires (Dev)
- contao/manager-plugin: ^2.0
- contao/test-case: ^1.1
- friendsofphp/php-cs-fixer: ^2.2
- php-http/guzzle6-adapter: ^1.1
- php-http/message-factory: ^1.0.2
- phpunit/php-token-stream: ^1.4|^2.0|^3.0
- phpunit/phpunit: ^6.5
- phpunit/phpunit-mock-objects: ^4.0|^5.0
- satooshi/php-coveralls: ^2.0
- symfony/phpunit-bridge: ^3.2
Conflicts
- contao/core: *
- contao/manager-plugin: <2.0 || >=3.0
Replaces
README
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:
$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' => [\AppBundle\EventListener\Dca\TableListener::class, 'onTextCallback'], // a callback to dynamical generate text '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 constructar as parameter, which containers the widget config and the current DataContainer.
Example:
public function textCallback(array $attributes): string { $dc = $attributes["dataContainer"]; $text = $attributes["text"]; return "My new text"; }