Struktura katalogów

Diagram struktury katalogów

Objaśnienie katalogów

data

W tym folderze są przechowywane pliki wykorzystywane podczas instalacji lub aktualizacji aplikacji.

• Podkatalogi
  • install - zawiera pliki php i/lub sql wykorzystywane podczas instalacji aplikacji.
  • migration/patches - zawiera pliki php i/lub sql wykorzystywane podczas aktualizacji aplikacji.

Podkatalogi z przykładowymi plikami

.
└── data
    └── install
        └── php
        └── sql
    └── migration
        └── patches

docs

W tym folderze są przechowywane pliki MD, w których prowadzimy dokumentacje dla klienta aplikacji, jak np. włączyć lub wyłączyć LogObservera.

Podkatalogi z przykładowymi plikami

.
└── docs
    └── LogsObservers.md

etc

W tym folderze przetrzymujemy pliki w formacie toml. Można tu znaleść listę zarejestrowanych:

• LogObserver
• EventEmiter
• ProcedureCommands
• ApiEndpoints

Podkatalogi z przykładowymi plikami

.
└── etc
    └── log_observer.toml
    └── event_emiter.toml
    └── procedure_commands.toml
    └── api_endpoints.toml

low-code

W tym folderze znajdziemy obiekty najczęściej w formacie XML. Obiekty, które są w plikach są przechowywane w bazie danych aplikacji.

Każdy obiekt (krotka) jest w osobnym pliku.

public/assets

W tym folderze znajdziemy wszystkie assety, które są wykorzystywane do poprawnego renderowania przez przeglądarkę applikacji.

Podkatalogi z przykładowymi plikami

.
└── public
    └── assets
        └──  css
            └──  basic.css
            └──  button.less
        └──  js
            └──  Widgets.js
        └──  img
            └──  obrazek.png

• Opis podkatalogów
  • css - tutaj możemy znaleź pliki css/sass/less aplikacji
  • js - tutaj możemy znaleź pliki js/ts
  • img - tutaj możemy znaleź pliki typu obrazek np. png, jpg, itp.

src

W tym folderze znajdziemy cały kod aplikacji.

Przestrzeń nazw dla aplikacji: NazwaProducenta/NazwaAplikacji

Podkatalogi z przykładowymi plikami

.
└── src
    └── Controller
        └──  Api
        └──  Cli
        └──  Observer
        └──  Plugin
        └──  Workflow
            └──  Command
    └── Model
    └── View
        └── Form
        └── List
        └── Module
        └── Tree
        └── Widget
    └── Util
        └── Config
        └── Exception
        └── Log
        └── Service
        └── Translator
        └── WS
    └── Services

• Opis podkatalogów
  • Model - są tutaj pliki, które reprezentują obiekty tabel, widoków z bazy danych,
  • View - są tutaj pliki, które są odpowiedzialne za graficzną reprezentację modelu,
  • Util - są tutaj pliki, które są używane w różnych miejscach aplikacji, np. do parsowania jsona, xml,
  • Controller - są tutaj pliki wykonawcze,
  • Services - są tutaj pliki, które, odpowiadające logikę biznesową,

tests

W tym folderze znajdziemy Testy do sprawdzania poprawności działania funkcji aplikacji.

Podkatalogi z przykładowymi plikami

.
└── tests
    └── api
    └── functional
    └── util

• Opis podkatalogów
  • api - Folder zawiera pliki do testowania RestApi,
  • functional - Folder zawiera pliki do testów funkcjonalnych (testy wymagające różnych zależności np. sessji użytkownika, bazy danych)
  • util - Folder zawiera pliki do testowania naszych narzędzi,

var/cfg/CustomModules

W tym folderze przechowujemy definicję modułu w pliku XML.

var/tpl/tabs

W tym folderze przechowujemy definicję zakładek w plikach XML.

vendor

Ten folder jest przeznaczony na pakiety obce, które są wykorzystywane przez Aplikację.

Folder ten podczas budowania paczki będzie prefixowany, aby zapobiec konfliktom, i by każda aplikacja mogła korzystać z swoich pakietów.