Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 1m30s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 1m28s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 1m31s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 1m36s
CI / PHP 8.3 / mysql:8.0 (pull_request) Failing after 1m45s
CI / PHP 8.4 / mysql:8.0 (pull_request) Failing after 1m44s
CI / PHP 8.3 / mysql:8.4 (pull_request) Failing after 1m35s
CI / PHP 8.4 / mysql:8.4 (pull_request) Failing after 1m38s
CI / Build-Artefakte aktuell (pull_request) Successful in 54s
- Rollen mit globalen Rechten und Rechten für einzelne Objekte (z. B. „Beiträge schreiben in Kategorie MAV-Info“); Rollen sind additiv, Zuweisungen merken sich ihre Herkunft (manuell oder später Identity-Provider-Gruppe) - Systemrolle „Administration“ ersetzt users.is_admin (Migration übernimmt bestehende Administratoren); nicht löschbar, man kann sie sich nicht selbst entziehen - Rechte je Person vorberechnet und gecacht, Versionszähler invalidiert bei Änderungen - Gate-Anbindung: registrierte Rechte entscheidet das Rechtesystem, Objektregeln die Policies; Admin-Seiten und Plugin-Ressourcen hinter passenden Rechten - Redaktion nach Kategorie: Schreiben und Veröffentlichen getrennt, Liste im Admin auf eigene Kategorien beschränkt, ohne Veröffentlichungsrecht bleibt ein Beitrag Entwurf - Zielgruppen (Rolle/Abteilung/Standort) für Kategorien und Termine als indizierte SQL-Bedingung in Listen, Detailseiten, Kacheln und .ics-Export - Admin: Rollen-Verwaltung, „Rechte prüfen“, Redaktion und Sichtbarkeit direkt an Kategorie bzw. Termin - Kern-Ressourcen explizit registriert, damit nach Updates liegengebliebene alte Dateien nicht doppelt geladen werden - docs/PLUGINS.md für Plugin-Entwicklung; Demo-Rolle „MAV“ Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
105 lines
4.1 KiB
Markdown
105 lines
4.1 KiB
Markdown
# Plugins entwickeln
|
||
|
||
Inhaus lässt sich wie WordPress über Plugins erweitern. Auch die mitgelieferten
|
||
Funktionen „Neuigkeiten“ und „Termine“ sind Plugins (`plugins-core/news`,
|
||
`plugins-core/events`) – sie sind die beste Vorlage.
|
||
|
||
## Aufbau
|
||
|
||
```
|
||
mein-plugin/
|
||
plugin.json Manifest (Pflicht)
|
||
src/Plugin.php Einstiegsklasse, erbt von App\Plugins\Plugin
|
||
src/… weiterer PHP-Code (PSR-4 unter „namespace“)
|
||
src/Filament/Resources/ Admin-Seiten (werden automatisch gefunden)
|
||
src/Filament/Pages/
|
||
database/migrations/ laufen bei Aktivierung und nach Updates
|
||
routes/web.php Routen (Middleware „web“ ist gesetzt)
|
||
resources/views/ Blade-Views, Namespace = Kürzel: view('mein-plugin::seite')
|
||
vendor/ eigene Abhängigkeiten – bitte gescoped (Strauss/PHP-Scoper)
|
||
```
|
||
|
||
### plugin.json
|
||
|
||
```json
|
||
{
|
||
"slug": "mein-plugin",
|
||
"name": "Mein Plugin",
|
||
"version": "1.0.0",
|
||
"description": "Wofür das Plugin da ist.",
|
||
"author": "Firma GmbH",
|
||
"namespace": "Firma\\MeinPlugin\\",
|
||
"class": "Firma\\MeinPlugin\\Plugin",
|
||
"requires": { "core": ">=0.3.0", "php": ">=8.3", "plugins": ["news"] }
|
||
}
|
||
```
|
||
|
||
- `slug`: Kleinbuchstaben, Ziffern, Bindestriche; eindeutig. Kürzel mitgelieferter
|
||
Plugins sind vergeben.
|
||
- `namespace`: darf nicht mit `App\` beginnen.
|
||
- `requires.core` / `requires.php`: Versionsbedingungen (`>=`, `<`, `^`, `~`, exakt).
|
||
- `requires.plugins`: Plugins, die aktiv sein müssen.
|
||
|
||
### Einstiegsklasse
|
||
|
||
```php
|
||
namespace Firma\MeinPlugin;
|
||
|
||
use App\Dashboard\Widgets;
|
||
use App\Plugins\Hooks;
|
||
use App\Plugins\Plugin as BasePlugin;
|
||
use App\Support\Abilities;
|
||
use App\Support\Navigation;
|
||
|
||
class Plugin extends BasePlugin
|
||
{
|
||
public function register(): void
|
||
{
|
||
// Menüpunkt im Portal
|
||
$this->app->make(Navigation::class)->add('mein-plugin', 'Mein Bereich', '/mein-bereich', active: 'mein-plugin.*', sort: 40);
|
||
|
||
// Rechte, die im Rollen-Formular erscheinen
|
||
$this->app->make(Abilities::class)->define('mein-plugin.manage', 'Mein Bereich verwalten', 'Mein Plugin');
|
||
}
|
||
|
||
public function boot(): void
|
||
{
|
||
Hooks::on('news.post.published', fn ($post) => /* … */ null);
|
||
Hooks::filter('navigation.items', fn (array $items) => $items);
|
||
}
|
||
|
||
public function activate(): void {} // nach „Aktivieren“ (Migrationen sind schon gelaufen)
|
||
public function deactivate(): void {} // vor „Deaktivieren“
|
||
public function uninstall(): void {} // bei „Mit Daten löschen“ (Tabellen entfernt der Kern)
|
||
}
|
||
```
|
||
|
||
## Rechte und Sichtbarkeit
|
||
|
||
- Globale Rechte: `$abilities->define('schluessel', 'Bezeichnung', 'Gruppe')`,
|
||
prüfen mit `$user->can('schluessel')`.
|
||
- Objekt-Rechte: `define(..., resource: 'mein_typ')` plus
|
||
`$abilities->resourceType('mein_typ', 'Bezeichnung', fn () => [id => 'Name'])`;
|
||
prüfen mit `$user->can('schluessel', ['mein_typ', $id])` oder einem Modell mit
|
||
`permissionResource()`.
|
||
- Zielgruppen: `App\Support\Permissions\Audiences::constrain($query, 'mein_typ', 'tabelle.id', $user)`
|
||
und im Admin-Formular `App\Filament\Components\AudienceSection::make('mein_typ')`.
|
||
- Admin-Seiten: Policies registrieren (`Gate::policy(Model::class, Policy::class)`)
|
||
bzw. `canAccess()` an Filament-Seiten.
|
||
|
||
## Installation und Betrieb
|
||
|
||
- Als ZIP unter **Administration → Plugins** hochladen (ein gemeinsamer
|
||
Ordner im Archiv ist erlaubt), dann aktivieren.
|
||
- Kunden-Plugins liegen in `plugins/` und werden von Aktualisierungen nie verändert.
|
||
- Wirft ein Plugin beim Laden einen Fehler – oder bringt es den PHP-Prozess zum
|
||
Absturz –, wird es automatisch deaktiviert; der Grund steht auf der Plugins-Seite.
|
||
- `INHAUS_DISALLOW_FILE_MODS=true` in der `.env` verbietet Hochladen und Löschen.
|
||
|
||
## Derzeit noch nicht für Kunden-Plugins
|
||
|
||
Vue-Seiten und Startseiten-Kacheln werden beim Build des Kerns mitkompiliert –
|
||
das geht nur für mitgelieferte Plugins. Für Kunden-Plugins folgt mit dem
|
||
öffentlichen Plugin-SDK (Phase 7) ein Weg über vorkompilierte ES-Module und
|
||
eine Import-Map. Bis dahin können Kunden-Plugins Blade-Seiten, Admin-Seiten,
|
||
Hooks, Rechte und Menüpunkte beitragen.
|