Applied Rules

Opis

Moduł udostępnia w panelu Admin identyfikatory reguł sprzedaży zastosowanych do zamówienia (applied_rule_ids). Rozszerza siatkę zamówień o kolumnę „Applied Rule IDs” oraz dodaje w widoku zamówienia wiersz z tą informacją.

Dla kogo

Dla użytkowników panelu Admin, którzy potrzebują szybkiej informacji o zastosowanych regułach sprzedaży. W praktyce: obsługa klienta, operacje i marketing weryfikujący promocje.

Funkcje

  • Dodaje kolumnę „Applied Rule IDs” do siatki zamówień w Admin (sales_order_grid) poprzez komponent UI.
  • Rozszerza kolekcję siatki zamówień w Admin o sales_order.applied_rule_ids (join do tabeli sales_order).
  • Wyświetla Applied Rule IDs w widoku zamówienia w bloku Order Information (gdy puste, pokazuje “None”).
  • Brak konfiguracji, brak patchy/setupów i brak zmian schematu lub danych w DB.
  • Zależność od Magento_Sales (sequence w module.xml).

Instalacja

* = in production please use the --keep-generated option

Type: Composer

  1. Add the composer repository to the configuration:

    
composer config repositories.applied.rules vcs https://github.com/kowalco/applied-rules

  2. Add an access token for the private GitLab repository:

    
composer config --global --auth github-oauth.github.com <YOUR_TOKEN>

  3. Install the module using Composer:

    
composer require kowal/module-appliedrules

  4. Enable the module:

    
php bin/magento module:enable Kowal_AppliedRules

  5. Apply database updates:

    
php bin/magento setup:upgrade

  6. Flush the cache:

    
php bin/magento cache:flush

Konfiguracja

Brak plików etc/config.xml i etc/adminhtml/system.xml, więc moduł nie dodaje konfiguracji w Adminie i nie ma ustawień scope (default/website/store view).

Wdrożenie i operacje

Moduł działa wyłącznie w panelu Admin (siatka zamówień i widok zamówienia). Po wdrożeniu i czyszczeniu cache Applied Rule IDs będą widoczne w:

  • Sales > Orders (kolumna „Applied Rule IDs”).
  • Sales > Orders > View (wiersz w bloku Order Information).

Moduł nie dodaje cronów, kolejek ani indekserów.

Checklist wdrożeniowy

  1. Wdrożyć kod i zainstalować przez Composer.
  2. Włączyć moduł i uruchomić setup:upgrade.
  3. Wyczyścić cache Magento.
  4. Zweryfikować widoczność kolumny w siatce i wiersza w widoku zamówienia.

CI/CD i środowiska

Brak konfiguracji zależnych od środowiska. Nie ma dodatkowych kroków builda poza standardowym wdrożeniem zmian w Admin UI.

Rollback

Rollback polega na usunięciu lub wyłączeniu modułu i wykonaniu standardowego setup:upgrade oraz cache:flush. Moduł nie posiada patchy danych ani zmian schematu do cofania.

Wymagania / uwagi

  • Wymaga Magento_Sales (sequence).
  • Brak deklarowanych zależności w Composer.
  • Korzysta z istniejącej kolumny sales_order.applied_rule_ids; gdy jest pusta lub brak danych, wynik będzie pusty/„None”.
  • Instrukcja instalacji w README zawiera niezamknięte bloki kodu; warto zachować spójne formatowanie przy ponownym użyciu.

Kompatybilność

Brak jawnych ograniczeń wersji Magento lub PHP w composer.json. Zgodność powinna obejmować instalacje Magento 2 z modułem Magento_Sales.

FAQ

  • Gdzie jest konfiguracja w Adminie? Nie ma; moduł nie dodaje konfiguracji systemowej ani zasobów ACL.
  • Czy moduł zmienia schemat lub dane bazy? Nie. W module nie ma setupów ani patchy.
  • Dlaczego nie widzę Applied Rule IDs? Jeśli zamówienie nie ma zastosowanych reguł, moduł pokaże “None”. Gdy w DB kolumna jest pusta, nic się nie wyświetli.
  • Czy są dodatkowe kroki wdrożenia? Nie, wystarczą standardowe kroki włączenia modułu i czyszczenia cache.