index.md @ docs

README.md

@@ -1,3 +1,7 @@
+[http://alorel.github.io/alo-framework/](View this prettified)
+
+----------
+
 # What is this? #
 AloFramework is an incredibly lightweight and flexible MVC framework for PHP 5.3+. It has a lot of built-in functionality including but not limited to:
 
@@ -12,6 +16,8 @@ AloFramework is an incredibly lightweight and flexible MVC framework for PHP 5.3
 * Object-oriented file manager
 * Remote SFTP file manager
 
+----------
+
 # Structure #
 ## General ##
 You will find code documentation under the **docs** directory, some setup scripts under **setup** and source files under **src**.
@@ -26,6 +32,8 @@ In **src** the main components are **app*, **resources**, **sys** and files unde
 ## Namespaces ##
 The **class** and **interface** directories found under *src/app* and *src/sys* follow a namespaced structure, e.g. the class **Alo\Db\MySQL** would be found in the file *class/alo/db/mysql.php*. Please not that **all directory and file names should be lowercase*.
 
+----------
+
 # Workflow #
 ## Main concept ##
 For most projects, you will want to write your own classes that extend those of the framework's. That way you will be completely safe from losing any code during a framework upgrade. The built-in autoloader will automatically load any required interfaces found in **app/class**, **app/interface**, **sys/class** and **sys/interface**.
@@ -75,13 +83,19 @@ Any view can be loaded via **Alo\Controller\AbstractController**'s protected met
 ```
 This will load a view under **app/view/$name.php**. You can provide parameters to pass on to the view via **$params**, e.g. if you pass on **['foo' => 'bar']** and echo **$foo** in the view, the output will be **bar**. If instead of echoing the output you want to retrieve it, provide **$return** with **true**. Each view can be reused during the same execution.
 
+----------
+
 # Logging #
 All logging is done via the global static class **\Log**'s public methods - please refer to the documentation. You will can set the logging level (during the [Initial Setup](#initial-setup) phase described below).
 
+----------
+
 # Initial setup #
 * You will want to copy the contents of **sys/config** into **app/config**. Open them and set the values as appropriate. Next, open **index.php**, scroll to **// ===== General setup BEGIN =====** and set the values as you please.
 * Next you'll want to run the appropriate files under **setup** if you are using that functionality.
 
+----------
+
 # Updating #
 Updates are applied by following these 6 steps:
 
@@ -92,6 +106,8 @@ Updates are applied by following these 6 steps:
 5. If there are any changes to **.htaccess**, merge them with your version.
 6. Re-apply your personal settings under **index.php**'s **// ===== General setup BEGIN =====**
 
+----------
+
 # External Libraries #
 AloFramework uses the following external libraries for its functionality:
 

docs/index.md

@@ -0,0 +1,115 @@
+[http://alorel.github.io/alo-framework/](View this prettified)
+
+----------
+
+# What is this? #
+AloFramework is an incredibly lightweight and flexible MVC framework for PHP 5.3+. It has a lot of built-in functionality including but not limited to:
+
+* Memcached wrapper
+* Database connection class
+* MySQL or Memcached-based session manager
+* HTML form validator
+* Code testing suite
+* Email sender
+* Crontab editor
+* Object-oriented cURL wrapper
+* Object-oriented file manager
+* Remote SFTP file manager
+
+----------
+
+# Structure #
+## General ##
+You will find code documentation under the **docs** directory, some setup scripts under **setup** and source files under **src**.
+In **src** the main components are **app*, **resources**, **sys** and files under the directory root.
+
+* **sys** contains all the framework files
+* **resources** is where you're meant to put all your images, css and whatnot
+* **app** is where your code should go
+* **.htaccess** makes sure requests get routed correctly
+* **index.php** contains some core constants
+
+## Namespaces ##
+The **class** and **interface** directories found under *src/app* and *src/sys* follow a namespaced structure, e.g. the class **Alo\Db\MySQL** would be found in the file *class/alo/db/mysql.php*. Please not that **all directory and file names should be lowercase*.
+
+----------
+
+# Workflow #
+## Main concept ##
+For most projects, you will want to write your own classes that extend those of the framework's. That way you will be completely safe from losing any code during a framework upgrade. The built-in autoloader will automatically load any required interfaces found in **app/class**, **app/interface**, **sys/class** and **sys/interface**.
+
+## The global Alo class ##
+This class is always loaded by default and contains static references to objects which are *in most cases* used as singletons. You should try to load most of your classes into its static properties, e.g. you will usually only need one database connection, so you can assign it to Alo::$db and access it from anywhere in your code.
+
+## Controllers ##
+All controllers must go under **app/class/controller**, have the **Controller** namespace and extend the class **Alo\Controller\AbstractController**. To make this easier, you can write your own Abstract controller and extend that of Alo\ from within, for example:
+
+**app/class/controller/abstractcontroller.php**
+```
+namespace Controller;
+
+class AbstractController extends Alo\Controller\AbstractController {
+   //Your code
+}
+```
+
+**app/class/controller/home.php**
+```
+namespace Controller;
+
+class Home extends AbstractController {
+   //Your code
+}
+```
+
+Only **public, non-abstract, non-static methods will be used for routing**. The default method for most controllers is **index()**;
+
+## Views ##
+Any view can be loaded via **Alo\Controller\AbstractController**'s protected method **loadView**:
+```
+/**
+  * Loads a view
+  *
+  * @author Art <a.molcanovas@gmail.com>
+  * @param string  $name   The name of the view without ".php".
+  * @param array   $params Associative array of parameters to pass on to the view
+  * @param boolean $return If set to TRUE, will return the view, if FALSE,
+  *                        will echo it
+  * @return null|string
+  */
+  protected function loadView($name, $params = [], $return = false) {
+     // Code
+  }
+```
+This will load a view under **app/view/$name.php**. You can provide parameters to pass on to the view via **$params**, e.g. if you pass on **['foo' => 'bar']** and echo **$foo** in the view, the output will be **bar**. If instead of echoing the output you want to retrieve it, provide **$return** with **true**. Each view can be reused during the same execution.
+
+----------
+
+# Logging #
+All logging is done via the global static class **\Log**'s public methods - please refer to the documentation. You will can set the logging level (during the [Initial Setup](#initial-setup) phase described below).
+
+----------
+
+# Initial setup #
+* You will want to copy the contents of **sys/config** into **app/config**. Open them and set the values as appropriate. Next, open **index.php**, scroll to **// ===== General setup BEGIN =====** and set the values as you please.
+* Next you'll want to run the appropriate files under **setup** if you are using that functionality.
+
+----------
+
+# Updating #
+Updates are applied by following these 6 steps:
+
+1. Look through the changelog for to see if any changes will cause issues (e.g. a deprecated method being removed), prepare your code if necessary.
+2. Make a copy of your **index.php** and **.htaccess** files as well as the **resources** directory.
+3. Delete the above, as well as the **sys** directory.
+4. Extract the new code. It will never contain files other than blank **index.html**s and **sample.php**s under **app/**, so no application code will be overwritten.
+5. If there are any changes to **.htaccess**, merge them with your version.
+6. Re-apply your personal settings under **index.php**'s **// ===== General setup BEGIN =====**
+
+----------
+
+# External Libraries #
+AloFramework uses the following external libraries for its functionality:
+
+* [PHPMailer](https://github.com/PHPMailer/PHPMailer/) 5.2.9+ for email support
+* [Kint](http://raveren.github.io/kint/) for debug output