structure

JanST123 · Oct 6, 2017 · d911dc9 · d911dc9
1 parent baf9071
commit d911dc9
Show file tree

Hide file tree

Showing 121 changed files with 7,239 additions and 5,899 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 _autoloader.cache.php
 .idea
+vendor/
diff --git a/src/LICENSE → LICENSE b/src/LICENSE → LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,52 @@
+# Welcome to the JSMF - The Jan S. MVC Framework
+
+With this framework you can build a whole MVC (Model-View-Controller)-based PHP Application or just use it as a collection of useful PHP classes. All parts of the framework can be used individually.
+
+See the [ApiIndex](docs/ApiIndex.md) for all available classes and methods.
+Please refer to the example application while the documentation is in this incomplete state.
+
+## Sample Application Bootstrap
+This is only needed if you want to base your whole application on JSMF. You can also use single Classes, using the JSMF autoloader or your own.
+
+Place this code in your applications index file. Route all request thru this file (See this [Gist](https://gist.github.com/RaVbaker/2254618) for an introduction on how to route all requests to index.php with Apache)
+Using this minimal setup will let the JSMF\Application class determine the Model/Controller/Action from the request url (http://host/module/controller/action) If one or more url parts are not present, the application will always use the "index" action (the "index" controller, the "index" module). Example: Requesting http://host will try to call module "index" -> IndexController -> indexAction, Request to http://host/misc/faq will call module "misc" -> FaqController -> indexAction
+
+	<?php
+	define('DEV_SERVER', true); // define this 
+	define('SRC', realpath(dirname(__FILE__) . '/../'));
+	require(SRC . '/lib/JSMF/_autoloader.php');
+
+	try {
+	  // optional: load an application wide config
+	  JSMF\Config::load(SRC . '/config/base.config.php');
+
+	  // optional: load application wide translations
+	  JSMF\Language::loadTranslations(SRC . '/language/translations', 'de');
+
+	  // optional: route special URLs to special modules / controllers / actions ( I always place the legal texts in a Module named misc)
+	  JSMF\Request::addRoute('/^\/disclaimer\/?$/i', 'misc', 'index', 'disclaimer'); // route a request to /disclaimer to the disclaimer Action in the IndexController in the module "misc"
+	  JSMF\Request::addRoute('/^\/privacy\/?$/i', 'misc', 'index', 'privacy');
+
+	  // run the application
+	  JSMF\Application::run();
+
+	  // output the applications response (can be HTML, JSON ...)
+	  JSMF\Response::output();
+
+	} catch(JSMF\Exception\NotFound $e) {
+	  // do some special things for not-found errors e.g. redirect to a static 404 page
+	  JSMF\Request::redirect('/404.html');
+	  JSMF\Response::output(); // output method also sends the headers (here: the Location header)
+
+	} catch(JSMF\Exception $e) {
+	  // output is done by JSMF
+	  JSMF\Response::output();
+
+	} catch(Exception $e) {
+	  // do something on common non-JSMF Exception
+	}
+
+See also the example code.
+
+
+
diff --git a/createdocs.sh b/createdocs.sh
diff --git a/ApiIndex.md → docs/ApiIndex.md b/ApiIndex.md → docs/ApiIndex.md
@@ -2,39 +2,39 @@ API Index
 =========
 
 * JSMF
-    * [Database](JSMF-Database.md)
-        * [Query](JSMF-Database-Query.md)
-        * [Statement](JSMF-Database-Statement.md)
-        * JSMF\Database\Type
-            * [DBFunction](JSMF-Database-Type-DBFunction.md)
+    * [Language](JSMF-Language.md)
     * [Form](JSMF-Form.md)
         * JSMF\Form\Validator
-            * [MinLength](JSMF-Form-Validator-MinLength.md)
             * [Number](JSMF-Form-Validator-Number.md)
-            * [Equal](JSMF-Form-Validator-Equal.md)
             * [ValidatorInterface](JSMF-Form-Validator-ValidatorInterface.md)
-            * [Date](JSMF-Form-Validator-Date.md)
+            * [Email](JSMF-Form-Validator-Email.md)
             * [Required](JSMF-Form-Validator-Required.md)
+            * [Equal](JSMF-Form-Validator-Equal.md)
             * [Password](JSMF-Form-Validator-Password.md)
+            * [Date](JSMF-Form-Validator-Date.md)
+            * [MinLength](JSMF-Form-Validator-MinLength.md)
             * [Value](JSMF-Form-Validator-Value.md)
-            * [Email](JSMF-Form-Validator-Email.md)
         * [Element](JSMF-Form-Element.md)
-    * [Template](JSMF-Template.md)
-    * [Response](JSMF-Response.md)
-    * [Repository](JSMF-Repository.md)
-    * [Request](JSMF-Request.md)
     * [Application](JSMF-Application.md)
+    * [Session](JSMF-Session.md)
+    * [Email](JSMF-Email.md)
+    * [Database](JSMF-Database.md)
+        * [Statement](JSMF-Database-Statement.md)
+        * [Query](JSMF-Database-Query.md)
+        * JSMF\Database\Type
+            * [DBFunction](JSMF-Database-Type-DBFunction.md)
+    * [Repository](JSMF-Repository.md)
+    * [Exception](JSMF-Exception.md)
+        * [NotFound](JSMF-Exception-NotFound.md)
+        * [UserVisible](JSMF-Exception-UserVisible.md)
+    * [Response](JSMF-Response.md)
+    * [Controller](JSMF-Controller.md)
+    * [Template](JSMF-Template.md)
     * [Cache](JSMF-Cache.md)
-        * [CacheInterface](JSMF-Cache-CacheInterface.md)
         * [Redis](JSMF-Cache-Redis.md)
+        * [CacheInterface](JSMF-Cache-CacheInterface.md)
         * [Memcached](JSMF-Cache-Memcached.md)
         * [Memcache](JSMF-Cache-Memcache.md)
-    * [Session](JSMF-Session.md)
     * [Config](JSMF-Config.md)
-    * [Controller](JSMF-Controller.md)
-    * [Exception](JSMF-Exception.md)
-        * [NotFound](JSMF-Exception-NotFound.md)
-        * [UserVisible](JSMF-Exception-UserVisible.md)
-    * [Email](JSMF-Email.md)
-    * [Language](JSMF-Language.md)
+    * [Request](JSMF-Request.md)
 
diff --git a/JSMF-Application.md → docs/JSMF-Application.md b/JSMF-Application.md → docs/JSMF-Application.md
diff --git a/JSMF-Cache-CacheInterface.md → docs/JSMF-Cache-CacheInterface.md b/JSMF-Cache-CacheInterface.md → docs/JSMF-Cache-CacheInterface.md
diff --git a/JSMF-Cache-Memcache.md → docs/JSMF-Cache-Memcache.md b/JSMF-Cache-Memcache.md → docs/JSMF-Cache-Memcache.md
diff --git a/JSMF-Cache-Memcached.md → docs/JSMF-Cache-Memcached.md b/JSMF-Cache-Memcached.md → docs/JSMF-Cache-Memcached.md
diff --git a/JSMF-Cache-Redis.md → docs/JSMF-Cache-Redis.md b/JSMF-Cache-Redis.md → docs/JSMF-Cache-Redis.md
diff --git a/JSMF-Cache.md → docs/JSMF-Cache.md b/JSMF-Cache.md → docs/JSMF-Cache.md
diff --git a/JSMF-Config.md → docs/JSMF-Config.md b/JSMF-Config.md → docs/JSMF-Config.md
diff --git a/JSMF-Controller.md → docs/JSMF-Controller.md b/JSMF-Controller.md → docs/JSMF-Controller.md
diff --git a/JSMF-Database-Query.md → docs/JSMF-Database-Query.md b/JSMF-Database-Query.md → docs/JSMF-Database-Query.md
@@ -355,3 +355,4 @@ executes the prepared query
 
 
 
+
diff --git a/JSMF-Database-Statement.md → docs/JSMF-Database-Statement.md b/JSMF-Database-Statement.md → docs/JSMF-Database-Statement.md
diff --git a/JSMF-Database-Type-DBFunction.md → docs/JSMF-Database-Type-DBFunction.md b/JSMF-Database-Type-DBFunction.md → docs/JSMF-Database-Type-DBFunction.md
diff --git a/JSMF-Database.md → docs/JSMF-Database.md b/JSMF-Database.md → docs/JSMF-Database.md
diff --git a/JSMF-Email.md → docs/JSMF-Email.md b/JSMF-Email.md → docs/JSMF-Email.md
diff --git a/JSMF-Exception-NotFound.md → docs/JSMF-Exception-NotFound.md b/JSMF-Exception-NotFound.md → docs/JSMF-Exception-NotFound.md
diff --git a/JSMF-Exception-UserVisible.md → docs/JSMF-Exception-UserVisible.md b/JSMF-Exception-UserVisible.md → docs/JSMF-Exception-UserVisible.md
diff --git a/JSMF-Exception.md → docs/JSMF-Exception.md b/JSMF-Exception.md → docs/JSMF-Exception.md
diff --git a/JSMF-Form-Element.md → docs/JSMF-Form-Element.md b/JSMF-Form-Element.md → docs/JSMF-Form-Element.md
diff --git a/JSMF-Form-Validator-Date.md → docs/JSMF-Form-Validator-Date.md b/JSMF-Form-Validator-Date.md → docs/JSMF-Form-Validator-Date.md
diff --git a/JSMF-Form-Validator-Email.md → docs/JSMF-Form-Validator-Email.md b/JSMF-Form-Validator-Email.md → docs/JSMF-Form-Validator-Email.md
diff --git a/JSMF-Form-Validator-Equal.md → docs/JSMF-Form-Validator-Equal.md b/JSMF-Form-Validator-Equal.md → docs/JSMF-Form-Validator-Equal.md
diff --git a/JSMF-Form-Validator-MinLength.md → docs/JSMF-Form-Validator-MinLength.md b/JSMF-Form-Validator-MinLength.md → docs/JSMF-Form-Validator-MinLength.md
diff --git a/JSMF-Form-Validator-Number.md → docs/JSMF-Form-Validator-Number.md b/JSMF-Form-Validator-Number.md → docs/JSMF-Form-Validator-Number.md
diff --git a/JSMF-Form-Validator-Password.md → docs/JSMF-Form-Validator-Password.md b/JSMF-Form-Validator-Password.md → docs/JSMF-Form-Validator-Password.md
diff --git a/JSMF-Form-Validator-Required.md → docs/JSMF-Form-Validator-Required.md b/JSMF-Form-Validator-Required.md → docs/JSMF-Form-Validator-Required.md
diff --git a/JSMF-Form-Validator-ValidatorInterface.md → ...JSMF-Form-Validator-ValidatorInterface.md b/JSMF-Form-Validator-ValidatorInterface.md → ...JSMF-Form-Validator-ValidatorInterface.md
diff --git a/JSMF-Form-Validator-Value.md → docs/JSMF-Form-Validator-Value.md b/JSMF-Form-Validator-Value.md → docs/JSMF-Form-Validator-Value.md
diff --git a/JSMF-Form.md → docs/JSMF-Form.md b/JSMF-Form.md → docs/JSMF-Form.md
diff --git a/JSMF-Language.md → docs/JSMF-Language.md b/JSMF-Language.md → docs/JSMF-Language.md
diff --git a/JSMF-Repository.md → docs/JSMF-Repository.md b/JSMF-Repository.md → docs/JSMF-Repository.md
diff --git a/JSMF-Request.md → docs/JSMF-Request.md b/JSMF-Request.md → docs/JSMF-Request.md
diff --git a/JSMF-Response.md → docs/JSMF-Response.md b/JSMF-Response.md → docs/JSMF-Response.md
diff --git a/JSMF-Session.md → docs/JSMF-Session.md b/JSMF-Session.md → docs/JSMF-Session.md
diff --git a/JSMF-Template.md → docs/JSMF-Template.md b/JSMF-Template.md → docs/JSMF-Template.md
diff --git a/docs/bin/README.md b/docs/bin/README.md
@@ -0,0 +1 @@
+# This is only needed for generating the Docs!!
diff --git a/docs/bin/composer.json b/docs/bin/composer.json
@@ -0,0 +1,8 @@
+{
+    "name": "JSMF Docs",
+    "require-dev": {
+        "phpdocumentor/phpdocumentor": "2.*",
+        "evert/phpdoc-md" : "~0.2.0"
+    }
+}
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		# This is only needed for generating the Docs!!