lumturo-net/contao-globals-wrapper

Ein objektorientierter Wrapper für das GLOBALS Array in Contao

1.0.8 2023-01-03 10:51 UTC

Requires

• php: ^7.4|^8.0
• contao/core-bundle: ^4.9

MIT

• Christian Wederka

• wrapper
• globals
• contao
• dca

README

Eine Contao Extension die das arbeiten mit DCAs extrem erleichtert.

Entwickelt mit PHP7.3 und Contao 4.9.

Installation

Installation via composer

composer require lumturo-net/contao-globals-wrapper

TL_DCA

use LumturoNet\Globals\Dca;

$dca = Dca::new(string $namespace);

Konfigurationen

$dca->config()
    ->dataContainer('Table')
    ->cTable(['tl_tabelle'])
    ->enableVersioning()
    ->custom([
        // Eigene Konfigurationsfelder
    ])
    ->sql([
        'keys' => ['id' => 'primary']
    ]);

Vorhandene Konfiguration erweitern

$dca->config([bool $extend])

Exceptions

DcaConfigNotSetException

Wird zurückgegeben wenn $extend = true und zu erweiternde Konfiguration nicht vorhanden ist.

Listen

$dca->list()
    ->sorting()
        ->fields(['title'])
        ->mode(1)
        ->flag(11)
        ->panelLayout('search;filter')
        ->compile()
    ->label()
        ->fields(['title'])
        ->compile()
    ->globalOperations('all')
        ->label($label)
        ->href()
        ->class()
        ->attributes()
        ->compile()
    ->operations('edit')
        ->href()
        ->icon()
        ->compile()

Vorhandene Liste erweitern

$dca->list([bool $extend])

Exceptions

DcaListNotSetException

Wird zurückgegeben wenn $extend = true und die zu erweiternde Liste nicht vorhanden ist.

Felder

$dca->fields('mein_feld')
    ->text()
    ->label(string|array $label)
    ->exclude()
    ->eval()
        ->mandatory()
        ->maxlength(255)
        ->compile()
    ->relation([
        'hasOne' => 'lazy'    
    ])
    ->sql()

Vorhandenes Feld erweitern

$dca->field('singleSRC', [bool $extend])

Exceptions

DcaFieldExistsException

Wird zurückgegeben wenn $extend = false und Feld mit selben Namen im selben Namespace erstellt werden soll.

DcaFieldNotSetException

Wird zurückgegeben wenn $extend = true und das zu erweiterndes Feld nicht vorhanden ist.

Paletten & Subpaletten

$dca->palettes(string $palette)
    ->group('title_legend' [string $translations, boolean $hidden])
    ->fields([
        'mein_feld',
        'anderes_feld',
        'nochein_feld'
    ])
    ->compile()

$dca->subpalette('mein_feld')
    ->fields([
        'unterfeld_1',
        'unterfeld_2'
    ])
    ->compile();

TL_CTE

Mit Cte::new($namespace)->push(Array []) können Mappings von Inhaltselementen zu ihren respektiven Klassen definiert werden.

use LumturoNet\Globals\Cte;
use Namespace\Elements\MyCustomElement1;
use Namespace\Elements\MyCustomElement2;
use Namespace\Elements\MyCustomElement3;

Cte::new(string $namespace)->push([
    'MyCustomElement1' => MyCustomElement1::class,
    'MyCustomElement2' => MyCustomElement2::class,
    'MyCustomElement3' => MyCustomElement3::class,
]);

TL_LANG

Mit dem Language Wrapper können sowohl neue Übersetzungen erstellt, als auch aus existierenden Übersetzungen entsprechende Werte ausgelesen werden.

Übersetzung erstellen

use LumturoNet\Globals\Lang;

$lang = Lang::set($namespace);
$lang->trans('MyCustomElement1', 'Ein cooles Inhaltselement')
     ->trans('MyCustomElement2', 'Und noch eins')
     ->trans('MyCustomElement3', 'Elemente gründen Gewerkschaft');
     ->trans('sharkday', ['Haitag', 'Es ist Haitag']);

Übersetzungen holen

use LumturoNet\Globals\Lang;

Lang::set($namespace);

$dca->field('text')
    ->label(__('sharkday'));

Übersetungen aus anderem Namespace holen

use LumturoNet\Globals\Lang;

$dca->field('text')
    ->label(__('deleteConfirm', 'MSC'));

TL_MODELS

!! Ab Contao 4.9.x !!

Durch das Modelbinding ist es möglich, dass die Klassen der Models anders benannt sein können als die Tabellen in der Datenbank.

use LumturoNet\Globals\Models;

use Namespace\Models\MyModel;
use Namespace\Models\MySecondModel;

Models::bind([
    'tl_tabelle'   => MyModel:class,
    'tl_tabelle_2' => MySecondModel::class,
    ...
]);

Exceptions

BindingExistsException

Wird zurückgegeben wenn eines der übergebenen Bindings bereits existiert

BE_MOD

use LumturoNet\Globals\Backend;

Backend::new(string $namespace, string $module, [int $position = 1])->tables([
    'tl_tabelle_1',
    'tl_tabelle_2',
    ...
]);

TL_HOOKS

use LumturoNet\Globals\Hooks;
use Namespace\Hooks\AddCommentHook;

$hooks = Hooks::get()
$hooks->activateAccount(array $myCallback)
      ->addComment([AddCommentHook::class, 'addCommentHook']);

TL_CSS

use LumturoNet\Globals\Css;

Css::push([
    'path/to/file1.css',
    'path/to/file2.css',
    ...
]);

Exceptions

CssExistsException

Wird zurückgegeben wenn die hinzuzufügende CSS bereits in TL_CSS vorhanden ist