forked from skill-project/website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdoc.txt
102 lines (67 loc) · 2.01 KB
/
doc.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
DOC
Config/
routes.php
holds all routes definition
Config.php
main configuration class, database connection info...
Controller/
App.php
launch everything, instanciated in main index.php
Controller.php
extended by all controllers
ApiController.php
handles all requests made to the skills api
will be renamed
MainController.php
handles all requests to display basic pages
PanelController.php
handles all AJAX requests to render side panel content
UserController.php
handles all requests about user (login, registration...)
Router.php
usefull methods about routing
Model/
DatabaseFactory.php
Connect to db and return $client
Almost singleton pattern for now
Entity.php
Extended by all entities (User, Skill...)
JsonNode.php
Represents a skill node in json (to be sent)
JsonResponse.php
Represents the complete JSON responses
Skill.php
Entity
SkillManager.php
Handles all db requests about skills
User.php
Entity
UserManager.php
Handles all db requests about users
Validator.php
Contains all validation methods, and holds error messages
Utils/
SecurityHelper.php
hash functions, random string generator...
should be renamed
vendor/
outside codes
View/
inc/
holds views parts (forms, sidebar...)
layouts/
holds main layouts (files with doctype, head, body, etc.)
pages/
holds contents for views
View.php
Class for displaying the view
AjaxView.php
extends View.php, different layout by default
web/
Holds css/ folder, js/ codes, public files, etc...
index.php
Front controller, all requests go through here
.htaccess
Redirect all requests to index.php
composer.json
composer.lock