Documentation

Folders

Rain Framework is designed to work in any environment, like shared hosting, VPS, and for any situation, because you can easily configure your folders structure
<ul>
<li class="dir_icon"> application  application directory 
<ul id="conf_li">
<li class="dir_icon">controllers</li>
<li class="dir_icon">library</li>
<li class="dir_icon">log</li>
<li class="dir_icon">models</li>
<li class="dir_icon">views</li>
<li class="php_icon">ajax.bootstrap.php</li>
<li class="php_icon">bootstrap.php</li>
</ul>
</li>
<li class="dir_icon"> Rain 
<ul id="rain_li">
<li class="dir_icon">const</li>
<li class="dir_icon"> language 
<ul id="language_li" style="display:none;">
<li class="dir_icon">en</li>
</ul>
</li>
<li class="dir_icon"> library 
<ul id="library_li" style="display:none;">
<li class="php_icon"><a href="http://www.rainframework.com/rainframework/User-Guide/General/Controllers/">Controller.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Library/DB/">DB.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Library/Error-Handler/">error.functions.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Library/Form/">Email.php</a> Under construction</li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Library/Form/">Form.php</a> To be improved</li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Helper-Functions/">functions.php</a> </li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/General/Loader/">Loader.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/General/Models/">Model.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/General/URLs/">Router.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Library/Session/">Session.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Library/User/">User.php</a></li>
<li class="php_icon"><a href="http://www.rainframework.com/User-Guide/Library/View/">View.php</a></li>
</ul>
</li>
</ul>
</li>
<li class="dir_icon"> website 
<ul id="website_li">
<li class="dir_icon">cache</li>
<li class="dir_icon">config</li>
<li class="dir_icon">css</li>
<li class="dir_icon">js</li>
<li class="dir_icon">uploads</li>
<li class="php_icon">index.php The main file</li>
<li class="php_icon">ajax.php The main ajax file </li>
</ul>
</li>
</ul>
 
You can configure the Rain Framework folders structure by updating your configuration in the configuration file website/config/directory.php 
<table bgcolor="#cccccc" cellpadding="5" cellspacing="1">
<tbody>
<tr>
<td bgcolor="#eeeeee" width="150">Constant</td>
<td bgcolor="#eeeeee" width="100">Default</td>
<td bgcolor="#eeeeee">Description</td>
</tr>
<tr>
<td bgcolor="#f9f9f9">SCRIPT_NAME</td>
<td bgcolor="#f9f9f9">index.php or ajax.php</td>
<td bgcolor="#f9f9f9">take the name of the called script </td>
</tr>
<tr>
<td bgcolor="#f9f9f9">BASE_DIR</td>
<td bgcolor="#f9f9f9">root directory</td>
<td bgcolor="#f9f9f9">take the root directory of your project </td>
</tr>
<tr>
<td bgcolor="#fcfcfc">CONSTANTS_DIR</td>
<td bgcolor="#fcfcfc">Rain/const/</td>
<td bgcolor="#fcfcfc">constants directory </td>
</tr>
<tr>
<td bgcolor="#fcfcfc">LANGUAGE_DIR</td>
<td bgcolor="#fcfcfc">Rain/language/</td>
<td bgcolor="#fcfcfc">language directory </td>
</tr>
<tr>
<td bgcolor="#f9f9f9">LIBRARY_DIR</td>
<td bgcolor="#f9f9f9">Rain/library/</td>
<td bgcolor="#f9f9f9">library directory </td>
</tr>
<tr>
<td bgcolor="#fcfcfc">CACHE_DIR</td>
<td bgcolor="#fcfcfc">website/cache/</td>
<td bgcolor="#fcfcfc">cache directory </td>
</tr>
<tr>
<td bgcolor="#fcfcfc">CONFIG_DIR</td>
<td bgcolor="#fcfcfc">website/config/</td>
<td bgcolor="#fcfcfc">config directory, each website has its own</td>
</tr>
<tr>
<td bgcolor="#f9f9f9">LOG_DIR</td>
<td bgcolor="#f9f9f9">website/log/</td>
<td bgcolor="#f9f9f9">log directory </td>
</tr>
<tr>
<td bgcolor="#f9f9f9">UPLOADS_DIR</td>
<td bgcolor="#f9f9f9">website/uploads/</td>
<td bgcolor="#f9f9f9">upload directory </td>
</tr>
<tr>
<td bgcolor="#fcfcfc">CSS_DIR</td>
<td bgcolor="#fcfcfc">website/css/</td>
<td bgcolor="#fcfcfc">stylesheet directory </td>
</tr>
<tr>
<td bgcolor="#fcfcfc">JAVASCRIPT_DIR</td>
<td bgcolor="#fcfcfc">website/js/</td>
<td bgcolor="#fcfcfc">javascript directory </td>
</tr>
<tr>
<td bgcolor="#f9f9f9">APPLICATION_DIR</td>
<td bgcolor="#f9f9f9">application/ </td>
<td bgcolor="#f9f9f9">you develop your application</td>
</tr>
<tr>
<td bgcolor="#f9f9f9">CONTROLLERS_DIR</td>
<td bgcolor="#f9f9f9">application/controllers/ </td>
<td bgcolor="#f9f9f9">controller directory</td>
</tr>
<tr>
<td bgcolor="#f9f9f9">MODELS_DIR</td>
<td bgcolor="#f9f9f9">application/models/ </td>
<td bgcolor="#f9f9f9">models directory </td>
</tr>
<tr>
<td bgcolor="#f9f9f9">VIEWS_DIR</td>
<td bgcolor="#f9f9f9">application/views/ </td>
<td bgcolor="#f9f9f9">views directory </td>
</tr>
<tr>
<td bgcolor="#f9f9f9">APPLICATION_LIBRARY_DIR</td>
<td bgcolor="#f9f9f9">application/library/</td>
<td bgcolor="#f9f9f9">Library specific for the application goes here </td>
</tr>
</tbody>
</table>

Wiki edit

User Guide / Basic

Folders

Rain Framework is designed to work in any environment, like shared hosting, VPS, and for any situation, because you can easily configure your folders structure

application application directory
- controllers
- library
- log
- models
- views
- ajax.bootstrap.php
- bootstrap.php
Rain
- const
- language
  - en
- library
  - Controller.php
  - DB.php
  - error.functions.php
  - Email.php Under construction
  - Form.php To be improved
  - functions.php
  - Loader.php
  - Model.php
  - Router.php
  - Session.php
  - User.php
  - View.php
website
- cache
- config
- css
- js
- uploads
- index.php The main file
- ajax.php The main ajax file

You can configure the Rain Framework folders structure by updating your configuration in the configuration file website/config/directory.php

Constant	Default	Description
SCRIPT_NAME	index.php or ajax.php	take the name of the called script
BASE_DIR	root directory	take the root directory of your project
CONSTANTS_DIR	Rain/const/	constants directory
LANGUAGE_DIR	Rain/language/	language directory
LIBRARY_DIR	Rain/library/	library directory
CACHE_DIR	website/cache/	cache directory
CONFIG_DIR	website/config/	config directory, each website has its own
LOG_DIR	website/log/	log directory
UPLOADS_DIR	website/uploads/	upload directory
CSS_DIR	website/css/	stylesheet directory
JAVASCRIPT_DIR	website/js/	javascript directory
APPLICATION_DIR	application/	you develop your application
CONTROLLERS_DIR	application/controllers/	controller directory
MODELS_DIR	application/models/	models directory
VIEWS_DIR	application/views/	views directory
APPLICATION_LIBRARY_DIR	application/library/	Library specific for the application goes here

« Installation

Features »

Basic

General

Library

Helper Functions

Folders

Folders