sortedMenus/README.md

69 regels
2.7 KiB
Markdown

2021-12-11 13:15:21 +01:00
[![deutsche Version](https://logos.oxidmodule.com/de2_xs.svg)](README.md)
[![english version](https://logos.oxidmodule.com/en2_xs.svg)](README.en.md)
2021-12-13 14:30:12 +01:00
# D³ Sortierbare Admin Menüs für OXID eShop
2021-12-11 13:15:21 +01:00
2021-12-12 00:01:57 +01:00
Das Modul bietet die Möglichkeit, die Adminmenüs in eine gewünschte Reihenfolge zu bringen.
2021-12-11 13:15:21 +01:00
2021-12-12 00:01:57 +01:00
Sortiert werden kann das Seitenmenü auf der linken Seite sowie die Tabs in jedem einzelnen Bereich.
Die Aktionslinks der Bereiche werden zwar ebenfalls über die menu.xml konfiguriert, werden aber im Template in fester Reihenfolge geladen.
2021-12-11 13:15:21 +01:00
Die Einträge können ausschließlich in der aktuell ausgewählten Ebene verschoben werden.
2021-12-12 00:01:57 +01:00
## Installation
Auf der Konsole im Shoproot (oberhalb von source und vendor) folgenden Befehl ausführen:
```bash
php composer require d3/sortedmenus
```
Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
## Konfiguration
2021-12-12 00:01:57 +01:00
Die Konfiguration erfolgt der Einfachheit halber direkt in der Konfigurationsdatei des Shops (`config.inc.php`).
2021-12-11 13:15:21 +01:00
Fügen Sie beispielhaft folgende Konfiguration ein:
```php
$this->d3MenuSorting = [
// mainmenu
2021-12-12 00:01:57 +01:00
'move articles and order panels in front' => [
'xpath' => "//OX/*[@id='NAVIGATION_ESHOPADMIN']/MAINMENU",
'order' => ['mxmanageprod', 'mxorders']
],
2021-12-12 00:01:57 +01:00
// submenu
'move vouchers in shop settings to front' => [
'xpath' => "//OX/*[@id='NAVIGATION_ESHOPADMIN']/*[@id='mxshopsett']/SUBMENU",
'order' => ['mxvouchers']
],
2021-12-12 00:01:57 +01:00
// tabs
'show category picture tab as first' => [
'xpath' => "//OX/*[@id='NAVIGATION_ESHOPADMIN']/*[@id='mxmanageprod']/*[@id='mxcategories']/TAB",
'order' => ['tbclcategory_pictures']
]
];
```
2021-12-13 00:19:03 +01:00
Jeder Eintrage definiert mit der [XPath](https://de.wikipedia.org/wiki/XPath)-Angabe die sortierbaren Elemente im gesamten Menübaum. Der XPath kann in der jeweiligen menu.xml ermittelt werden. Beschreiben Sie den XPath möglichst genau (idealerweise anhand der eindeutigen Element-IDs), da sonst die zu verschiebenden Elemente im falschen Bereich landen könnten.
Im order-Eintrag stehen die IDs der enthaltenen Einträge in der richtigen Reihenfolge. Nicht enthaltene Einträge werden in der bisherigen Sortierung automatisch an das Ende der sortierten Liste angehängt.
2021-12-12 00:01:57 +01:00
Nach dem Ändern der Sortiereinträge muss der tmp-Ordner geleert werden.
2021-12-11 13:15:21 +01:00
## Changelog
Siehe [CHANGELOG](CHANGELOG.md) für weitere Informationen.
2021-12-12 00:01:57 +01:00
## Lizenz dieser Software (d3/sortedmenus)
2021-12-11 13:15:21 +01:00
(Stand: 11.12.2021)
```
Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
Diese Software wird unter der GNU GENERAL PUBLIC LICENSE Version 3 vertrieben.
```
Die vollständigen Copyright- und Lizenzinformationen entnehmen Sie bitte der [LICENSE](LICENSE.md)-Datei, die mit diesem Quellcode verteilt wurde.