miniMVC/docs/namespaces/default.html

709 lines
32 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>miniMVC » default</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-map-marker"></i> Namespaces</li>
<li>
<a href="../namespaces/default.html" title="default"><i class="icon-th"></i>default</a><ul class="nav nav-list nav-namespaces"></ul>
</li>
</ul>
</div>
<div class="span8 namespace-contents">
<ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-th"></i></a><span class="divider">\</span>
</li>
<li class="active"><a href="../namespaces/default.html">default</a></li>
</ul>
<div class="namespace-indent">
<h3>
<i class="icon-custom icon-function"></i> Functions</h3>
<a name="__call" id="__call"></a><div class="element clickable function __call" data-toggle="collapse" data-target=".__call .collapse">
<h2>PHP magic method to facilitate dynamic methods</h2>
<pre>__call(string $name, array $params) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__clone" id="__clone"></a><div class="element clickable function __clone" data-toggle="collapse" data-target=".__clone .collapse">
<h2>Magic function called when cloning an object</h2>
<pre>__clone() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable function __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Constructor for creating the objects</h2>
<pre>__construct(array $members) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$members</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__invoke" id="__invoke"></a><div class="element clickable function __invoke" data-toggle="collapse" data-target=".__invoke .collapse">
<h2>PHP magic method that is called when an object is treated as a function</h2>
<pre>__invoke(array $params) : \self</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\self</code></div>
</div></div>
</div>
<a name="__toString" id="__toString"></a><div class="element clickable function __toString" data-toggle="collapse" data-target=".__toString .collapse">
<h2>Prints out the contents of the object when used as a string</h2>
<pre>__toString() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="controller_methods" id="controller_methods"></a><div class="element clickable function controller_methods" data-toggle="collapse" data-target=".controller_methods .collapse">
<h2>Returns routable methods for the specified controller class</h2>
<pre>controller_methods(string $controller) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$controller</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="db_filter" id="db_filter"></a><div class="element clickable function db_filter" data-toggle="collapse" data-target=".db_filter .collapse">
<h2>Filter out db rows into one array</h2>
<pre>db_filter(array $array, mixed $index) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$array</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$index</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="do_include" id="do_include"></a><div class="element clickable function do_include" data-toggle="collapse" data-target=".do_include .collapse">
<h2>Bulk directory loading workaround for use
with array_map and glob</h2>
<pre>do_include(string $path) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="do_include" id="do_include"></a><div class="element clickable function do_include" data-toggle="collapse" data-target=".do_include .collapse">
<h2>Array_map callback to load a folder of classes at once</h2>
<pre>do_include(string $path) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$path</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="get_instance" id="get_instance"></a><div class="element clickable function get_instance" data-toggle="collapse" data-target=".get_instance .collapse">
<h2>Singleton getter function</h2>
<pre>get_instance() : \self</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>\self</code></div>
</div></div>
</div>
<a name="is_like_array" id="is_like_array"></a><div class="element clickable function is_like_array" data-toggle="collapse" data-target=".is_like_array .collapse">
<h2>Utility function to check if a variable is set, and is an array or object</h2>
<pre>is_like_array(mixed $var) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$var</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a name="load_file" id="load_file"></a><div class="element clickable function load_file" data-toggle="collapse" data-target=".load_file .collapse">
<h2>Function to search through the tree to find the necessary file</h2>
<pre>load_file(string $file, string $curr_path) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$file</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$curr_path</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="on_error" id="on_error"></a><div class="element clickable function on_error" data-toggle="collapse" data-target=".on_error .collapse">
<h2>Custom error handler</h2>
<pre>on_error(int $severity, string $message, string $filepath, int $line) : <a href="http://php.net/manual/en/class.errorexception.php">\ErrorException</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$severity</h4>
<code>int</code>
</div>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$filepath</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$line</h4>
<code>int</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.errorexception.php">\ErrorException</a></code></div>
</div></div>
</div>
<a name="on_exception" id="on_exception"></a><div class="element clickable function on_exception" data-toggle="collapse" data-target=".on_exception .collapse">
<h2>Custom exception handlererror_get_last</h2>
<pre>on_exception(<a href="http://php.net/manual/en/class.exception.php">\Exception</a> $exception) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$exception</h4>
<code><a href="http://php.net/manual/en/class.exception.php">\Exception</a></code>
</div>
</div></div>
</div>
<a name="route" id="route"></a><div class="element clickable function route" data-toggle="collapse" data-target=".route .collapse">
<h2>Calls the appropriate module/controller/function based on the url</h2>
<pre>route() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="show_404" id="show_404"></a><div class="element clickable function show_404" data-toggle="collapse" data-target=".show_404 .collapse">
<h2>General 404 function</h2>
<pre>show_404() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="show_error" id="show_error"></a><div class="element clickable function show_error" data-toggle="collapse" data-target=".show_error .collapse">
<h2>Fatal Error page function</h2>
<pre>show_error(string $message, int $status_code) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$status_code</h4>
<code>int</code>
</div>
</div></div>
</div>
<a name="shutdown" id="shutdown"></a><div class="element clickable function shutdown" data-toggle="collapse" data-target=".shutdown .collapse">
<h2>Function to run on script shutdown
-used to catch most fatal errors, and
display them cleanly</h2>
<pre>shutdown() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="site_url" id="site_url"></a><div class="element clickable function site_url" data-toggle="collapse" data-target=".site_url .collapse">
<h2>Returns a full url from a url segment</h2>
<pre>site_url(string $segment) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$segment</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="to_string" id="to_string"></a><div class="element clickable function to_string" data-toggle="collapse" data-target=".to_string .collapse">
<h2>Prints out the contents of the object</h2>
<pre>to_string(\object/array $data, string $method) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$data</h4>
<code>\object/array</code>
</div>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="DB" id="DB"></a><div class="element ajax clickable class" href="../classes/DB.html">
<h1>DB<a href="../classes/DB.html"></a>
</h1>
<p class="short_description">Extend PHP's PDO class to add some more functionality</p>
<div class="details collapse"></div>
<a href="../classes/DB.html" class="more">« More »</a>
</div>
<a name="DB_PDO" id="DB_PDO"></a><div class="element ajax clickable class" href="../classes/DB_PDO.html">
<h1>DB_PDO<a href="../classes/DB_PDO.html"></a>
</h1>
<p class="short_description">Base Database class</p>
<div class="details collapse"></div>
<a href="../classes/DB_PDO.html" class="more">« More »</a>
</div>
<a name="DB_Reg" id="DB_Reg"></a><div class="element ajax clickable class" href="../classes/DB_Reg.html">
<h1>DB_Reg<a href="../classes/DB_Reg.html"></a>
</h1>
<p class="short_description">Connection registry</p>
<div class="details collapse"></div>
<a href="../classes/DB_Reg.html" class="more">« More »</a>
</div>
<a name="DB_SQL" id="DB_SQL"></a><div class="element ajax clickable class" href="../classes/DB_SQL.html">
<h1>DB_SQL<a href="../classes/DB_SQL.html"></a>
</h1>
<p class="short_description">Abstract parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/DB_SQL.html" class="more">« More »</a>
</div>
<a name="DB_Util" id="DB_Util"></a><div class="element ajax clickable class" href="../classes/DB_Util.html">
<h1>DB_Util<a href="../classes/DB_Util.html"></a>
</h1>
<p class="short_description">Abstract class defining database / table creation methods</p>
<div class="details collapse"></div>
<a href="../classes/DB_Util.html" class="more">« More »</a>
</div>
<a name="Firebird" id="Firebird"></a><div class="element ajax clickable class" href="../classes/Firebird.html">
<h1>Firebird<a href="../classes/Firebird.html"></a>
</h1>
<p class="short_description">Firebird Database class</p>
<div class="details collapse"></div>
<a href="../classes/Firebird.html" class="more">« More »</a>
</div>
<a name="Firebird_Result" id="Firebird_Result"></a><div class="element ajax clickable class" href="../classes/Firebird_Result.html">
<h1>Firebird_Result<a href="../classes/Firebird_Result.html"></a>
</h1>
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods</p>
<div class="details collapse"></div>
<a href="../classes/Firebird_Result.html" class="more">« More »</a>
</div>
<a name="Firebird_SQL" id="Firebird_SQL"></a><div class="element ajax clickable class" href="../classes/Firebird_SQL.html">
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html"></a>
</h1>
<p class="short_description">Firebird Specific SQL</p>
<div class="details collapse"></div>
<a href="../classes/Firebird_SQL.html" class="more">« More »</a>
</div>
<a name="Firebird_Util" id="Firebird_Util"></a><div class="element ajax clickable class" href="../classes/Firebird_Util.html">
<h1>Firebird_Util<a href="../classes/Firebird_Util.html"></a>
</h1>
<p class="short_description">Firebird-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/Firebird_Util.html" class="more">« More »</a>
</div>
<a name="MM" id="MM"></a><div class="element ajax clickable class" href="../classes/MM.html">
<h1>MM<a href="../classes/MM.html"></a>
</h1>
<p class="short_description">Class for standalone JSObject objects</p>
<div class="details collapse"></div>
<a href="../classes/MM.html" class="more">« More »</a>
</div>
<a name="MM_Controller" id="MM_Controller"></a><div class="element ajax clickable class" href="../classes/MM_Controller.html">
<h1>MM_Controller<a href="../classes/MM_Controller.html"></a>
</h1>
<p class="short_description">Base Controller Class</p>
<div class="details collapse"></div>
<a href="../classes/MM_Controller.html" class="more">« More »</a>
</div>
<a name="MM_Model" id="MM_Model"></a><div class="element ajax clickable class" href="../classes/MM_Model.html">
<h1>MM_Model<a href="../classes/MM_Model.html"></a>
</h1>
<p class="short_description">Base Model Class</p>
<div class="details collapse"></div>
<a href="../classes/MM_Model.html" class="more">« More »</a>
</div>
<a name="MM_Output" id="MM_Output"></a><div class="element ajax clickable class" href="../classes/MM_Output.html">
<h1>MM_Output<a href="../classes/MM_Output.html"></a>
</h1>
<p class="short_description">Class for displaying output and setting http headers</p>
<div class="details collapse"></div>
<a href="../classes/MM_Output.html" class="more">« More »</a>
</div>
<a name="MM_Page" id="MM_Page"></a><div class="element ajax clickable class" href="../classes/MM_Page.html">
<h1>MM_Page<a href="../classes/MM_Page.html"></a>
</h1>
<p class="short_description">Class for building pages</p>
<div class="details collapse"></div>
<a href="../classes/MM_Page.html" class="more">« More »</a>
</div>
<a name="MySQL" id="MySQL"></a><div class="element ajax clickable class" href="../classes/MySQL.html">
<h1>MySQL<a href="../classes/MySQL.html"></a>
</h1>
<p class="short_description">MySQL specific class</p>
<div class="details collapse"></div>
<a href="../classes/MySQL.html" class="more">« More »</a>
</div>
<a name="MySQL_SQL" id="MySQL_SQL"></a><div class="element ajax clickable class" href="../classes/MySQL_SQL.html">
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html"></a>
</h1>
<p class="short_description">MySQL specifc SQL</p>
<div class="details collapse"></div>
<a href="../classes/MySQL_SQL.html" class="more">« More »</a>
</div>
<a name="MySQL_Util" id="MySQL_Util"></a><div class="element ajax clickable class" href="../classes/MySQL_Util.html">
<h1>MySQL_Util<a href="../classes/MySQL_Util.html"></a>
</h1>
<p class="short_description">MySQL-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/MySQL_Util.html" class="more">« More »</a>
</div>
<a name="ODBC" id="ODBC"></a><div class="element ajax clickable class" href="../classes/ODBC.html">
<h1>ODBC<a href="../classes/ODBC.html"></a>
</h1>
<p class="short_description">ODBC Database Driver</p>
<div class="details collapse"></div>
<a href="../classes/ODBC.html" class="more">« More »</a>
</div>
<a name="ODBC_SQL" id="ODBC_SQL"></a><div class="element ajax clickable class" href="../classes/ODBC_SQL.html">
<h1>ODBC_SQL<a href="../classes/ODBC_SQL.html"></a>
</h1>
<p class="short_description">ODBC SQL Class</p>
<div class="details collapse"></div>
<a href="../classes/ODBC_SQL.html" class="more">« More »</a>
</div>
<a name="ODBC_Util" id="ODBC_Util"></a><div class="element ajax clickable class" href="../classes/ODBC_Util.html">
<h1>ODBC_Util<a href="../classes/ODBC_Util.html"></a>
</h1>
<p class="short_description">ODBC-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/ODBC_Util.html" class="more">« More »</a>
</div>
<a name="PgSQL" id="PgSQL"></a><div class="element ajax clickable class" href="../classes/PgSQL.html">
<h1>PgSQL<a href="../classes/PgSQL.html"></a>
</h1>
<p class="short_description">PostgreSQL specifc class</p>
<div class="details collapse"></div>
<a href="../classes/PgSQL.html" class="more">« More »</a>
</div>
<a name="PgSQL_SQL" id="PgSQL_SQL"></a><div class="element ajax clickable class" href="../classes/PgSQL_SQL.html">
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html"></a>
</h1>
<p class="short_description">PostgreSQL specifc SQL</p>
<div class="details collapse"></div>
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
</div>
<a name="PgSQL_Util" id="PgSQL_Util"></a><div class="element ajax clickable class" href="../classes/PgSQL_Util.html">
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html"></a>
</h1>
<p class="short_description">Posgres-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/PgSQL_Util.html" class="more">« More »</a>
</div>
<a name="Query_Builder" id="Query_Builder"></a><div class="element ajax clickable class" href="../classes/Query_Builder.html">
<h1>Query_Builder<a href="../classes/Query_Builder.html"></a>
</h1>
<p class="short_description">Convienience class for creating sql queries - also the class that
instantiates the specific db driver</p>
<div class="details collapse"></div>
<a href="../classes/Query_Builder.html" class="more">« More »</a>
</div>
<a name="SQLite" id="SQLite"></a><div class="element ajax clickable class" href="../classes/SQLite.html">
<h1>SQLite<a href="../classes/SQLite.html"></a>
</h1>
<p class="short_description">SQLite specific class</p>
<div class="details collapse"></div>
<a href="../classes/SQLite.html" class="more">« More »</a>
</div>
<a name="SQLite_SQL" id="SQLite_SQL"></a><div class="element ajax clickable class" href="../classes/SQLite_SQL.html">
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html"></a>
</h1>
<p class="short_description">SQLite Specific SQL</p>
<div class="details collapse"></div>
<a href="../classes/SQLite_SQL.html" class="more">« More »</a>
</div>
<a name="SQLite_Util" id="SQLite_Util"></a><div class="element ajax clickable class" href="../classes/SQLite_Util.html">
<h1>SQLite_Util<a href="../classes/SQLite_Util.html"></a>
</h1>
<p class="short_description">SQLite-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/SQLite_Util.html" class="more">« More »</a>
</div>
<a name="Settings" id="Settings"></a><div class="element ajax clickable class" href="../classes/Settings.html">
<h1>Settings<a href="../classes/Settings.html"></a>
</h1>
<p class="short_description">Class for manipulating datbase connections, and miscellaneous settings</p>
<div class="details collapse"></div>
<a href="../classes/Settings.html" class="more">« More »</a>
</div>
<a name="Welcome" id="Welcome"></a><div class="element ajax clickable class" href="../classes/Welcome.html">
<h1>Welcome<a href="../classes/Welcome.html"></a>
</h1>
<p class="short_description">Example Controller Class</p>
<div class="details collapse"></div>
<a href="../classes/Welcome.html" class="more">« More »</a>
</div>
<a name="Welcome_Model" id="Welcome_Model"></a><div class="element ajax clickable class" href="../classes/Welcome_Model.html">
<h1>Welcome_Model<a href="../classes/Welcome_Model.html"></a>
</h1>
<p class="short_description">Model template class</p>
<div class="details collapse"></div>
<a href="../classes/Welcome_Model.html" class="more">« More »</a>
</div>
<a name="miniMVC" id="miniMVC"></a><div class="element ajax clickable class" href="../classes/miniMVC.html">
<h1>miniMVC<a href="../classes/miniMVC.html"></a>
</h1>
<p class="short_description">Base class for the framework</p>
<div class="details collapse"></div>
<a href="../classes/miniMVC.html" class="more">« More »</a>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="BASE_URL" id="BASE_URL"> </a><div class="element clickable constant BASE_URL" data-toggle="collapse" data-target=".BASE_URL .collapse">
<h2>BASE_URL</h2>
<pre>BASE_URL </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="CONTENT_DOMAIN" id="CONTENT_DOMAIN"> </a><div class="element clickable constant CONTENT_DOMAIN" data-toggle="collapse" data-target=".CONTENT_DOMAIN .collapse">
<h2>CONTENT_DOMAIN</h2>
<pre>CONTENT_DOMAIN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="DEFAULT_CSS_GROUP" id="DEFAULT_CSS_GROUP"> </a><div class="element clickable constant DEFAULT_CSS_GROUP" data-toggle="collapse" data-target=".DEFAULT_CSS_GROUP .collapse">
<h2>DEFAULT_CSS_GROUP</h2>
<pre>DEFAULT_CSS_GROUP </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="DEFAULT_JS_GROUP" id="DEFAULT_JS_GROUP"> </a><div class="element clickable constant DEFAULT_JS_GROUP" data-toggle="collapse" data-target=".DEFAULT_JS_GROUP .collapse">
<h2>DEFAULT_JS_GROUP</h2>
<pre>DEFAULT_JS_GROUP </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="DEFAULT_TITLE" id="DEFAULT_TITLE"> </a><div class="element clickable constant DEFAULT_TITLE" data-toggle="collapse" data-target=".DEFAULT_TITLE .collapse">
<h2>DEFAULT_TITLE</h2>
<pre>DEFAULT_TITLE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="ENVIRONMENT" id="ENVIRONMENT"> </a><div class="element clickable constant ENVIRONMENT" data-toggle="collapse" data-target=".ENVIRONMENT .collapse">
<h2>miniMVC bootstrap file</h2>
<pre>ENVIRONMENT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/miniMVC.App.html">miniMVC</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>App</td>
</tr>
</table>
</div></div>
</div>
<a name="MM_APP_PATH" id="MM_APP_PATH"> </a><div class="element clickable constant MM_APP_PATH" data-toggle="collapse" data-target=".MM_APP_PATH .collapse">
<h2>MM_APP_PATH</h2>
<pre>MM_APP_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="MM_BASE_PATH" id="MM_BASE_PATH"> </a><div class="element clickable constant MM_BASE_PATH" data-toggle="collapse" data-target=".MM_BASE_PATH .collapse">
<h2>MM_BASE_PATH</h2>
<pre>MM_BASE_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="MM_MOD_PATH" id="MM_MOD_PATH"> </a><div class="element clickable constant MM_MOD_PATH" data-toggle="collapse" data-target=".MM_MOD_PATH .collapse">
<h2>MM_MOD_PATH</h2>
<pre>MM_MOD_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="MM_SYS_PATH" id="MM_SYS_PATH"> </a><div class="element clickable constant MM_SYS_PATH" data-toggle="collapse" data-target=".MM_SYS_PATH .collapse">
<h2>MM_SYS_PATH</h2>
<pre>MM_SYS_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="QBASE_PATH" id="QBASE_PATH"> </a><div class="element clickable constant QBASE_PATH" data-toggle="collapse" data-target=".QBASE_PATH .collapse">
<h2>Reference to root path</h2>
<pre>QBASE_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="QDRIVER_PATH" id="QDRIVER_PATH"> </a><div class="element clickable constant QDRIVER_PATH" data-toggle="collapse" data-target=".QDRIVER_PATH .collapse">
<h2>Path to driver classes</h2>
<pre>QDRIVER_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="SCRIPT_PATH" id="SCRIPT_PATH"> </a><div class="element clickable constant SCRIPT_PATH" data-toggle="collapse" data-target=".SCRIPT_PATH .collapse">
<h2>SCRIPT_PATH</h2>
<pre>SCRIPT_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="SHOW_DEBUG_BACKTRACE" id="SHOW_DEBUG_BACKTRACE"> </a><div class="element clickable constant SHOW_DEBUG_BACKTRACE" data-toggle="collapse" data-target=".SHOW_DEBUG_BACKTRACE .collapse">
<h2>Main config file</h2>
<pre>SHOW_DEBUG_BACKTRACE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/miniMVC.App.html">miniMVC</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>App</td>
</tr>
</table>
</div></div>
</div>
<a name="STATIC_LIB_PATH" id="STATIC_LIB_PATH"> </a><div class="element clickable constant STATIC_LIB_PATH" data-toggle="collapse" data-target=".STATIC_LIB_PATH .collapse">
<h2>STATIC_LIB_PATH</h2>
<pre>STATIC_LIB_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="STYLE_PATH" id="STYLE_PATH"> </a><div class="element clickable constant STYLE_PATH" data-toggle="collapse" data-target=".STYLE_PATH .collapse">
<h2>STYLE_PATH</h2>
<pre>STYLE_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="URL_INDEX_FILE" id="URL_INDEX_FILE"> </a><div class="element clickable constant URL_INDEX_FILE" data-toggle="collapse" data-target=".URL_INDEX_FILE .collapse">
<h2>URL_INDEX_FILE</h2>
<pre>URL_INDEX_FILE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-05-03T11:38:41-04:00.<br></footer></div>
</div>
</body>
</html>