miniMVC/docs/structure.xml

1952 lines
86 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="miniMVC">
<file path="sys/core/model.php" hash="05938afe30705659f4d53e7ca1153feb" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="miniMVC\System">
<name>MM_Model</name>
<full_name>\MM_Model</full_name>
<extends>\miniMVC</extends>
<docblock line="16">
<description><![CDATA[Base Model Class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="System"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="29" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Initialize the model class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/core/db.php" hash="17e8d53feb056a5d76270d1a6ea190d2" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="miniMVC\System">
<name>DB</name>
<full_name>\DB</full_name>
<extends>\Query_Builder</extends>
<docblock line="16">
<description><![CDATA[Extend PHP's PDO class to add some more functionality]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="System"/>
</docblock>
<property final="false" static="true" visibility="private" line="31" package="Default">
<name>$instance</name>
<default><![CDATA[[]]]></default>
<docblock line="26">
<description><![CDATA[DB connection instances]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="40" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="33">
<description><![CDATA[Indexed singleton method]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="33" name="param" description="" type="string" variable="$dbname">
<type by_reference="false">string</type>
</tag>
<tag line="33" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
<tag line="33" name="return" description="" type="\DB">
<type by_reference="false">\DB</type>
</tag>
</docblock>
<argument line="40">
<name>$dbname</name>
<default><![CDATA["default"]]></default>
<type/>
</argument>
<argument line="40">
<name>$options</name>
<default><![CDATA[[]]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="70" package="">
<name>__construct</name>
<type>function</type>
<docblock line="65">
<description><![CDATA[Constructor to override JSObject trait]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="65" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="70">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="86" package="">
<name>__call</name>
<type>function</type>
<docblock line="79">
<description><![CDATA[Override __call in trait to call __call in Query Builder...lol]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="79" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="79" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="79" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="86">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="86">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
<name>get_last_error</name>
<type>function</type>
<docblock line="93">
<description><![CDATA[Returns the last error from the database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="93" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/core/miniMVC.php" hash="265d598dc2eea39d29b8ec99734c54cf" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<function namespace="default" line="143" package="miniMVC">
<name>__construct</name>
<type>function</type>
<docblock line="140">
<description><![CDATA[Protected constructor for creating the one instance]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</function>
<function namespace="default" line="49" package="miniMVC">
<name>__call</name>
<type>function</type>
<docblock line="43">
<description><![CDATA[PHP magic method to facilitate dynamic methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="43" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="43" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="49">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="49">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="65" package="miniMVC">
<name>__toString</name>
<type>function</type>
<docblock line="60">
<description><![CDATA[Prints out the contents of the object when used as a string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="60" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</function>
<function namespace="default" line="151" package="miniMVC">
<name>__invoke</name>
<type>function</type>
<docblock line="145">
<description><![CDATA[PHP magic method that is called when an object is treated as a function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="145" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="145" name="return" description="" type="\self">
<type by_reference="false">\self</type>
</tag>
</docblock>
<argument line="151">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="163" package="miniMVC">
<name>get_instance</name>
<type>function</type>
<docblock line="158">
<description><![CDATA[Singleton getter function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="158" name="return" description="" type="\self">
<type by_reference="false">\self</type>
</tag>
</docblock>
</function>
<function namespace="default" line="180" package="miniMVC">
<name>__clone</name>
<type>function</type>
<docblock line="177">
<description><![CDATA[Magic function called when cloning an object]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</function>
<class final="false" abstract="false" namespace="default" line="196" package="miniMVC\System">
<name>MM</name>
<full_name>\MM</full_name>
<extends>\ArrayObject</extends>
<docblock line="190">
<description><![CDATA[Class for standalone JSObject objects]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="190" name="package" description="miniMVC"/>
<tag line="190" name="subpackage" description="System"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="205" package="">
<name>__construct</name>
<type>function</type>
<docblock line="200">
<description><![CDATA[Create the ArrayObject/JSObject hybrid object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="200" name="param" description="array" type="" variable="$members"/>
</docblock>
<argument line="205">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="226" package="">
<name>__call</name>
<type>function</type>
<docblock line="218">
<description><![CDATA[Allow calling of array methods on the object and
dynamic methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="218" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="218" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="218" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="226">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="226">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
</class>
<class final="false" abstract="false" namespace="default" line="252" package="miniMVC\System">
<name>miniMVC</name>
<full_name>\miniMVC</full_name>
<extends>\MM</extends>
<docblock line="246">
<description><![CDATA[Base class for the framework]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="246" name="package" description="miniMVC"/>
<tag line="246" name="subpackage" description="System"/>
</docblock>
<property final="false" static="false" visibility="public" line="261" package="Default">
<name>$output</name>
<default><![CDATA[]]></default>
<docblock line="256">
<description><![CDATA[Reference to output class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="256" name="var" description="" type="\MM_Output">
<type by_reference="false">\MM_Output</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="268" package="">
<name>__construct</name>
<type>function</type>
<docblock line="263">
<description><![CDATA[Constructor - Any classes loaded here become subclasses of miniMVC]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="263" name="param" description="" type="array" variable="$members">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="268">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="284" package="">
<name>__call</name>
<type>function</type>
<docblock line="278">
<description><![CDATA[PHP magic method to facilitate dynamic methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="278" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="278" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="284">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="284">
<name>$args</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="318" package="">
<name>load_class</name>
<type>function</type>
<docblock line="312">
<description><![CDATA[Method to load classes into the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="312" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="312" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="318">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="374" package="">
<name>unload</name>
<type>function</type>
<docblock line="369">
<description><![CDATA[Convenience function to remove an object from the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="369" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="374">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="389" package="">
<name>load_config</name>
<type>function</type>
<docblock line="384">
<description><![CDATA[Convenience function to load config files]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="384" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="389">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/page.php" hash="0763c678214a982e5f6ef215b5e54eb9" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="25" package="miniMVC\System">
<name>MM_Page</name>
<full_name>\MM_Page</full_name>
<extends>\MM</extends>
<docblock line="16">
<description><![CDATA[Class for building pages]]></description>
<long-description><![CDATA[<p>All methods are chainable, with the exception of the constructor,
build_header(), build_footer(), and _headers() methods.</p>]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="System"/>
</docblock>
<property final="false" static="false" visibility="private" line="32" package="Default">
<name>$meta</name>
<default><![CDATA[]]></default>
<docblock line="27">
<description><![CDATA[Meta tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="27" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="39" package="Default">
<name>$head_js</name>
<default><![CDATA[]]></default>
<docblock line="34">
<description><![CDATA[JS tags for the header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="34" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="46" package="Default">
<name>$foot_js</name>
<default><![CDATA[]]></default>
<docblock line="41">
<description><![CDATA[JS tags for the footer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="41" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="53" package="Default">
<name>$css</name>
<default><![CDATA[]]></default>
<docblock line="48">
<description><![CDATA[CSS tags for the page]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="48" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="60" package="Default">
<name>$title</name>
<default><![CDATA[]]></default>
<docblock line="55">
<description><![CDATA[Page title]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="55" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="67" package="Default">
<name>$head_tags</name>
<default><![CDATA[]]></default>
<docblock line="62">
<description><![CDATA[Additional header tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="62" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="74" package="Default">
<name>$body_class</name>
<default><![CDATA[]]></default>
<docblock line="69">
<description><![CDATA[Class(es) to apply to the main body tag]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="69" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="81" package="Default">
<name>$body_id</name>
<default><![CDATA[]]></default>
<docblock line="76">
<description><![CDATA[Id to apply to the body tag]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="76" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="88" package="Default">
<name>$base</name>
<default><![CDATA[]]></default>
<docblock line="83">
<description><![CDATA[Base tag]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="83" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="96" package="">
<name>__construct</name>
<type>function</type>
<docblock line="90">
<description><![CDATA[Set up the page class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="90" name="param" description="object" type="" variable="$controller"/>
<tag line="90" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="96">
<name>$controller</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="124" package="">
<name>_headers</name>
<type>function</type>
<docblock line="114">
<description><![CDATA[Sets server headers and doctype]]></description>
<long-description><![CDATA[<p>Also sets page mime type, based on if sent as
html or xhtml, and what the target browser
supports</p>]]></long-description>
<tag line="114" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="114" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="124">
<name>$html5</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="165" package="">
<name>set_meta</name>
<type>function</type>
<docblock line="157">
<description><![CDATA[Set Meta]]></description>
<long-description><![CDATA[<p>Sets meta tags, with codeigniter native meta tag helper</p>]]></long-description>
<tag line="157" name="param" description="" type="array" variable="$meta">
<type by_reference="false">array</type>
</tag>
<tag line="157" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="165">
<name>$meta</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="180" package="">
<name>set_head_js_group</name>
<type>function</type>
<docblock line="173">
<description><![CDATA[Sets minified javascript group in header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="173" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="173" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="173" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="180">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="180">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="200" package="">
<name>set_css_group</name>
<type>function</type>
<docblock line="195">
<description><![CDATA[Sets a minified css group]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="195" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="195" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="200">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="221" package="">
<name>set_foot_js_group</name>
<type>function</type>
<docblock line="214">
<description><![CDATA[Sets a minified javascript group for the page footer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="214" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="214" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="214" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="221">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="221">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="237" package="">
<name>set_title</name>
<type>function</type>
<docblock line="231">
<description><![CDATA[Sets html title string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="231" name="param" description="" type="string" variable="$title">
<type by_reference="false">string</type>
</tag>
<tag line="231" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="237">
<name>$title</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="254" package="">
<name>set_body_class</name>
<type>function</type>
<docblock line="248">
<description><![CDATA[Sets custom body class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="248" name="param" description="" type="string" variable="$class">
<type by_reference="false">string</type>
</tag>
<tag line="248" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="254">
<name>$class</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="268" package="">
<name>set_body_id</name>
<type>function</type>
<docblock line="262">
<description><![CDATA[Sets custom body id]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="262" name="param" description="" type="string" variable="$id">
<type by_reference="false">string</type>
</tag>
<tag line="262" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="268">
<name>$id</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="282" package="">
<name>set_base</name>
<type>function</type>
<docblock line="276">
<description><![CDATA[Sets custom base href]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="276" name="param" description="href" type="string" variable="$href">
<type by_reference="false">string</type>
</tag>
<tag line="276" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="282">
<name>$href</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="298" package="">
<name>set_css_tag</name>
<type>function</type>
<docblock line="290">
<description><![CDATA[Sets custom css tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="290" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="290" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="290" name="param" description="" type="string" variable="$media">
<type by_reference="false">string</type>
</tag>
<tag line="290" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="298">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="298">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
<argument line="298">
<name>$media</name>
<default><![CDATA["all"]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="326" package="">
<name>set_head_tag</name>
<type>function</type>
<docblock line="320">
<description><![CDATA[Sets a custom tag in the header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="320" name="param" description="" type="string" variable="$tag">
<type by_reference="false">string</type>
</tag>
<tag line="320" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="326">
<name>$tag</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="340" package="">
<name>build_header</name>
<type>function</type>
<docblock line="334">
<description><![CDATA[Sets custom page header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="334" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="334" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="340">
<name>$html5</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="398" package="">
<name>build_footer</name>
<type>function</type>
<docblock line="395">
<description><![CDATA[Builds common footer with any additional js]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="418" package="">
<name>script_tag</name>
<type>function</type>
<docblock line="409">
<description><![CDATA[Script Tag]]></description>
<long-description><![CDATA[<p>Helper function for making script tags</p>]]></long-description>
<tag line="409" name="param" description="" type="string" variable="$js">
<type by_reference="false">string</type>
</tag>
<tag line="409" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="409" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="418">
<name>$js</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="418">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="442" package="">
<name>set_message</name>
<type>function</type>
<docblock line="433">
<description><![CDATA[Set Message]]></description>
<long-description><![CDATA[<p>Adds a message to the page</p>]]></long-description>
<tag line="433" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
<tag line="433" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="433" name="param" description="" type="bool" variable="$return">
<type by_reference="false">bool</type>
</tag>
<tag line="433" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="442">
<name>$type</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="442">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="442">
<name>$return</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="458" package="">
<name>redirect_303</name>
<type>function</type>
<docblock line="452">
<description><![CDATA[Redirect 303]]></description>
<long-description><![CDATA[<p>Shortcut function for 303 redirect</p>]]></long-description>
<tag line="452" name="param" description="" type="string" variable="$url">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="458">
<name>$url</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="473" package="">
<name>render</name>
<type>function</type>
<docblock line="466">
<description><![CDATA[Render]]></description>
<long-description><![CDATA[<p>Shortcut function for building a page</p>]]></long-description>
<tag line="466" name="param" description="" type="string" variable="$view">
<type by_reference="false">string</type>
</tag>
<tag line="466" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="473">
<name>$view</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="473">
<name>$data</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="490" package="">
<name>output_string</name>
<type>function</type>
<docblock line="482">
<description><![CDATA[Output String]]></description>
<long-description><![CDATA[<p>Similar to render(), this is a shortcut
to output a string in the body of the
page.</p>]]></long-description>
<tag line="482" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="490">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="505" package="">
<name>_meta</name>
<type>function</type>
<docblock line="499">
<description><![CDATA[Private helper function to generate meta tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="499" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="499" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="505">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="527" package="">
<name>_link_tag</name>
<type>function</type>
<docblock line="521">
<description><![CDATA[Private helper function to generate link tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="521" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="521" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="527">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/controller.php" hash="c51a147d4ddd1ea2a8491d7c7c71f372" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="miniMVC\System">
<name>MM_Controller</name>
<full_name>\MM_Controller</full_name>
<extends>\miniMVC</extends>
<docblock line="16">
<description><![CDATA[Base Controller Class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="System"/>
</docblock>
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$page</name>
<default><![CDATA[]]></default>
<docblock line="24">
<description><![CDATA[Instance of Page class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="var" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="36" package="">
<name>__construct</name>
<type>function</type>
<docblock line="31">
<description><![CDATA[Create the controller object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="31" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="53" package="">
<name>load_model</name>
<type>function</type>
<docblock line="46">
<description><![CDATA[Function for loading a model into the current class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="46" name="param" description="" type="string" variable="$file">
<type by_reference="false">string</type>
</tag>
<tag line="46" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
<tag line="46" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="53">
<name>$file</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="53">
<name>$args</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
<name>load_view</name>
<type>function</type>
<docblock line="77">
<description><![CDATA[Function for loading a view]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="77" name="param" description="" type="string" variable="$file">
<type by_reference="false">string</type>
</tag>
<tag line="77" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
<tag line="77" name="param" description="" type="bool" variable="$return">
<type by_reference="false">bool</type>
</tag>
<tag line="77" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="85">
<name>$file</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="85">
<name>$data</name>
<default><![CDATA[[]]]></default>
<type>array</type>
</argument>
<argument line="85">
<name>$return</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/output.php" hash="22c578973d2a335045740f7f8627f73a" package="Default">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="21" package="miniMVC\System">
<name>MM_Output</name>
<full_name>\MM_Output</full_name>
<extends>\MM</extends>
<docblock line="15">
<description><![CDATA[Class for displaying output and setting http headers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="15" name="package" description="miniMVC"/>
<tag line="15" name="subpackage" description="System"/>
</docblock>
<property final="false" static="false" visibility="private" line="28" package="Default">
<name>$buffer</name>
<default><![CDATA[]]></default>
<docblock line="23">
<description><![CDATA[Content for outputting]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="23" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="35" package="Default">
<name>$headers</name>
<default><![CDATA[]]></default>
<docblock line="30">
<description><![CDATA[HTTP headers to send]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="30" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="42" package="">
<name>__construct</name>
<type>function</type>
<docblock line="37">
<description><![CDATA[Initialize the output class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="37" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="54" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="48">
<description><![CDATA[PHP magic method called when ending the script
Used for outputing HTML]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="48" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="97" package="">
<name>set_header</name>
<type>function</type>
<docblock line="91">
<description><![CDATA[Sets a header for later output]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="91" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="91" name="param" description="" type="string" variable="$val">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="97">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="97">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="109" package="">
<name>append_output</name>
<type>function</type>
<docblock line="104">
<description><![CDATA[Adds text to the output buffer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="104" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="109">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="121" package="">
<name>set_output</name>
<type>function</type>
<docblock line="116">
<description><![CDATA[Sets the output buffer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="116" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="121">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="131" package="">
<name>flush_headers</name>
<type>function</type>
<docblock line="128">
<description><![CDATA[Sends headers and then removes them]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
</class>
</file>
<file path="sys/libraries/data_store.php" hash="fdef6e0da2ded311637fad3e8a8f8f16" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="miniMVC\Libraries">
<name>MM_Data_Store</name>
<full_name>\MM_Data_Store</full_name>
<extends/>
<docblock line="16">
<description><![CDATA[Class for using JSON as a key->value data store]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="Libraries"/>
</docblock>
<property final="false" static="false" visibility="private" line="27" package="Default">
<name>$current</name>
<default><![CDATA[]]></default>
<docblock line="24">
<description><![CDATA[Settings object represented by the currently loaded JSON file]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="32" package="Default">
<name>$instance</name>
<default><![CDATA[]]></default>
<docblock line="29">
<description><![CDATA[Singleton instance]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="37" package="">
<name>__construct</name>
<type>function</type>
<docblock line="34">
<description><![CDATA[Create and/or load json file]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="58">
<description><![CDATA[Output the data on destruct]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
<name>__clone</name>
<type>function</type>
<docblock line="70">
<description><![CDATA[Magic function called when cloning an object]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="86" package="">
<name>__get</name>
<type>function</type>
<docblock line="80">
<description><![CDATA[Magic method to simplify isset checking for config options]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="80" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="80" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="86">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="101" package="">
<name>__set</name>
<type>function</type>
<docblock line="95">
<description><![CDATA[Magic method to simplify setting config options]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="95" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="95" name="param" description="mixed" type="" variable="$val"/>
</docblock>
<argument line="101">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="101">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="114" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="108">
<description><![CDATA[Static method to retreive current instance
of the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="108" name="return" description="" type="\self">
<type by_reference="false">\self</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="133" package="">
<name>del</name>
<type>function</type>
<docblock line="127">
<description><![CDATA[Removes a key from the data store]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="127" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="127" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="133">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="145" package="">
<name>get_all</name>
<type>function</type>
<docblock line="140">
<description><![CDATA[Return the entire data store object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="140" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/libraries/session.php" hash="120128c3b65c9a6d9ba91707a1a509c4" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<constant namespace="default" line="18" package="Default">
<name>Unknown</name>
<value><![CDATA[]]></value>
<docblock line="15">
<description><![CDATA[Define a session id to namespace sessions]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</constant>
<class final="false" abstract="false" namespace="default" line="27" package="miniMVC\Libraries">
<name>MM_Session</name>
<full_name>\MM_Session</full_name>
<extends/>
<docblock line="21">
<description><![CDATA[Class to improve handling of PHP sessions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="21" name="package" description="miniMVC"/>
<tag line="21" name="subpackage" description="Libraries"/>
</docblock>
<property final="false" static="false" visibility="protected" line="42" package="Default">
<name>$sess</name>
<default><![CDATA[[]]]></default>
<docblock line="37">
<description><![CDATA[Reference to session superglobal]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="37" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="47" package="">
<name>__construct</name>
<type>function</type>
<docblock line="44">
<description><![CDATA[Start a session]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="65" package="">
<name>__set</name>
<type>function</type>
<docblock line="58">
<description><![CDATA[Set a session value]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="58" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="58" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="58" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="65">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="65">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="78" package="">
<name>__get</name>
<type>function</type>
<docblock line="72">
<description><![CDATA[Retreive a session value]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="72" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="72" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="78">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
<name>destroy</name>
<type>function</type>
<docblock line="85">
<description><![CDATA[Destroy a session]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="85" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/common.php" hash="c4a43e48f47ebe51c3b6dc4850a0b96b" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<function namespace="default" line="32" package="miniMVC">
<name>shutdown</name>
<type>function</type>
<docblock line="25">
<description><![CDATA[Function to run on script shutdown
-used to catch most fatal errors, and
display them cleanly]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="25" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="64" package="miniMVC">
<name>load_file</name>
<type>function</type>
<docblock line="57">
<description><![CDATA[Function to search through the tree to find the necessary file]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="57" name="param" description="" type="string" variable="$file">
<type by_reference="false">string</type>
</tag>
<tag line="57" name="param" description="" type="string" variable="$curr_path">
<type by_reference="false">string</type>
</tag>
<tag line="57" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="64">
<name>$file</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="64">
<name>$curr_path</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="99" package="miniMVC">
<name>on_error</name>
<type>function</type>
<docblock line="90">
<description><![CDATA[Custom error handler]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="90" name="param" description="" type="int" variable="$severity">
<type by_reference="false">int</type>
</tag>
<tag line="90" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="90" name="param" description="" type="string" variable="$filepath">
<type by_reference="false">string</type>
</tag>
<tag line="90" name="param" description="" type="int" variable="$line">
<type by_reference="false">int</type>
</tag>
<tag line="90" name="return" description="" type="\ErrorException">
<type by_reference="false">\ErrorException</type>
</tag>
</docblock>
<argument line="99">
<name>$severity</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="99">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="99">
<name>$filepath</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="99">
<name>$line</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="112" package="miniMVC">
<name>on_exception</name>
<type>function</type>
<docblock line="106">
<description><![CDATA[Custom exception handlererror_get_last]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="106" name="param" description="" type="\Exception" variable="$exception">
<type by_reference="false">\Exception</type>
</tag>
<tag line="106" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="112">
<name>$exception</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="135" package="miniMVC">
<name>is_like_array</name>
<type>function</type>
<docblock line="129">
<description><![CDATA[Utility function to check if a variable is set, and is an array or object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="129" name="param" description="" type="mixed" variable="$var">
<type by_reference="false">mixed</type>
</tag>
<tag line="129" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="135">
<name>$var</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="152" package="miniMVC">
<name>show_404</name>
<type>function</type>
<docblock line="147">
<description><![CDATA[General 404 function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="147" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="177" package="miniMVC">
<name>show_error</name>
<type>function</type>
<docblock line="171">
<description><![CDATA[Fatal Error page function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="171" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="171" name="param" description="" type="int" variable="$status_code">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="177">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="177">
<name>$status_code</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="202" package="miniMVC">
<name>controller_methods</name>
<type>function</type>
<docblock line="196">
<description><![CDATA[Returns routable methods for the specified controller class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="196" name="param" description="" type="string" variable="$controller">
<type by_reference="false">string</type>
</tag>
<tag line="196" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="202">
<name>$controller</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="220" package="miniMVC">
<name>route</name>
<type>function</type>
<docblock line="215">
<description><![CDATA[Calls the appropriate module/controller/function based on the url]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="215" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="353" package="miniMVC">
<name>site_url</name>
<type>function</type>
<docblock line="347">
<description><![CDATA[Returns a full url from a url segment]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="347" name="param" description="" type="string" variable="$segment">
<type by_reference="false">string</type>
</tag>
<tag line="347" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="353">
<name>$segment</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="367" package="miniMVC">
<name>to_string</name>
<type>function</type>
<docblock line="360">
<description><![CDATA[Prints out the contents of the object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="360" name="param" description="" type="\object/array" variable="$data">
<type by_reference="false">\object/array</type>
</tag>
<tag line="360" name="param" description="" type="string" variable="$method">
<type by_reference="false">string</type>
</tag>
<tag line="360" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="367">
<name>$data</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="367">
<name>$method</name>
<default><![CDATA['print_r']]></default>
<type/>
</argument>
</function>
<function namespace="default" line="401" package="miniMVC">
<name>do_include</name>
<type>function</type>
<docblock line="395">
<description><![CDATA[Array_map callback to load a folder of classes at once]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="395" name="param" description="" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="395" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="401">
<name>$path</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
</file>
<file path="index.php" hash="ec4c291649bc651088cf7b4daeddb574" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<include line="52" type="Require" package="Default">
<name>config/config.php</name>
</include>
<include line="55" type="Require" package="Default">
<name>common.php</name>
</include>
<include line="58" type="Require Once" package="Default">
<name>db/autoload.php</name>
</include>
<include line="61" type="Require Once" package="Default">
<name>core/miniMVC.php</name>
</include>
<constant namespace="default" line="28" package="miniMVC\App">
<name>ENVIRONMENT</name>
<value><![CDATA['DEVELOPMENT']]></value>
<docblock line="16">
<description><![CDATA[miniMVC bootstrap file]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="App"/>
</docblock>
</constant>
<constant namespace="default" line="40" package="Default">
<name>MM_BASE_PATH</name>
<value><![CDATA[__DIR__]]></value>
</constant>
<constant namespace="default" line="41" package="Default">
<name>MM_SYS_PATH</name>
<value><![CDATA[__DIR__.'/sys/']]></value>
</constant>
<constant namespace="default" line="42" package="Default">
<name>MM_APP_PATH</name>
<value><![CDATA[__DIR__.'/app/']]></value>
</constant>
<constant namespace="default" line="43" package="Default">
<name>MM_MOD_PATH</name>
<value><![CDATA[MM_APP_PATH.'modules/']]></value>
</constant>
</file>
<file path="app/config/config.php" hash="698f6dfa011921b32a16dc256d44a50e" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<constant namespace="default" line="33" package="miniMVC\App">
<name>SHOW_DEBUG_BACKTRACE</name>
<value><![CDATA[TRUE]]></value>
<docblock line="16">
<description><![CDATA[Main config file]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="App"/>
</docblock>
</constant>
<constant namespace="default" line="44" package="Default">
<name>BASE_URL</name>
<value><![CDATA[$default_baseurl]]></value>
</constant>
<constant namespace="default" line="54" package="Default">
<name>URL_INDEX_FILE</name>
<value><![CDATA['index.php/']]></value>
</constant>
<constant namespace="default" line="64" package="Default">
<name>CONTENT_DOMAIN</name>
<value><![CDATA[BASE_URL]]></value>
</constant>
<constant namespace="default" line="74" package="Default">
<name>STATIC_LIB_PATH</name>
<value><![CDATA[CONTENT_DOMAIN.'assets/']]></value>
</constant>
<constant namespace="default" line="86" package="Default">
<name>STYLE_PATH</name>
<value><![CDATA[STATIC_LIB_PATH . 'css.php/g/']]></value>
</constant>
<constant namespace="default" line="97" package="Default">
<name>SCRIPT_PATH</name>
<value><![CDATA[STATIC_LIB_PATH . 'js.php/g/']]></value>
</constant>
<constant namespace="default" line="108" package="Default">
<name>DEFAULT_TITLE</name>
<value><![CDATA["miniMVC app"]]></value>
</constant>
<constant namespace="default" line="118" package="Default">
<name>DEFAULT_CSS_GROUP</name>
<value><![CDATA["css"]]></value>
</constant>
<constant namespace="default" line="128" package="Default">
<name>DEFAULT_JS_GROUP</name>
<value><![CDATA["js"]]></value>
</constant>
</file>
<file path="app/config/db.php" hash="53bcf0378295148898dc0047812623ae" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
</file>
<file path="app/config/routes.php" hash="a7d5448eb9996985c660e8a07767c735" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
</file>
<file path="app/modules/welcome/models/welcome_model.php" hash="b1085eadd43d5b02f70919ac7565adad" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="miniMVC\App">
<name>Welcome_Model</name>
<full_name>\Welcome_Model</full_name>
<extends>\MM_Model</extends>
<docblock line="16">
<description><![CDATA[Model template class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="App"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="29" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Initialize the model]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="app/modules/welcome/controllers/welcome.php" hash="b46fff4b3fd55129850e8edff54a75f5" package="miniMVC">
<docblock line="2">
<description><![CDATA[MiniMVC]]></description>
<long-description><![CDATA[<p>Convention-based micro-framework for PHP</p>]]></long-description>
<tag line="2" name="package" description="miniMVC"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2011 - 2012"/>
<tag line="2" name="link" description="https://github.com/timw4mail/miniMVC" link="https://github.com/timw4mail/miniMVC"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="miniMVC\App">
<name>Welcome</name>
<full_name>\Welcome</full_name>
<extends>\MM_Controller</extends>
<docblock line="16">
<description><![CDATA[Example Controller Class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="miniMVC"/>
<tag line="16" name="subpackage" description="App"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="29" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Initialize the constructor]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
<name>index</name>
<type>function</type>
<docblock line="34">
<description><![CDATA[Default route for the controller]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="34" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="51" package="">
<name>php</name>
<type>function</type>
<docblock line="46">
<description><![CDATA[welcome/php route]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="46" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<package name="" full_name=""/>
<package name="Default" full_name="Default"/>
<package name="miniMVC" full_name="miniMVC">
<package name="App" full_name="miniMVC\App"/>
<package name="Libraries" full_name="miniMVC\Libraries"/>
<package name="System" full_name="miniMVC\System"/>
</package>
<namespace name="default" full_name="default"/>
<marker count="0">todo</marker>
<marker count="0">fixme</marker>
<deprecated count="0"/>
</project>