summaryrefslogtreecommitdiff
path: root/core/README.md
diff options
context:
space:
mode:
authorGeo Halkiadakis <gchalkiadakis@sklavenitis.co.gr>2023-04-27 18:16:44 +0300
committerGeo Halkiadakis <gchalkiadakis@sklavenitis.co.gr>2023-04-27 18:16:44 +0300
commitb52e052bd3741c1ddf1bdaa43079ba5a9eafc8bd (patch)
treeebf54306edc20705544ea4d10cb12b34a66c05cc /core/README.md
parent187335950742b4c7ec011ede6e6d1ae86662cb1f (diff)
downloadclassroom-b52e052bd3741c1ddf1bdaa43079ba5a9eafc8bd.tar.gz
classroom-b52e052bd3741c1ddf1bdaa43079ba5a9eafc8bd.tar.bz2
classroom-b52e052bd3741c1ddf1bdaa43079ba5a9eafc8bd.zip
setting blueprint in action
Diffstat (limited to 'core/README.md')
-rw-r--r--core/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/core/README.md b/core/README.md
index 8dee940..2fdd951 100644
--- a/core/README.md
+++ b/core/README.md
@@ -19,8 +19,25 @@ Main advantages of the framework:
* Some webserver (Apache/Nginx)
* Some SQL server (MySQL/MariaDB/Postgress)
* Basic knowledge of php and SQL
+* Baasic knowlege of OOP
+### Code standards
+
+Amon uses the PSR-1 code standard with a few enchansements:
+
+Controllers are named like
+
+ class SomeController
+ // or...
+ class SomeController_something
+
+where ```something``` indicates some special operational role of the contoller
+ex. ```_user```, ```_service```, ```manager``` etc
+
+As a result all model classes are suffixed with ```_model```:
+
+ class SomeModelName_model;
### What is included