Namenskonventionen
Das Modul erzwingt einige einfache Namensregeln, damit Machines, Zustände und Aktionen konsistent bleiben und zuverlässig mit dem Rest von Shopware zusammenarbeiten.
Technischer Name der State Machine
Abschnitt betitelt „Technischer Name der State Machine“Format: entity.state — ein Entitätsname in Kleinbuchstaben, ein Punkt, dann state.
- Nur Kleinbuchstaben, Zahlen und Unterstriche, mit einem einzigen Punkt, der die beiden Teile trennt.
- Beispiele:
order.state,subscription.state,return_request.state.
Dies ist die Kennung, über die Shopware und andere Plugins die Machine finden, daher muss sie exakt sein. Bei Kern-State-Machines ist sie gesperrt und kann nicht geändert werden.
Der lesbare Name hat keine Formatbeschränkungen — verwenden Sie, was für Ihr Team am klarsten ist.
Technischer Name des Zustands
Abschnitt betitelt „Technischer Name des Zustands“- Muss mit einem Kleinbuchstaben beginnen.
- Darf nur Kleinbuchstaben, Zahlen und Unterstriche enthalten (
snake_case). - Beispiele:
open,in_progress,partially_paid.
Technische Namen müssen innerhalb einer Machine eindeutig sein; die Wiederverwendung eines Namens wird mit einem Inline-Fehler blockiert. Der Name des Zustands ist frei wählbar.
Aktionsname des Übergangs
Abschnitt betitelt „Aktionsname des Übergangs“- Im gleichen Stil aus Kleinbuchstaben und Unterstrichen (
snake_case). - Der Aktionsname löst den Wechsel aus, wählen Sie also Verben, die sich natürlich lesen:
process,complete,cancel,refund.
Innerhalb einer Machine können Sie einen Aktionsnamen für verschiedene Zustandspaare wiederverwenden, und Sie können mehrere Aktionen zwischen denselben zwei Zuständen haben — nur eine exakte Übereinstimmung von Aktion, Quelle und Ziel zählt als Duplikat.
Ein Hinweis zu Anzeigenamen
Abschnitt betitelt „Ein Hinweis zu Anzeigenamen“Überall, wo das Modul einen Zustand oder Übergang anzeigt, bevorzugt es den lesbaren Name und greift auf den technischen Namen zurück, wenn kein Name gesetzt ist. Jedem Zustand einen klaren Namen zu geben hält die Listen und das Diagramm gut lesbar.