update docs

This commit is contained in:
Timothy Warren 2012-05-21 14:51:07 -04:00
parent f5537bdea4
commit 7b4c4afaad
23 changed files with 1188 additions and 908 deletions

View File

@ -19,112 +19,112 @@
<polyline fill="none" stroke="none" points="206,-354 206,-56 "/>
<path fill="none" stroke="none" d="M206,-56C206,-50 212,-44 218,-44"/>
</g>
<!-- \\MM_Model -->
<g id="node2" class="node"><title>\\MM_Model</title>
<a xlink:href="sys.core.model.html" xlink:title="MM_Model" target="_parent">
<polygon fill="none" stroke="black" points="662,-358 592,-358 592,-322 662,-322 662,-358"/>
<text text-anchor="middle" x="627" y="-336.6" font-family="Courier,monospace" font-size="11.00">MM_Model</text>
<!-- \\MM_Page -->
<g id="node2" class="node"><title>\\MM_Page</title>
<a xlink:href="sys.core.MM_Page.html" xlink:title="MM_Page" target="_parent">
<polygon fill="none" stroke="black" points="659,-358 595,-358 595,-322 659,-322 659,-358"/>
<text text-anchor="middle" x="627" y="-336.6" font-family="Courier,monospace" font-size="11.00">MM_Page</text>
</a>
</g>
<!-- \\MM_Output -->
<g id="node3" class="node"><title>\\MM_Output</title>
<a xlink:href="sys.core.MM_Output.html" xlink:title="MM_Output" target="_parent">
<polygon fill="none" stroke="black" points="460,-358 382,-358 382,-322 460,-322 460,-358"/>
<text text-anchor="middle" x="421" y="-336.6" font-family="Courier,monospace" font-size="11.00">MM_Output</text>
</a>
</g>
<!-- \\MM_Page&#45;&gt;\\MM_Output -->
<g id="edge3" class="edge"><title>\\MM_Page&#45;&gt;\\MM_Output</title>
<path fill="none" stroke="black" d="M594.359,-340C561.071,-340 509.002,-340 470.611,-340"/>
<polygon fill="none" stroke="black" points="470.172,-336.5 460.172,-340 470.172,-343.5 470.172,-336.5"/>
</g>
<!-- \\MM -->
<g id="node7" class="node"><title>\\MM</title>
<a xlink:href="sys.core.MM.html" xlink:title="MM" target="_parent">
<polygon fill="none" stroke="black" points="268,-331 214,-331 214,-295 268,-295 268,-331"/>
<text text-anchor="middle" x="241" y="-309.6" font-family="Courier,monospace" font-size="11.00">MM</text>
</a>
</g>
<!-- \\MM_Output&#45;&gt;\\MM -->
<g id="edge5" class="edge"><title>\\MM_Output&#45;&gt;\\MM</title>
<path fill="none" stroke="black" d="M381.943,-334.141C351.143,-329.521 308.474,-323.121 278.173,-318.576"/>
<polygon fill="none" stroke="black" points="278.419,-315.074 268.01,-317.052 277.38,-321.996 278.419,-315.074"/>
</g>
<!-- \\MM_Controller -->
<g id="node4" class="node"><title>\\MM_Controller</title>
<a xlink:href="sys.core.MM_Controller.html" xlink:title="MM_Controller" target="_parent">
<polygon fill="none" stroke="black" points="679,-304 575,-304 575,-268 679,-268 679,-304"/>
<text text-anchor="middle" x="627" y="-282.6" font-family="Courier,monospace" font-size="11.00">MM_Controller</text>
</a>
</g>
<!-- \\miniMVC -->
<g id="node4" class="node"><title>\\miniMVC</title>
<g id="node6" class="node"><title>\\miniMVC</title>
<a xlink:href="sys.core.miniMVC.html" xlink:title="miniMVC" target="_parent">
<polygon fill="none" stroke="black" points="453,-304 389,-304 389,-268 453,-268 453,-304"/>
<text text-anchor="middle" x="421" y="-282.6" font-family="Courier,monospace" font-size="11.00">miniMVC</text>
</a>
</g>
<!-- \\MM_Model&#45;&gt;\\miniMVC -->
<g id="edge3" class="edge"><title>\\MM_Model&#45;&gt;\\miniMVC</title>
<path fill="none" stroke="black" d="M591.118,-330.594C555.563,-321.274 501.109,-306.999 463.429,-297.122"/>
<polygon fill="none" stroke="black" points="464.316,-293.736 453.755,-294.586 462.541,-300.508 464.316,-293.736"/>
<!-- \\MM_Controller&#45;&gt;\\miniMVC -->
<g id="edge7" class="edge"><title>\\MM_Controller&#45;&gt;\\miniMVC</title>
<path fill="none" stroke="black" d="M574.484,-286C540.32,-286 496.311,-286 464.184,-286"/>
<polygon fill="none" stroke="black" points="463.776,-282.5 453.776,-286 463.776,-289.5 463.776,-282.5"/>
</g>
<!-- \\DB -->
<g id="node3" class="node"><title>\\DB</title>
<g id="node5" class="node"><title>\\DB</title>
<a xlink:href="sys.core.db.html" xlink:title="DB" target="_parent">
<polygon fill="none" stroke="black" points="654,-196 600,-196 600,-160 654,-160 654,-196"/>
<text text-anchor="middle" x="627" y="-174.6" font-family="Courier,monospace" font-size="11.00">DB</text>
</a>
</g>
<!-- \\Query_Builder -->
<g id="node13" class="node"><title>\\Query_Builder</title>
<g id="node15" class="node"><title>\\Query_Builder</title>
<ellipse fill="none" stroke="black" cx="421" cy="-18" rx="81.1693" ry="18"/>
<text text-anchor="middle" x="421" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\Query_Builder</text>
</g>
<!-- \\DB&#45;&gt;\\Query_Builder -->
<g id="edge5" class="edge"><title>\\DB&#45;&gt;\\Query_Builder</title>
<g id="edge9" class="edge"><title>\\DB&#45;&gt;\\Query_Builder</title>
<path fill="none" stroke="black" d="M599.947,-167.581C591.048,-163.318 581.519,-157.773 574,-151 530.31,-111.643 549.504,-74.6572 502,-40 498.936,-37.7643 495.657,-35.7559 492.239,-33.9515"/>
<polygon fill="none" stroke="black" points="493.464,-30.6617 482.919,-29.6361 490.523,-37.0139 493.464,-30.6617"/>
</g>
<!-- \\MM -->
<g id="node6" class="node"><title>\\MM</title>
<a xlink:href="sys.core.MM.html" xlink:title="MM" target="_parent">
<polygon fill="none" stroke="black" points="268,-277 214,-277 214,-241 268,-241 268,-277"/>
<text text-anchor="middle" x="241" y="-255.6" font-family="Courier,monospace" font-size="11.00">MM</text>
</a>
</g>
<!-- \\miniMVC&#45;&gt;\\MM -->
<g id="edge7" class="edge"><title>\\miniMVC&#45;&gt;\\MM</title>
<path fill="none" stroke="black" d="M388.403,-281.111C357.322,-276.448 310.563,-269.434 278.075,-264.561"/>
<polygon fill="none" stroke="black" points="278.475,-261.082 268.067,-263.06 277.437,-268.005 278.475,-261.082"/>
</g>
<!-- \\MM_Page -->
<g id="node5" class="node"><title>\\MM_Page</title>
<a xlink:href="sys.core.page.html" xlink:title="MM_Page" target="_parent">
<polygon fill="none" stroke="black" points="659,-250 595,-250 595,-214 659,-214 659,-250"/>
<text text-anchor="middle" x="627" y="-228.6" font-family="Courier,monospace" font-size="11.00">MM_Page</text>
</a>
</g>
<!-- \\MM_Output -->
<g id="node8" class="node"><title>\\MM_Output</title>
<a xlink:href="sys.core.output.html" xlink:title="MM_Output" target="_parent">
<polygon fill="none" stroke="black" points="460,-250 382,-250 382,-214 460,-214 460,-250"/>
<text text-anchor="middle" x="421" y="-228.6" font-family="Courier,monospace" font-size="11.00">MM_Output</text>
</a>
</g>
<!-- \\MM_Page&#45;&gt;\\MM_Output -->
<g id="edge9" class="edge"><title>\\MM_Page&#45;&gt;\\MM_Output</title>
<path fill="none" stroke="black" d="M594.359,-232C561.071,-232 509.002,-232 470.611,-232"/>
<polygon fill="none" stroke="black" points="470.172,-228.5 460.172,-232 470.172,-235.5 470.172,-228.5"/>
<g id="edge11" class="edge"><title>\\miniMVC&#45;&gt;\\MM</title>
<path fill="none" stroke="black" d="M388.403,-290.889C357.322,-295.552 310.563,-302.566 278.075,-307.439"/>
<polygon fill="none" stroke="black" points="277.437,-303.995 268.067,-308.94 278.475,-310.918 277.437,-303.995"/>
</g>
<!-- \\ArrayObject -->
<g id="node17" class="node"><title>\\ArrayObject</title>
<ellipse fill="none" stroke="black" cx="71" cy="-259" rx="71.107" ry="18"/>
<text text-anchor="middle" x="71" y="-254.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\ArrayObject</text>
<g id="node18" class="node"><title>\\ArrayObject</title>
<ellipse fill="none" stroke="black" cx="71" cy="-313" rx="71.107" ry="18"/>
<text text-anchor="middle" x="71" y="-308.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\ArrayObject</text>
</g>
<!-- \\MM&#45;&gt;\\ArrayObject -->
<g id="edge11" class="edge"><title>\\MM&#45;&gt;\\ArrayObject</title>
<path fill="none" stroke="black" d="M213.687,-259C196.92,-259 174.483,-259 152.374,-259"/>
<polygon fill="none" stroke="black" points="152.26,-255.5 142.26,-259 152.26,-262.5 152.26,-255.5"/>
<g id="edge13" class="edge"><title>\\MM&#45;&gt;\\ArrayObject</title>
<path fill="none" stroke="black" d="M213.687,-313C196.92,-313 174.483,-313 152.374,-313"/>
<polygon fill="none" stroke="black" points="152.26,-309.5 142.26,-313 152.26,-316.5 152.26,-309.5"/>
</g>
<!-- \\MM_Controller -->
<g id="node7" class="node"><title>\\MM_Controller</title>
<a xlink:href="sys.core.controller.html" xlink:title="MM_Controller" target="_parent">
<polygon fill="none" stroke="black" points="679,-304 575,-304 575,-268 679,-268 679,-304"/>
<text text-anchor="middle" x="627" y="-282.6" font-family="Courier,monospace" font-size="11.00">MM_Controller</text>
<!-- \\MM_Model -->
<g id="node8" class="node"><title>\\MM_Model</title>
<a xlink:href="sys.core.MM_Model.html" xlink:title="MM_Model" target="_parent">
<polygon fill="none" stroke="black" points="662,-250 592,-250 592,-214 662,-214 662,-250"/>
<text text-anchor="middle" x="627" y="-228.6" font-family="Courier,monospace" font-size="11.00">MM_Model</text>
</a>
</g>
<!-- \\MM_Controller&#45;&gt;\\miniMVC -->
<g id="edge13" class="edge"><title>\\MM_Controller&#45;&gt;\\miniMVC</title>
<path fill="none" stroke="black" d="M574.484,-286C540.32,-286 496.311,-286 464.184,-286"/>
<polygon fill="none" stroke="black" points="463.776,-282.5 453.776,-286 463.776,-289.5 463.776,-282.5"/>
<!-- \\MM_Model&#45;&gt;\\miniMVC -->
<g id="edge15" class="edge"><title>\\MM_Model&#45;&gt;\\miniMVC</title>
<path fill="none" stroke="black" d="M591.118,-241.406C555.563,-250.726 501.109,-265.001 463.429,-274.878"/>
<polygon fill="none" stroke="black" points="462.541,-271.492 453.755,-277.414 464.316,-278.264 462.541,-271.492"/>
</g>
<!-- \\MM_Output&#45;&gt;\\MM -->
<g id="edge15" class="edge"><title>\\MM_Output&#45;&gt;\\MM</title>
<path fill="none" stroke="black" d="M381.943,-237.859C351.143,-242.479 308.474,-248.879 278.173,-253.424"/>
<polygon fill="none" stroke="black" points="277.38,-250.004 268.01,-254.948 278.419,-256.926 277.38,-250.004"/>
</g>
<!-- \\MM_Data_Store -->
<g id="node9" class="node"><title>\\MM_Data_Store</title>
<a xlink:href="sys.libraries.data_store.html" xlink:title="MM_Data_Store" target="_parent">
<polygon fill="none" stroke="black" points="679,-142 575,-142 575,-106 679,-106 679,-142"/>
<text text-anchor="middle" x="627" y="-120.6" font-family="Courier,monospace" font-size="11.00">MM_Data_Store</text>
<!-- \\Data_Store -->
<g id="node9" class="node"><title>\\Data_Store</title>
<a xlink:href="sys.libraries.data_store.html" xlink:title="Data_Store" target="_parent">
<polygon fill="none" stroke="black" points="669,-142 585,-142 585,-106 669,-106 669,-142"/>
<text text-anchor="middle" x="627" y="-120.6" font-family="Courier,monospace" font-size="11.00">Data_Store</text>
</a>
</g>
<!-- \\MM_Session -->
<g id="node10" class="node"><title>\\MM_Session</title>
<a xlink:href="sys.libraries.session.html" xlink:title="MM_Session" target="_parent">
<polygon fill="none" stroke="black" points="669,-88 585,-88 585,-52 669,-52 669,-88"/>
<text text-anchor="middle" x="627" y="-66.6" font-family="Courier,monospace" font-size="11.00">MM_Session</text>
<!-- \\Session -->
<g id="node10" class="node"><title>\\Session</title>
<a xlink:href="sys.libraries.session.html" xlink:title="Session" target="_parent">
<polygon fill="none" stroke="black" points="659,-88 595,-88 595,-52 659,-52 659,-88"/>
<text text-anchor="middle" x="627" y="-66.6" font-family="Courier,monospace" font-size="11.00">Session</text>
</a>
</g>
</g>

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 7.2 KiB

View File

@ -56,8 +56,6 @@
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__call" title="__call :: Override __call in trait to call __call in Query Builder...lol"><span class="description">Override __call in trait to call __call in Query Builder...lol</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Constructor to override JSObject trait"><span class="description">Constructor to override JSObject trait</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#get_instance" title="get_instance :: Indexed singleton method"><span class="description">Indexed singleton method</span><pre>get_instance()</pre></a></li>
<li class="method public "><a href="#get_last_error" title="get_last_error :: Returns the last error from the database"><span class="description">Returns the last error from the database</span><pre>get_last_error()</pre></a></li>
<li class="nav-header">
@ -83,38 +81,6 @@
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
<h2>Override __call in trait to call __call in Query Builder...lol</h2>
<pre>__call(string $name, array $params) : mixed</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>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Constructor to override JSObject trait</h2>
<pre>__construct(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>$params</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="get_instance" id="get_instance"></a><div class="element clickable method public get_instance" data-toggle="collapse" data-target=".get_instance .collapse">
<h2>Indexed singleton method</h2>
<pre>get_instance(string $dbname, array $options) : <a href="../classes/DB.html">\DB</a></pre>
@ -159,7 +125,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -0,0 +1,205 @@
<!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 » \Data_Store</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/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">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><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-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__clone" title="__clone :: Magic function called when cloning an object"><span class="description">Magic function called when cloning an object</span><pre>__clone()</pre></a></li>
<li class="method public "><a href="#__destruct" title="__destruct :: Output the data on destruct"><span class="description">Output the data on destruct</span><pre>__destruct()</pre></a></li>
<li class="method public "><a href="#__get" title="__get :: Magic method to simplify isset checking for config options"><span class="description">Magic method to simplify isset checking for config options</span><pre>__get()</pre></a></li>
<li class="method public "><a href="#__set" title="__set :: Magic method to simplify setting config options"><span class="description">Magic method to simplify setting config options</span><pre>__set()</pre></a></li>
<li class="method public "><a href="#del" title="del :: Removes a key from the data store"><span class="description">Removes a key from the data store</span><pre>del()</pre></a></li>
<li class="method public "><a href="#get_all" title="get_all :: Return the entire data store object"><span class="description">Return the entire data store object</span><pre>get_all()</pre></a></li>
<li class="method public "><a href="#get_instance" title="get_instance :: Static method to retreive current instance
of the singleton"><span class="description">Static method to retreive current instance
of the singleton</span><pre>get_instance()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><a href="#__construct" title="__construct :: Create and/or load json file"><span class="description">Create and/or load json file</span><pre>__construct()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24current" title="$current :: Settings object represented by the currently loaded JSON file"><span class="description">Settings object represented by the currently loaded JSON file</span><pre>$current</pre></a></li>
<li class="property private "><a href="#%24instance" title="$instance :: Singleton instance"><span class="description">Singleton instance</span><pre>$instance</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CData_Store" id="\Data_Store"></a><div href="../classes/Data_Store.html" class="element class">
<p class="short_description">Class for using JSON as a key->value data store</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/miniMVC.Libraries.html">miniMVC</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Libraries</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__clone" id="__clone"></a><div class="element clickable method public __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="__destruct" id="__destruct"></a><div class="element clickable method public __destruct" data-toggle="collapse" data-target=".__destruct .collapse">
<h2>Output the data on destruct</h2>
<pre>__destruct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="__get" id="__get"></a><div class="element clickable method public __get" data-toggle="collapse" data-target=".__get .collapse">
<h2>Magic method to simplify isset checking for config options</h2>
<pre>__get(string $key) : mixed</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>$key</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="__set" id="__set"></a><div class="element clickable method public __set" data-toggle="collapse" data-target=".__set .collapse">
<h2>Magic method to simplify setting config options</h2>
<pre>__set(string $key, $val) </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>$key</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code></code><p>mixed</p></div>
</div></div>
</div>
<a name="del" id="del"></a><div class="element clickable method public del" data-toggle="collapse" data-target=".del .collapse">
<h2>Removes a key from the data store</h2>
<pre>del(string $key) : 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>$key</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="get_all" id="get_all"></a><div class="element clickable method public get_all" data-toggle="collapse" data-target=".get_all .collapse">
<h2>Return the entire data store object</h2>
<pre>get_all() : object</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>object</code></div>
</div></div>
</div>
<a name="get_instance" id="get_instance"></a><div class="element clickable method public get_instance" data-toggle="collapse" data-target=".get_instance .collapse">
<h2>Static method to retreive current instance
of the singleton</h2>
<pre>get_instance() : <a href="../classes/Data_Store.html">\Data_Store</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Data_Store.html">\Data_Store</a></code></div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method protected __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Create and/or load json file</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24current" id="$current"> </a><div class="element clickable property private $current" data-toggle="collapse" data-target=".$current .collapse">
<h2>Settings object represented by the currently loaded JSON file</h2>
<pre>$current </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24instance" id="$instance"> </a><div class="element clickable property private $instance" data-toggle="collapse" data-target=".$instance .collapse">
<h2>Singleton instance</h2>
<pre>$instance </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></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-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -433,7 +433,7 @@ dynamic methods</h2>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -78,7 +78,6 @@ dynamic methods</span><pre>__call()</pre></a></li>
</span><pre>getIteratorClass()</pre></a></li>
<li class="method public inherited"><a href="#ksort" title="ksort :: "><span class="description">ksort()
</span><pre>ksort()</pre></a></li>
<li class="method public inherited"><a href="#load_class" title="load_class :: Method to load classes into the singleton"><span class="description">Method to load classes into the singleton</span><pre>load_class()</pre></a></li>
<li class="method public inherited"><a href="#load_config" title="load_config :: Convenience function to load config files"><span class="description">Convenience function to load config files</span><pre>load_config()</pre></a></li>
<li class="method public "><a href="#load_model" title="load_model :: Function for loading a model into the current class"><span class="description">Function for loading a model into the current class</span><pre>load_model()</pre></a></li>
<li class="method public "><a href="#load_view" title="load_view :: Function for loading a view"><span class="description">Function for loading a view</span><pre>load_view()</pre></a></li>
@ -373,25 +372,6 @@ dynamic methods</h2>
</table>
</div></div>
</div>
<a name="load_class" id="load_class"></a><div class="element clickable method public load_class" data-toggle="collapse" data-target=".load_class .collapse">
<h2>Method to load classes into the singleton</h2>
<pre>load_class(string $name) : object</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\miniMVC::load_class()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>object</code></div>
</div></div>
</div>
<a name="load_config" id="load_config"></a><div class="element clickable method public load_config" data-toggle="collapse" data-target=".load_config .collapse">
<h2>Convenience function to load config files</h2>
<pre>load_config(string $name) </pre>
@ -757,7 +737,7 @@ dynamic methods</h2>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -78,7 +78,6 @@ dynamic methods</span><pre>__call()</pre></a></li>
</span><pre>getIteratorClass()</pre></a></li>
<li class="method public inherited"><a href="#ksort" title="ksort :: "><span class="description">ksort()
</span><pre>ksort()</pre></a></li>
<li class="method public inherited"><a href="#load_class" title="load_class :: Method to load classes into the singleton"><span class="description">Method to load classes into the singleton</span><pre>load_class()</pre></a></li>
<li class="method public inherited"><a href="#load_config" title="load_config :: Convenience function to load config files"><span class="description">Convenience function to load config files</span><pre>load_config()</pre></a></li>
<li class="method public inherited"><a href="#natcasesort" title="natcasesort :: "><span class="description">natcasesort()
</span><pre>natcasesort()</pre></a></li>
@ -374,25 +373,6 @@ dynamic methods</h2>
</table>
</div></div>
</div>
<a name="load_class" id="load_class"></a><div class="element clickable method public load_class" data-toggle="collapse" data-target=".load_class .collapse">
<h2>Method to load classes into the singleton</h2>
<pre>load_class(string $name) : object</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\miniMVC::load_class()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>object</code></div>
</div></div>
</div>
<a name="load_config" id="load_config"></a><div class="element clickable method public load_config" data-toggle="collapse" data-target=".load_config .collapse">
<h2>Convenience function to load config files</h2>
<pre>load_config(string $name) </pre>
@ -710,7 +690,7 @@ dynamic methods</h2>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -639,7 +639,7 @@ Used for outputing HTML</h2>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -60,9 +60,7 @@
dynamic methods"><span class="description">Allow calling of array methods on the object and
dynamic methods</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Set up the page class"><span class="description">Set up the page class</span><pre>__construct()</pre></a></li>
<li class="method public inherited"><a href="#__destruct" title="__destruct :: PHP magic method called when ending the script
Used for outputing HTML"><span class="description">PHP magic method called when ending the script
Used for outputing HTML</span><pre>__destruct()</pre></a></li>
<li class="method public "><a href="#__destruct" title="__destruct :: call the parent destructor"><span class="description">call the parent destructor</span><pre>__destruct()</pre></a></li>
<li class="method public inherited"><a href="#append" title="append :: "><span class="description">append()
</span><pre>append()</pre></a></li>
<li class="method public inherited"><a href="#append_output" title="append_output :: Adds text to the output buffer"><span class="description">Adds text to the output buffer</span><pre>append_output()</pre></a></li>
@ -207,17 +205,10 @@ dynamic methods</h2>
</div></div>
</div>
<a name="__destruct" id="__destruct"></a><div class="element clickable method public __destruct" data-toggle="collapse" data-target=".__destruct .collapse">
<h2>PHP magic method called when ending the script
Used for outputing HTML</h2>
<h2>call the parent destructor</h2>
<pre>__destruct() : void</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\MM_Output::__destruct()</td>
</tr></table>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="append" id="append"></a><div class="element clickable method public append" data-toggle="collapse" data-target=".append .collapse">
<h2>append()
@ -1174,7 +1165,7 @@ supports</p></p>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

149
docs/classes/Session.html Normal file
View File

@ -0,0 +1,149 @@
<!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 » \Session</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/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">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><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-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__get" title="__get :: Retreive a session value"><span class="description">Retreive a session value</span><pre>__get()</pre></a></li>
<li class="method public "><a href="#__set" title="__set :: Set a session value"><span class="description">Set a session value</span><pre>__set()</pre></a></li>
<li class="method public "><a href="#destroy" title="destroy :: Destroy a session"><span class="description">Destroy a session</span><pre>destroy()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><a href="#__construct" title="__construct :: Start a session"><span class="description">Start a session</span><pre>__construct()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24sess" title="$sess :: Reference to session superglobal"><span class="description">Reference to session superglobal</span><pre>$sess</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CSession" id="\Session"></a><div href="../classes/Session.html" class="element class">
<p class="short_description">Class to improve handling of PHP sessions</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/miniMVC.Libraries.html">miniMVC</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Libraries</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__get" id="__get"></a><div class="element clickable method public __get" data-toggle="collapse" data-target=".__get .collapse">
<h2>Retreive a session value</h2>
<pre>__get(string $key) : mixed</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>$key</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="__set" id="__set"></a><div class="element clickable method public __set" data-toggle="collapse" data-target=".__set .collapse">
<h2>Set a session value</h2>
<pre>__set(string $key, mixed $val) : 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>$key</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>mixed</code>
</div>
</div></div>
</div>
<a name="destroy" id="destroy"></a><div class="element clickable method public destroy" data-toggle="collapse" data-target=".destroy .collapse">
<h2>Destroy a session</h2>
<pre>destroy() : void</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 method protected __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Start a session</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24sess" id="$sess"> </a><div class="element clickable property protected $sess" data-toggle="collapse" data-target=".$sess .collapse">
<h2>Reference to session superglobal</h2>
<pre>$sess : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></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-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -78,7 +78,6 @@ dynamic methods</span><pre>__call()</pre></a></li>
</span><pre>getIteratorClass()</pre></a></li>
<li class="method public inherited"><a href="#ksort" title="ksort :: "><span class="description">ksort()
</span><pre>ksort()</pre></a></li>
<li class="method public "><a href="#load_class" title="load_class :: Method to load classes into the singleton"><span class="description">Method to load classes into the singleton</span><pre>load_class()</pre></a></li>
<li class="method public "><a href="#load_config" title="load_config :: Convenience function to load config files"><span class="description">Convenience function to load config files</span><pre>load_config()</pre></a></li>
<li class="method public inherited"><a href="#natcasesort" title="natcasesort :: "><span class="description">natcasesort()
</span><pre>natcasesort()</pre></a></li>
@ -332,21 +331,6 @@ dynamic methods</h2>
</table>
</div></div>
</div>
<a name="load_class" id="load_class"></a><div class="element clickable method public load_class" data-toggle="collapse" data-target=".load_class .collapse">
<h2>Method to load classes into the singleton</h2>
<pre>load_class(string $name) : object</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>
<h3>Returns</h3>
<div class="subelement response"><code>object</code></div>
</div></div>
</div>
<a name="load_config" id="load_config"></a><div class="element clickable method public load_config" data-toggle="collapse" data-target=".load_config .collapse">
<h2>Convenience function to load config files</h2>
<pre>load_config(string $name) </pre>
@ -608,7 +592,7 @@ dynamic methods</h2>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -66,7 +66,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -81,7 +81,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -63,7 +63,7 @@
</script><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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -78,7 +78,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -68,7 +68,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -125,6 +125,18 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="autoload" id="autoload"></a><div class="element clickable function autoload" data-toggle="collapse" data-target=".autoload .collapse">
<h2>Function to autoload libraries/classes</h2>
<pre>autoload($name) </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></code><p>string</p></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>
@ -276,6 +288,18 @@ display them cleanly</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sys_autoload" id="sys_autoload"></a><div class="element clickable function sys_autoload" data-toggle="collapse" data-target=".sys_autoload .collapse">
<h2>Function to autoload system libraries</h2>
<pre>sys_autoload($name) </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></code><p>string</p></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>
@ -304,6 +328,13 @@ display them cleanly</h2>
<div class="details collapse"></div>
<a href="../classes/DB.html" class="more">« More »</a>
</div>
<a name="Data_Store" id="Data_Store"></a><div class="element ajax clickable class" href="../classes/Data_Store.html">
<h1>Data_Store<a href="../classes/Data_Store.html"></a>
</h1>
<p class="short_description">Class for using JSON as a key->value data store</p>
<div class="details collapse"></div>
<a href="../classes/Data_Store.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>
@ -318,13 +349,6 @@ display them cleanly</h2>
<div class="details collapse"></div>
<a href="../classes/MM_Controller.html" class="more">« More »</a>
</div>
<a name="MM_Data_Store" id="MM_Data_Store"></a><div class="element ajax clickable class" href="../classes/MM_Data_Store.html">
<h1>MM_Data_Store<a href="../classes/MM_Data_Store.html"></a>
</h1>
<p class="short_description">Class for using JSON as a key->value data store</p>
<div class="details collapse"></div>
<a href="../classes/MM_Data_Store.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>
@ -346,12 +370,12 @@ display them cleanly</h2>
<div class="details collapse"></div>
<a href="../classes/MM_Page.html" class="more">« More »</a>
</div>
<a name="MM_Session" id="MM_Session"></a><div class="element ajax clickable class" href="../classes/MM_Session.html">
<h1>MM_Session<a href="../classes/MM_Session.html"></a>
<a name="Session" id="Session"></a><div class="element ajax clickable class" href="../classes/Session.html">
<h1>Session<a href="../classes/Session.html"></a>
</h1>
<p class="short_description">Class to improve handling of PHP sessions</p>
<div class="details collapse"></div>
<a href="../classes/MM_Session.html" class="more">« More »</a>
<a href="../classes/Session.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>
@ -410,7 +434,7 @@ display them cleanly</h2>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -66,7 +66,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -107,7 +107,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -99,7 +99,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -61,8 +61,8 @@
</li>
<li class="nav-header">
<i class="icon-custom icon-class"></i> Classes</li>
<li><a href="#MM_Data_Store" title="Class for using JSON as a key-&gt;value data store">MM_Data_Store</a></li>
<li><a href="#MM_Session" title="Class to improve handling of PHP sessions">MM_Session</a></li>
<li><a href="#Data_Store" title="Class for using JSON as a key-&gt;value data store">Data_Store</a></li>
<li><a href="#Session" title="Class to improve handling of PHP sessions">Session</a></li>
</ul>
</div>
<div class="span8 package-contents">
@ -76,19 +76,19 @@
<div class="package-indent">
<h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="MM_Data_Store" id="MM_Data_Store"></a><div class="element ajax clickable class" href="../classes/MM_Data_Store.html">
<h1>MM_Data_Store<a href="../classes/MM_Data_Store.html"></a>
<a name="Data_Store" id="Data_Store"></a><div class="element ajax clickable class" href="../classes/Data_Store.html">
<h1>Data_Store<a href="../classes/Data_Store.html"></a>
</h1>
<p class="short_description">Class for using JSON as a key->value data store</p>
<div class="details collapse"></div>
<a href="../classes/MM_Data_Store.html" class="more">« More »</a>
<a href="../classes/Data_Store.html" class="more">« More »</a>
</div>
<a name="MM_Session" id="MM_Session"></a><div class="element ajax clickable class" href="../classes/MM_Session.html">
<h1>MM_Session<a href="../classes/MM_Session.html"></a>
<a name="Session" id="Session"></a><div class="element ajax clickable class" href="../classes/Session.html">
<h1>Session<a href="../classes/Session.html"></a>
</h1>
<p class="short_description">Class to improve handling of PHP sessions</p>
<div class="details collapse"></div>
<a href="../classes/MM_Session.html" class="more">« More »</a>
<a href="../classes/Session.html" class="more">« More »</a>
</div>
</div>
</div>
@ -96,7 +96,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -61,13 +61,13 @@
</li>
<li class="nav-header">
<i class="icon-custom icon-class"></i> Classes</li>
<li><a href="#MM_Model" title="Base Model Class">MM_Model</a></li>
<li><a href="#MM_Page" title="Class for building pages">MM_Page</a></li>
<li><a href="#MM_Output" title="Class for displaying output and setting http headers">MM_Output</a></li>
<li><a href="#MM_Controller" title="Base Controller Class">MM_Controller</a></li>
<li><a href="#DB" title="Extend PHP's PDO class to add some more functionality">DB</a></li>
<li><a href="#miniMVC" title="Base class for the framework">miniMVC</a></li>
<li><a href="#MM_Page" title="Class for building pages">MM_Page</a></li>
<li><a href="#MM" title="Class for standalone JSObject objects">MM</a></li>
<li><a href="#MM_Controller" title="Base Controller Class">MM_Controller</a></li>
<li><a href="#MM_Output" title="Class for displaying output and setting http headers">MM_Output</a></li>
<li><a href="#MM_Model" title="Base Model Class">MM_Model</a></li>
</ul>
</div>
<div class="span8 package-contents">
@ -136,7 +136,7 @@
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

View File

@ -76,6 +76,7 @@
<li class="function "><a href="#__construct" title="__construct :: Protected constructor for creating the one instance"><span class="description">Protected constructor for creating the one instance</span><pre>__construct</pre></a></li>
<li class="function "><a href="#__invoke" title="__invoke :: PHP magic method that is called when an object is treated as a function"><span class="description">PHP magic method that is called when an object is treated as a function</span><pre>__invoke</pre></a></li>
<li class="function "><a href="#__toString" title="__toString :: Prints out the contents of the object when used as a string"><span class="description">Prints out the contents of the object when used as a string</span><pre>__toString</pre></a></li>
<li class="function "><a href="#autoload" title="autoload :: Function to autoload libraries/classes"><span class="description">Function to autoload libraries/classes</span><pre>autoload</pre></a></li>
<li class="function "><a href="#controller_methods" title="controller_methods :: Returns routable methods for the specified controller class"><span class="description">Returns routable methods for the specified controller class</span><pre>controller_methods</pre></a></li>
<li class="function "><a href="#do_include" title="do_include :: Array_map callback to load a folder of classes at once"><span class="description">Array_map callback to load a folder of classes at once</span><pre>do_include</pre></a></li>
<li class="function "><a href="#get_instance" title="get_instance :: Singleton getter function"><span class="description">Singleton getter function</span><pre>get_instance</pre></a></li>
@ -92,6 +93,7 @@ display them cleanly"><span class="description">Function to run on script shutdo
-used to catch most fatal errors, and
display them cleanly</span><pre>shutdown</pre></a></li>
<li class="function "><a href="#site_url" title="site_url :: Returns a full url from a url segment"><span class="description">Returns a full url from a url segment</span><pre>site_url</pre></a></li>
<li class="function "><a href="#sys_autoload" title="sys_autoload :: Function to autoload system libraries"><span class="description">Function to autoload system libraries</span><pre>sys_autoload</pre></a></li>
<li class="function "><a href="#to_string" title="to_string :: Prints out the contents of the object"><span class="description">Prints out the contents of the object</span><pre>to_string</pre></a></li>
</ul>
</div>
@ -159,6 +161,18 @@ display them cleanly</span><pre>shutdown</pre></a></li>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="autoload" id="autoload"></a><div class="element clickable function autoload" data-toggle="collapse" data-target=".autoload .collapse">
<h2>Function to autoload libraries/classes</h2>
<pre>autoload($name) </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></code><p>string</p></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>
@ -310,6 +324,18 @@ display them cleanly</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sys_autoload" id="sys_autoload"></a><div class="element clickable function sys_autoload" data-toggle="collapse" data-target=".sys_autoload .collapse">
<h2>Function to autoload system libraries</h2>
<pre>sys_autoload($name) </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></code><p>string</p></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>
@ -368,19 +394,19 @@ display them cleanly</h2>
<div class="package-indent">
<h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="MM_Data_Store" id="MM_Data_Store"></a><div class="element ajax clickable class" href="../classes/MM_Data_Store.html">
<h1>MM_Data_Store<a href="../classes/MM_Data_Store.html"></a>
<a name="Data_Store" id="Data_Store"></a><div class="element ajax clickable class" href="../classes/Data_Store.html">
<h1>Data_Store<a href="../classes/Data_Store.html"></a>
</h1>
<p class="short_description">Class for using JSON as a key->value data store</p>
<div class="details collapse"></div>
<a href="../classes/MM_Data_Store.html" class="more">« More »</a>
<a href="../classes/Data_Store.html" class="more">« More »</a>
</div>
<a name="MM_Session" id="MM_Session"></a><div class="element ajax clickable class" href="../classes/MM_Session.html">
<h1>MM_Session<a href="../classes/MM_Session.html"></a>
<a name="Session" id="Session"></a><div class="element ajax clickable class" href="../classes/Session.html">
<h1>Session<a href="../classes/Session.html"></a>
</h1>
<p class="short_description">Class to improve handling of PHP sessions</p>
<div class="details collapse"></div>
<a href="../classes/MM_Session.html" class="more">« More »</a>
<a href="../classes/Session.html" class="more">« More »</a>
</div>
</div>
<ul class="breadcrumb">
@ -449,7 +475,7 @@ display them cleanly</h2>
<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-18T08:03:49-04:00.<br></footer></div>
generated on 2012-05-21T14:50:58-04:00.<br></footer></div>
</div>
</body>
</html>

File diff suppressed because it is too large Load Diff