Projekt

Obecné

Profil

Dokument Architektura » Historie » Verze 1

Tomáš Květoň, 2021-04-30 10:00

1 1 Tomáš Květoň
h1. Architektura projektu
2
3
h2. Souborová struktura
4
5
Souborová struktura dodržuje standard předepsaný pro plugin WordPress.
6
Projekt je rozdělený do několika hlavních sekcí:
7
* admin
8
** _Front-End pro administrátorskou část pluginu._
9
* common
10
** _Sdílená logika projektu pro Front-End._
11
* includes
12
** _Sdílená logika projektu pro Back-End._
13
* public
14
** _Front-End pro uživatelskou část pluginu._
15
16
!Untitled%20Diagram%20%281%29.png!
17
18
h2. Jmenná konvence
19
20
V celém projektu pluginu je dodržována jmenná konvence nastavená pro plugin WordPress.
21
22
h2. Proces zpracování uživatelských požadavků
23
24
Níže uvedený diagram zobrazuje průběh zpracování uživatelského požadavku.
25
26
!Untitled%20Diagram.png!
27
28
h2. Důležité výčetní typy
29
30
Je velmi důležité dodržovat používání těchto výčetních typů pro zachování přehlednosti kódu a snadnou udržitelnost.
31
Výčetní typy poskytují textovou reprezentaci, kterou lze snadno změnit bez nutnosti většího zásahu do kódu pluginu.
32
Každý tento výčetní typ má svoji podobu ve verzi pro skripty v JS a PhP.
33
34
h3. Name Types
35
@common/js/enums/name_types.js@, @includes/enums/GT_Name_Type.php@
36
37
h3. Request Types
38
@common/js/enums/request_types.js@, @includes/enums/GT_Request_Type.php@
39
40
Pro stranu „front-endu“ je zde definován výčet selektorů, které jsou nezbytné či klíčové pro nutnou funkčnost pluginu.
41
Obsahuje primárně ID selektory důležité pro hlavní funkcionalitu pluginu.
42
Z důvodu přehlednosti se na místo běžné textové reprezentace používají tyto selektory, aby byla jakákoli změna ze strany šablon (HTML) velmi snadno a nebylo nutné zasahovat přímo do logické části programu.
43
44
h3. Selektory
45
@common/js/enums/selectors.js@