miniMVC/docs/classes/miniMVC.html

615 lines
24 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 » \miniMVC</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 inherited"><a href="#__call" title="__call :: Allow calling of array methods on the object and
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 :: Constructor - Any classes loaded here become subclasses of miniMVC"><span class="description">Constructor - Any classes loaded here become subclasses of miniMVC</span><pre>__construct()</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="#asort" title="asort :: "><span class="description">asort()
</span><pre>asort()</pre></a></li>
<li class="method public inherited"><a href="#count" title="count :: "><span class="description">count()
</span><pre>count()</pre></a></li>
<li class="method public inherited"><a href="#exchangeArray" title="exchangeArray :: "><span class="description">exchangeArray()
</span><pre>exchangeArray()</pre></a></li>
<li class="method public inherited"><a href="#getArrayCopy" title="getArrayCopy :: "><span class="description">getArrayCopy()
</span><pre>getArrayCopy()</pre></a></li>
<li class="method public inherited"><a href="#getFlags" title="getFlags :: "><span class="description">getFlags()
</span><pre>getFlags()</pre></a></li>
<li class="method public inherited"><a href="#getIterator" title="getIterator :: "><span class="description">getIterator()
</span><pre>getIterator()</pre></a></li>
<li class="method public inherited"><a href="#getIteratorClass" title="getIteratorClass :: "><span class="description">getIteratorClass()
</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>
<li class="method public inherited"><a href="#natsort" title="natsort :: "><span class="description">natsort()
</span><pre>natsort()</pre></a></li>
<li class="method public inherited"><a href="#offsetExists" title="offsetExists :: "><span class="description">offsetExists()
</span><pre>offsetExists()</pre></a></li>
<li class="method public inherited"><a href="#offsetGet" title="offsetGet :: "><span class="description">offsetGet()
</span><pre>offsetGet()</pre></a></li>
<li class="method public inherited"><a href="#offsetSet" title="offsetSet :: "><span class="description">offsetSet()
</span><pre>offsetSet()</pre></a></li>
<li class="method public inherited"><a href="#offsetUnset" title="offsetUnset :: "><span class="description">offsetUnset()
</span><pre>offsetUnset()</pre></a></li>
<li class="method public inherited"><a href="#serialize" title="serialize :: "><span class="description">serialize()
</span><pre>serialize()</pre></a></li>
<li class="method public inherited"><a href="#setFlags" title="setFlags :: "><span class="description">setFlags()
</span><pre>setFlags()</pre></a></li>
<li class="method public inherited"><a href="#setIteratorClass" title="setIteratorClass :: "><span class="description">setIteratorClass()
</span><pre>setIteratorClass()</pre></a></li>
<li class="method public inherited"><a href="#uasort" title="uasort :: "><span class="description">uasort()
</span><pre>uasort()</pre></a></li>
<li class="method public inherited"><a href="#uksort" title="uksort :: "><span class="description">uksort()
</span><pre>uksort()</pre></a></li>
<li class="method public "><a href="#unload" title="unload :: Convenience function to remove an object from the singleton"><span class="description">Convenience function to remove an object from the singleton</span><pre>unload()</pre></a></li>
<li class="method public inherited"><a href="#unserialize" title="unserialize :: "><span class="description">unserialize()
</span><pre>unserialize()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CminiMVC" id="\miniMVC"></a><div href="../classes/miniMVC.html" class="element class">
<p class="short_description">Base class for the framework</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/miniMVC.System.html">miniMVC</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>System</td>
</tr>
</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>Allow calling of array methods on the object and
dynamic methods</h2>
<pre>__call(string $name, array $params) : mixed</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::__call()</td>
</tr></table>
<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 - Any classes loaded here become subclasses of miniMVC</h2>
<pre>__construct(array $members) </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="append" id="append"></a><div class="element clickable method public append" data-toggle="collapse" data-target=".append .collapse">
<h2>append()
</h2>
<pre>append() </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>ArrayObject::append()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::append()</td>
</tr>
</table>
</div></div>
</div>
<a name="asort" id="asort"></a><div class="element clickable method public asort" data-toggle="collapse" data-target=".asort .collapse">
<h2>asort()
</h2>
<pre>asort() </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>ArrayObject::asort()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::asort()</td>
</tr>
</table>
</div></div>
</div>
<a name="count" id="count"></a><div class="element clickable method public count" data-toggle="collapse" data-target=".count .collapse">
<h2>count()
</h2>
<pre>count() </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>ArrayObject::count()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::count()</td>
</tr>
</table>
</div></div>
</div>
<a name="exchangeArray" id="exchangeArray"></a><div class="element clickable method public exchangeArray" data-toggle="collapse" data-target=".exchangeArray .collapse">
<h2>exchangeArray()
</h2>
<pre>exchangeArray() </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>ArrayObject::exchangeArray()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::exchangeArray()</td>
</tr>
</table>
</div></div>
</div>
<a name="getArrayCopy" id="getArrayCopy"></a><div class="element clickable method public getArrayCopy" data-toggle="collapse" data-target=".getArrayCopy .collapse">
<h2>getArrayCopy()
</h2>
<pre>getArrayCopy() </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>ArrayObject::getArrayCopy()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::getArrayCopy()</td>
</tr>
</table>
</div></div>
</div>
<a name="getFlags" id="getFlags"></a><div class="element clickable method public getFlags" data-toggle="collapse" data-target=".getFlags .collapse">
<h2>getFlags()
</h2>
<pre>getFlags() </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>ArrayObject::getFlags()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::getFlags()</td>
</tr>
</table>
</div></div>
</div>
<a name="getIterator" id="getIterator"></a><div class="element clickable method public getIterator" data-toggle="collapse" data-target=".getIterator .collapse">
<h2>getIterator()
</h2>
<pre>getIterator() </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>ArrayObject::getIterator()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::getIterator()</td>
</tr>
</table>
</div></div>
</div>
<a name="getIteratorClass" id="getIteratorClass"></a><div class="element clickable method public getIteratorClass" data-toggle="collapse" data-target=".getIteratorClass .collapse">
<h2>getIteratorClass()
</h2>
<pre>getIteratorClass() </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>ArrayObject::getIteratorClass()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::getIteratorClass()</td>
</tr>
</table>
</div></div>
</div>
<a name="ksort" id="ksort"></a><div class="element clickable method public ksort" data-toggle="collapse" data-target=".ksort .collapse">
<h2>ksort()
</h2>
<pre>ksort() </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>ArrayObject::ksort()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::ksort()</td>
</tr>
</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>
<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></div>
</div>
<a name="natcasesort" id="natcasesort"></a><div class="element clickable method public natcasesort" data-toggle="collapse" data-target=".natcasesort .collapse">
<h2>natcasesort()
</h2>
<pre>natcasesort() </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>ArrayObject::natcasesort()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::natcasesort()</td>
</tr>
</table>
</div></div>
</div>
<a name="natsort" id="natsort"></a><div class="element clickable method public natsort" data-toggle="collapse" data-target=".natsort .collapse">
<h2>natsort()
</h2>
<pre>natsort() </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>ArrayObject::natsort()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::natsort()</td>
</tr>
</table>
</div></div>
</div>
<a name="offsetExists" id="offsetExists"></a><div class="element clickable method public offsetExists" data-toggle="collapse" data-target=".offsetExists .collapse">
<h2>offsetExists()
</h2>
<pre>offsetExists() </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>ArrayObject::offsetExists()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::offsetExists()</td>
</tr>
</table>
</div></div>
</div>
<a name="offsetGet" id="offsetGet"></a><div class="element clickable method public offsetGet" data-toggle="collapse" data-target=".offsetGet .collapse">
<h2>offsetGet()
</h2>
<pre>offsetGet() </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>ArrayObject::offsetGet()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::offsetGet()</td>
</tr>
</table>
</div></div>
</div>
<a name="offsetSet" id="offsetSet"></a><div class="element clickable method public offsetSet" data-toggle="collapse" data-target=".offsetSet .collapse">
<h2>offsetSet()
</h2>
<pre>offsetSet() </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>ArrayObject::offsetSet()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::offsetSet()</td>
</tr>
</table>
</div></div>
</div>
<a name="offsetUnset" id="offsetUnset"></a><div class="element clickable method public offsetUnset" data-toggle="collapse" data-target=".offsetUnset .collapse">
<h2>offsetUnset()
</h2>
<pre>offsetUnset() </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>ArrayObject::offsetUnset()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::offsetUnset()</td>
</tr>
</table>
</div></div>
</div>
<a name="serialize" id="serialize"></a><div class="element clickable method public serialize" data-toggle="collapse" data-target=".serialize .collapse">
<h2>serialize()
</h2>
<pre>serialize() </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>ArrayObject::serialize()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::serialize()</td>
</tr>
</table>
</div></div>
</div>
<a name="setFlags" id="setFlags"></a><div class="element clickable method public setFlags" data-toggle="collapse" data-target=".setFlags .collapse">
<h2>setFlags()
</h2>
<pre>setFlags() </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>ArrayObject::setFlags()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::setFlags()</td>
</tr>
</table>
</div></div>
</div>
<a name="setIteratorClass" id="setIteratorClass"></a><div class="element clickable method public setIteratorClass" data-toggle="collapse" data-target=".setIteratorClass .collapse">
<h2>setIteratorClass()
</h2>
<pre>setIteratorClass() </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>ArrayObject::setIteratorClass()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::setIteratorClass()</td>
</tr>
</table>
</div></div>
</div>
<a name="uasort" id="uasort"></a><div class="element clickable method public uasort" data-toggle="collapse" data-target=".uasort .collapse">
<h2>uasort()
</h2>
<pre>uasort() </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>ArrayObject::uasort()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::uasort()</td>
</tr>
</table>
</div></div>
</div>
<a name="uksort" id="uksort"></a><div class="element clickable method public uksort" data-toggle="collapse" data-target=".uksort .collapse">
<h2>uksort()
</h2>
<pre>uksort() </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>ArrayObject::uksort()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::uksort()</td>
</tr>
</table>
</div></div>
</div>
<a name="unload" id="unload"></a><div class="element clickable method public unload" data-toggle="collapse" data-target=".unload .collapse">
<h2>Convenience function to remove an object from the singleton</h2>
<pre>unload(string $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>string</code>
</div>
</div></div>
</div>
<a name="unserialize" id="unserialize"></a><div class="element clickable method public unserialize" data-toggle="collapse" data-target=".unserialize .collapse">
<h2>unserialize()
</h2>
<pre>unserialize() </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>ArrayObject::unserialize()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\MM::unserialize()</td>
</tr>
</table>
</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-16T08:29:32-04:00.<br></footer></div>
</div>
</body>
</html>