webcraftmedia/system
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

#7 fixed readme.md file to meat the md format, added some texts

Browse Source
This commit is contained in:
Ulf Gebhardt 2017-05-04 14:39:42 +02:00
parent c3b640ea35
commit 52f71e4165
1 changed files with 84 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
readme.md
View File

@ -21,76 +21,113 @@ git@github.com:webcraftmedia/demo_basic.git and follow instructions there.
Features Features
======== ========
SYSTEM offers diferent Features - a few are described in this readme
Ecapsulation of Code Ecapsulation of Code
--------------------
Seperation by Language, Seperation by Access, Seperation by Meaning. Seperation by Language, Seperation by Access, Seperation by Meaning.
System ecapsulates the following languages in different Files: System ecapsulates the following languages in different Files:
PHP * PHP
SQL * SQL
JS * JS
HTML * HTML
CSS * CSS
Depending on how you access the Page you are redirectd in diferent Parts of a Project. Depending on how you access the Page you are redirectd to diferent Endpoints of your Project.
System distiquishes between System distiquishes between
index.php - serve webpages * index.php - serve webpages
api.php - returns json results, ajax-calls normally go here * api.php - returns json results, ajax-calls normally go to this endpoint
sai.php - serves a secure extendable environment to administer your Page * sai.php - serves a secure extendable environment to administer your Page
The Autoload-Feature which is used within System allows you to seperate your Project The Autoload-Feature which is used within System allows you to seperate your Project
further into several subfolders - normally one for every single page you server. further into several subfolders - normally one for every single page you serve.
Feature API API
Url parameter mapping to php classes in a modern way ---
Feature Cache Url parameter mapping to php classes in a modern way. Calls to your Page or API are
Cache any data into the database to server content without recalculating it. directly mapped to a class of your choice, serving the diferent calls you implement.
By default its cleaned once a day via cronjob. Write your own Cache handler
to put and pull from cache
Feature Config Cache
Extendable config, by default contains paths, default database connection, -----
project name & language etc.
Feature Cron Cache any data you want to cache. Typical things cached are Javascript and CSS.
Php Cron processing. Needs to be pinged by the systems cron job. By default the cache is cleaned once a day via internal cronjob mechanism.
Allows as many cronjobs as needed. Write your own Cache handler to put and pull from cache.
Config
------
Extendable config, by default contains paths, default database connection, project name & language etc.
Cron
----
Php Cron processing. Needs to be called by the underlying systems cron job.
Allows as many cronjobs as needed, with just one cronjob registered in the
Operating System.
DB
--
Feature DB
Persistent Database Connection, multiple Connections, SQL Ecapsulation, Persistent Database Connection, multiple Connections, SQL Ecapsulation,
Automatic Injection Protection, Easy access, almost zero code Automatic Injection Protection, Easy access, almost zero code, one class per
Query and therefore high reusability.
Feature Docu Docu
Documentation system relying on markdown ----
Feature Files Integrated PHPDocumentor including HTML and MD output. Register what code you want
Serve Files from where you want, dont expose your server structure. to document and a button will generate you your documentation.
Files
-----
Serve Files from where you want, dont expose your server file structure.
Html
----
Feature Html
Html definitions(minimal) Html definitions(minimal)
Feature Lib Lib
Includes Several Libs, Lib Interface to bind your Projcts libs easily ---
Feature log Includes Several Libs, Minimal Lib Interface to bind your Projcts libraries easily
Log from anywhere in your Project, Analysis of Log, Easy debugging
Log
---
Log from anywhere in your Project, Analysis of Log, Easy debugging, Visitor statistics
Page
----
Feature page
Simple Template system, able to replace ${var} placeholders in text and files. Simple Template system, able to replace ${var} placeholders in text and files.
Hashbang compatibility, Modern ajax technologies to not relog the page, Hashbang compatibility, Modern ajax technologies to not reload the page,
but load content on demand. but load content on demand including a caching meachanism to not load content
twice.
Feature sai SAI
Admin Interface reachable under sai.php, extenable, many system Modules to ---
manage system features from a webui.
Feature security Admin Interface to manage SYSTEM features of your Page from a webui. SAI is extenable,
Login, Register etc in a secure manner. Not SAML compatible yet. so you can write your own Modules to manage your Page-Content as you prefere to do it.
Feature sql Security
Extendable Installtion System, to run sql scripts for the Project. --------
Login, Register etc in a secure manner via API. Includes Password-Reset via
EMail Confirmation.
SQL
---
Extendable Database Installtion System, to run sql scripts for the Project upon
update or install.
License License
======= =======