miniMVC/docs/structure.xml

1750 lines
76 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="miniMVC">
<file path="sys/core/model.php" hash="39687cc8fc2db1f95da481f88474543b" 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="30" 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="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="30">
<name>$args</name>
<default><![CDATA[[]]]></default>
<type>array</type>
</argument>
</method>
</class>
</file>
<file path="sys/core/db.php" hash="ce45be72460ec058f1b097fdcc4190de" 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="85" package="">
<name>__call</name>
<type>function</type>
<docblock line="78">
<description><![CDATA[Override __call in trait to call __call in Query Builder...lol]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="78" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="78" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="78" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="85">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="85">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="97" package="">
<name>get_last_error</name>
<type>function</type>
<docblock line="92">
<description><![CDATA[Returns the last error from the database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="92" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/core/traits.php" hash="180c0974066474e12347bed21c471073" 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>
</file>
<file path="sys/core/miniMVC.php" hash="9b4d9d57c9b4bb276e6b688c1e606cfd" 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>miniMVC</name>
<full_name>\miniMVC</full_name>
<extends>\MM</extends>
<docblock line="16">
<description><![CDATA[Base class for the framework]]></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="31" package="">
<name>__construct</name>
<type>function</type>
<docblock line="26">
<description><![CDATA[Constructor - Any classes loaded here become subclasses of miniMVC]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="param" description="" type="array" variable="$members">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="31">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="45" package="">
<name>load_class</name>
<type>function</type>
<docblock line="39">
<description><![CDATA[Method to load classes into the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="39" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="39" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="45">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="101" package="">
<name>unload</name>
<type>function</type>
<docblock line="96">
<description><![CDATA[Convenience function to remove an object from the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="96" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="101">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
<name>load_config</name>
<type>function</type>
<docblock line="111">
<description><![CDATA[Convenience function to load config files]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="111" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="116">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/page.php" hash="13ce20f0ca0bbb2f287fe10e91e0ef88" 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_Output</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="123" package="">
<name>_headers</name>
<type>function</type>
<docblock line="113">
<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="113" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="113" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="123">
<name>$html5</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="164" package="">
<name>set_meta</name>
<type>function</type>
<docblock line="156">
<description><![CDATA[Set Meta]]></description>
<long-description><![CDATA[<p>Sets meta tags, with codeigniter native meta tag helper</p>]]></long-description>
<tag line="156" name="param" description="" type="array" variable="$meta">
<type by_reference="false">array</type>
</tag>
<tag line="156" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="164">
<name>$meta</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
<name>set_head_js_group</name>
<type>function</type>
<docblock line="172">
<description><![CDATA[Sets minified javascript group in header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="172" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="172" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="172" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="179">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="179">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="199" package="">
<name>set_css_group</name>
<type>function</type>
<docblock line="194">
<description><![CDATA[Sets a minified css group]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="194" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="194" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="199">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="220" package="">
<name>set_foot_js_group</name>
<type>function</type>
<docblock line="213">
<description><![CDATA[Sets a minified javascript group for the page footer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="213" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="213" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="213" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="220">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="220">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="236" package="">
<name>set_title</name>
<type>function</type>
<docblock line="230">
<description><![CDATA[Sets html title string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="230" name="param" description="" type="string" variable="$title">
<type by_reference="false">string</type>
</tag>
<tag line="230" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="236">
<name>$title</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="253" package="">
<name>set_body_class</name>
<type>function</type>
<docblock line="247">
<description><![CDATA[Sets custom body class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="247" name="param" description="" type="string" variable="$class">
<type by_reference="false">string</type>
</tag>
<tag line="247" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="253">
<name>$class</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="267" package="">
<name>set_body_id</name>
<type>function</type>
<docblock line="261">
<description><![CDATA[Sets custom body id]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="261" name="param" description="" type="string" variable="$id">
<type by_reference="false">string</type>
</tag>
<tag line="261" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="267">
<name>$id</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="281" package="">
<name>set_base</name>
<type>function</type>
<docblock line="275">
<description><![CDATA[Sets custom base href]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="275" name="param" description="href" type="string" variable="$href">
<type by_reference="false">string</type>
</tag>
<tag line="275" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="281">
<name>$href</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="297" package="">
<name>set_css_tag</name>
<type>function</type>
<docblock line="289">
<description><![CDATA[Sets custom css tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="289" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="289" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="289" name="param" description="" type="string" variable="$media">
<type by_reference="false">string</type>
</tag>
<tag line="289" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="297">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="297">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
<argument line="297">
<name>$media</name>
<default><![CDATA["all"]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="325" package="">
<name>set_head_tag</name>
<type>function</type>
<docblock line="319">
<description><![CDATA[Sets a custom tag in the header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="319" name="param" description="" type="string" variable="$tag">
<type by_reference="false">string</type>
</tag>
<tag line="319" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="325">
<name>$tag</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="339" package="">
<name>build_header</name>
<type>function</type>
<docblock line="333">
<description><![CDATA[Sets custom page header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="333" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="333" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="339">
<name>$html5</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="397" package="">
<name>build_footer</name>
<type>function</type>
<docblock line="394">
<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="417" package="">
<name>script_tag</name>
<type>function</type>
<docblock line="408">
<description><![CDATA[Script Tag]]></description>
<long-description><![CDATA[<p>Helper function for making script tags</p>]]></long-description>
<tag line="408" name="param" description="" type="string" variable="$js">
<type by_reference="false">string</type>
</tag>
<tag line="408" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="408" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="417">
<name>$js</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="417">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="441" package="">
<name>set_message</name>
<type>function</type>
<docblock line="432">
<description><![CDATA[Set Message]]></description>
<long-description><![CDATA[<p>Adds a message to the page</p>]]></long-description>
<tag line="432" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
<tag line="432" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="432" name="param" description="" type="bool" variable="$return">
<type by_reference="false">bool</type>
</tag>
<tag line="432" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="441">
<name>$type</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="441">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="441">
<name>$return</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="457" package="">
<name>redirect_303</name>
<type>function</type>
<docblock line="451">
<description><![CDATA[Redirect 303]]></description>
<long-description><![CDATA[<p>Shortcut function for 303 redirect</p>]]></long-description>
<tag line="451" name="param" description="" type="string" variable="$url">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="457">
<name>$url</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="472" package="">
<name>render</name>
<type>function</type>
<docblock line="465">
<description><![CDATA[Render]]></description>
<long-description><![CDATA[<p>Shortcut function for building a page</p>]]></long-description>
<tag line="465" name="param" description="" type="string" variable="$view">
<type by_reference="false">string</type>
</tag>
<tag line="465" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="472">
<name>$view</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="472">
<name>$data</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="489" package="">
<name>output_string</name>
<type>function</type>
<docblock line="481">
<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="481" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="489">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="504" package="">
<name>_meta</name>
<type>function</type>
<docblock line="498">
<description><![CDATA[Private helper function to generate meta tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="498" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="498" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="504">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="526" package="">
<name>_link_tag</name>
<type>function</type>
<docblock line="520">
<description><![CDATA[Private helper function to generate link tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="520" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="520" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="526">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/MM.php" hash="410a3090f18ff4e538690a3f44dfc75c" 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</name>
<full_name>\MM</full_name>
<extends>\ArrayObject</extends>
<docblock line="16">
<description><![CDATA[Class for standalone JSObject objects]]></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="31" package="">
<name>__construct</name>
<type>function</type>
<docblock line="26">
<description><![CDATA[Create the ArrayObject/JSObject hybrid object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="param" description="array" type="" variable="$members"/>
</docblock>
<argument line="31">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
<name>__call</name>
<type>function</type>
<docblock line="44">
<description><![CDATA[Allow calling of array methods on the object and
dynamic methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="44" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="44" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="44" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="52">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="52">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/controller.php" hash="ee59441b55721d586c536f30372daa36" 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="46a60c21d86af7f52aee6371b09c1d32" 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="dcef82fa82c3d0513e7d776df22e4944" 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="10a8c36a92f05af78d327b2390bb955b" 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_Session</name>
<full_name>\MM_Session</full_name>
<extends/>
<docblock line="16">
<description><![CDATA[Class to improve handling of PHP sessions]]></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="protected" line="37" package="Default">
<name>$sess</name>
<default><![CDATA[[]]]></default>
<docblock line="32">
<description><![CDATA[Reference to session superglobal]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="32" 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="42" package="">
<name>__construct</name>
<type>function</type>
<docblock line="39">
<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="60" package="">
<name>__set</name>
<type>function</type>
<docblock line="53">
<description><![CDATA[Set a session value]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="53" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="53" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="53" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="60">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="60">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
<name>__get</name>
<type>function</type>
<docblock line="67">
<description><![CDATA[Retreive a session value]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="67" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="67" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="73">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
<name>destroy</name>
<type>function</type>
<docblock line="80">
<description><![CDATA[Destroy a session]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="80" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/common.php" hash="2576c63ab465aa07cf44610dbc316270" 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="34" package="miniMVC">
<name>shutdown</name>
<type>function</type>
<docblock line="27">
<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="27" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="67" package="miniMVC">
<name>on_error</name>
<type>function</type>
<docblock line="58">
<description><![CDATA[Custom error handler]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="58" name="param" description="" type="int" variable="$severity">
<type by_reference="false">int</type>
</tag>
<tag line="58" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="58" name="param" description="" type="string" variable="$filepath">
<type by_reference="false">string</type>
</tag>
<tag line="58" name="param" description="" type="int" variable="$line">
<type by_reference="false">int</type>
</tag>
<tag line="58" name="return" description="" type="\ErrorException">
<type by_reference="false">\ErrorException</type>
</tag>
</docblock>
<argument line="67">
<name>$severity</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="67">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="67">
<name>$filepath</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="67">
<name>$line</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="80" package="miniMVC">
<name>on_exception</name>
<type>function</type>
<docblock line="74">
<description><![CDATA[Custom exception handlererror_get_last]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="74" name="param" description="" type="\Exception" variable="$exception">
<type by_reference="false">\Exception</type>
</tag>
<tag line="74" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="80">
<name>$exception</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="102" package="miniMVC">
<name>show_404</name>
<type>function</type>
<docblock line="97">
<description><![CDATA[General 404 function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="97" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="127" package="miniMVC">
<name>show_error</name>
<type>function</type>
<docblock line="121">
<description><![CDATA[Fatal Error page function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="121" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="121" name="param" description="" type="int" variable="$status_code">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="127">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="127">
<name>$status_code</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="154" package="miniMVC">
<name>is_like_array</name>
<type>function</type>
<docblock line="148">
<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="148" name="param" description="" type="mixed" variable="$var">
<type by_reference="false">mixed</type>
</tag>
<tag line="148" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="154">
<name>$var</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="172" package="miniMVC">
<name>controller_methods</name>
<type>function</type>
<docblock line="166">
<description><![CDATA[Returns routable methods for the specified controller class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="166" name="param" description="" type="string" variable="$controller">
<type by_reference="false">string</type>
</tag>
<tag line="166" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="172">
<name>$controller</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="191" package="miniMVC">
<name>site_url</name>
<type>function</type>
<docblock line="185">
<description><![CDATA[Returns a full url from a url segment]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="185" name="param" description="" type="string" variable="$segment">
<type by_reference="false">string</type>
</tag>
<tag line="185" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="191">
<name>$segment</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="205" package="miniMVC">
<name>to_string</name>
<type>function</type>
<docblock line="198">
<description><![CDATA[Prints out the contents of the object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="198" name="param" description="" type="\object/array" variable="$data">
<type by_reference="false">\object/array</type>
</tag>
<tag line="198" name="param" description="" type="string" variable="$method">
<type by_reference="false">string</type>
</tag>
<tag line="198" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="205">
<name>$data</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="205">
<name>$method</name>
<default><![CDATA['print_r']]></default>
<type/>
</argument>
</function>
<function namespace="default" line="239" package="miniMVC">
<name>do_include</name>
<type>function</type>
<docblock line="233">
<description><![CDATA[Array_map callback to load a folder of classes at once]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="233" name="param" description="" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="233" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="239">
<name>$path</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="253" package="miniMVC">
<name>init</name>
<type>function</type>
<docblock line="248">
<description><![CDATA[Load required classes for bootstraping]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="248" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="283" package="miniMVC">
<name>route</name>
<type>function</type>
<docblock line="278">
<description><![CDATA[Calls the appropriate module/controller/function based on the url]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="278" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
</file>
<file path="index.php" hash="c9ccc99b190c39d963cff565d272a99c" 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="46" type="Require" package="Default">
<name>config/config.php</name>
</include>
<include line="49" type="Require" package="Default">
<name>common.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>
<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>