Konwencje nazewnictwa
Moduł wymusza kilka prostych zasad nazewnictwa, aby maszyny, stany i akcje pozostały spójne i niezawodnie współpracowały z resztą Shopware.
Nazwa techniczna state machine
Dział zatytułowany „Nazwa techniczna state machine”Format: entity.state — nazwa encji małymi literami, kropka, następnie state.
- Tylko małe litery, cyfry i podkreślenia, z pojedynczą kropką rozdzielającą obie części.
- Przykłady:
order.state,subscription.state,return_request.state.
To identyfikator, po którym Shopware i inne pluginy odnajdują maszynę, więc musi być dokładny. W podstawowych state machines jest zablokowany i nie można go zmienić.
Czytelna Name nie ma ograniczeń formatu — użyj tego, co jest najjaśniejsze dla Twojego zespołu.
Nazwa techniczna stanu
Dział zatytułowany „Nazwa techniczna stanu”- Musi zaczynać się od małej litery.
- Może zawierać wyłącznie małe litery, cyfry i podkreślenia (
snake_case). - Przykłady:
open,in_progress,partially_paid.
Nazwy techniczne muszą być unikalne w obrębie maszyny; próba ponownego użycia nazwy jest blokowana błędem w polu. Name stanu jest dowolna.
Nazwa akcji przejścia
Dział zatytułowany „Nazwa akcji przejścia”- Zapisywana w tym samym stylu małych liter i podkreśleń (
snake_case). - Nazwa akcji wyzwala ruch, więc wybieraj czasowniki, które czytają się naturalnie:
process,complete,cancel,refund.
W obrębie jednej maszyny możesz użyć tej samej nazwy akcji dla różnych par stanów i możesz mieć wiele akcji między tymi samymi dwoma stanami — za duplikat liczy się tylko dokładna zgodność akcji, źródła i celu.
Uwaga o nazwach wyświetlanych
Dział zatytułowany „Uwaga o nazwach wyświetlanych”Wszędzie, gdzie moduł pokazuje stan lub przejście, preferuje czytelną Name, a gdy nazwa nie jest ustawiona, sięga po nazwę techniczną. Nadanie każdemu stanowi jasnej nazwy utrzymuje listy i diagram w czytelnej formie.