miniMVC/docs/structure.xml

1783 lines
78 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="miniMVC">
<file path="sys/core/MM_Page.php" hash="119d5ab854ddc770fca052e6c6e302e5" 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="public" namespace="default" line="116" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="113">
<description><![CDATA[call the parent destructor]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="133" package="">
<name>_headers</name>
<type>function</type>
<docblock line="123">
<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="123" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="123" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="133">
<name>$html5</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="174" package="">
<name>set_meta</name>
<type>function</type>
<docblock line="166">
<description><![CDATA[Set Meta]]></description>
<long-description><![CDATA[<p>Sets meta tags, with codeigniter native meta tag helper</p>]]></long-description>
<tag line="166" name="param" description="" type="array" variable="$meta">
<type by_reference="false">array</type>
</tag>
<tag line="166" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="174">
<name>$meta</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="189" package="">
<name>set_head_js_group</name>
<type>function</type>
<docblock line="182">
<description><![CDATA[Sets minified javascript group in header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="182" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="182" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="182" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="189">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="189">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="209" package="">
<name>set_css_group</name>
<type>function</type>
<docblock line="204">
<description><![CDATA[Sets a minified css group]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="204" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="204" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="209">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="230" package="">
<name>set_foot_js_group</name>
<type>function</type>
<docblock line="223">
<description><![CDATA[Sets a minified javascript group for the page footer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="223" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="223" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="223" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="230">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="230">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="246" package="">
<name>set_title</name>
<type>function</type>
<docblock line="240">
<description><![CDATA[Sets html title string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="240" name="param" description="" type="string" variable="$title">
<type by_reference="false">string</type>
</tag>
<tag line="240" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="246">
<name>$title</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="263" package="">
<name>set_body_class</name>
<type>function</type>
<docblock line="257">
<description><![CDATA[Sets custom body class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="257" name="param" description="" type="string" variable="$class">
<type by_reference="false">string</type>
</tag>
<tag line="257" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="263">
<name>$class</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="277" package="">
<name>set_body_id</name>
<type>function</type>
<docblock line="271">
<description><![CDATA[Sets custom body id]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="271" name="param" description="" type="string" variable="$id">
<type by_reference="false">string</type>
</tag>
<tag line="271" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="277">
<name>$id</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="291" package="">
<name>set_base</name>
<type>function</type>
<docblock line="285">
<description><![CDATA[Sets custom base href]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="285" name="param" description="href" type="string" variable="$href">
<type by_reference="false">string</type>
</tag>
<tag line="285" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="291">
<name>$href</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="307" package="">
<name>set_css_tag</name>
<type>function</type>
<docblock line="299">
<description><![CDATA[Sets custom css tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="299" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="299" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="299" name="param" description="" type="string" variable="$media">
<type by_reference="false">string</type>
</tag>
<tag line="299" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="307">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="307">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
<argument line="307">
<name>$media</name>
<default><![CDATA["all"]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="335" package="">
<name>set_head_tag</name>
<type>function</type>
<docblock line="329">
<description><![CDATA[Sets a custom tag in the header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="329" name="param" description="" type="string" variable="$tag">
<type by_reference="false">string</type>
</tag>
<tag line="329" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="335">
<name>$tag</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="349" package="">
<name>build_header</name>
<type>function</type>
<docblock line="343">
<description><![CDATA[Sets custom page header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="343" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="343" name="return" description="" type="\Page">
<type by_reference="false">\Page</type>
</tag>
</docblock>
<argument line="349">
<name>$html5</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="407" package="">
<name>build_footer</name>
<type>function</type>
<docblock line="404">
<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="427" package="">
<name>script_tag</name>
<type>function</type>
<docblock line="418">
<description><![CDATA[Script Tag]]></description>
<long-description><![CDATA[<p>Helper function for making script tags</p>]]></long-description>
<tag line="418" name="param" description="" type="string" variable="$js">
<type by_reference="false">string</type>
</tag>
<tag line="418" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="418" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="427">
<name>$js</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="427">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="453" package="">
<name>set_message</name>
<type>function</type>
<docblock line="444">
<description><![CDATA[Set Message]]></description>
<long-description><![CDATA[<p>Adds a message to the page</p>]]></long-description>
<tag line="444" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
<tag line="444" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="444" name="param" description="" type="bool" variable="$return">
<type by_reference="false">bool</type>
</tag>
<tag line="444" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="453">
<name>$type</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="453">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="453">
<name>$return</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="469" package="">
<name>redirect_303</name>
<type>function</type>
<docblock line="463">
<description><![CDATA[Redirect 303]]></description>
<long-description><![CDATA[<p>Shortcut function for 303 redirect</p>]]></long-description>
<tag line="463" name="param" description="" type="string" variable="$url">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="469">
<name>$url</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="484" package="">
<name>render</name>
<type>function</type>
<docblock line="477">
<description><![CDATA[Render]]></description>
<long-description><![CDATA[<p>Shortcut function for building a page</p>]]></long-description>
<tag line="477" name="param" description="" type="string" variable="$view">
<type by_reference="false">string</type>
</tag>
<tag line="477" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="484">
<name>$view</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="484">
<name>$data</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="501" package="">
<name>output_string</name>
<type>function</type>
<docblock line="493">
<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="493" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="501">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="516" package="">
<name>_meta</name>
<type>function</type>
<docblock line="510">
<description><![CDATA[Private helper function to generate meta tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="510" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="510" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="516">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="538" package="">
<name>_link_tag</name>
<type>function</type>
<docblock line="532">
<description><![CDATA[Private helper function to generate link tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="532" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="532" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="538">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/MM_Output.php" hash="beb51a0697f47630474275ef0a0fb919" 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/core/traits/Singleton.php" hash="f918c0d3610dae789decf8d36446e006" 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>
<namespace-alias name="Generic">Generic</namespace-alias>
<function namespace="default" line="36" package="miniMVC">
<name>__construct</name>
<type>function</type>
<docblock line="33">
<description><![CDATA[Protected constructor for creating the one instance]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</function>
<function namespace="default" line="44" package="miniMVC">
<name>__invoke</name>
<type>function</type>
<docblock line="38">
<description><![CDATA[PHP magic method that is called when an object is treated as a function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="38" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="38" name="return" description="" type="\self">
<type by_reference="false">\self</type>
</tag>
</docblock>
<argument line="44">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="56" package="miniMVC">
<name>get_instance</name>
<type>function</type>
<docblock line="51">
<description><![CDATA[Singleton getter function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="51" name="return" description="" type="\self">
<type by_reference="false">\self</type>
</tag>
</docblock>
</function>
<function namespace="default" line="73" package="miniMVC">
<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>
</function>
</file>
<file path="sys/core/traits/JSObject.php" hash="59936305b240a482a7893bacd6a7688d" 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>
<namespace-alias name="Generic">Generic</namespace-alias>
<function namespace="default" line="32" package="miniMVC">
<name>__construct</name>
<type>function</type>
<docblock line="26">
<description><![CDATA[Constructor for creating the objects]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="param" description="" type="array" variable="$members">
<type by_reference="false">array</type>
</tag>
<tag line="26" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="32">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</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>
</file>
<file path="sys/core/traits/Generic.php" hash="7938b5820dc4f793a1528615ffa3ece3" 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="29" package="miniMVC">
<name>__toString</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Prints out the contents of the object when used as a string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</function>
<function namespace="default" line="78" package="miniMVC">
<name>__invoke</name>
<type>function</type>
<docblock line="73">
<description><![CDATA[PHP magic method that is called when an object is treated as a function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="73" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="78">
<name>$args</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
</file>
<file path="sys/core/MM_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/db.php" hash="0b3d58a614cbb5d672d5dd7b51a84ced" 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>get_last_error</name>
<type>function</type>
<docblock line="65">
<description><![CDATA[Returns the last error from the database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="65" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/core/miniMVC.php" hash="0952b658ffbf7f7b39c41df1bdd38b3b" 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="44" package="">
<name>unload</name>
<type>function</type>
<docblock line="39">
<description><![CDATA[Convenience function to remove an object from 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>
</docblock>
<argument line="44">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="59" package="">
<name>load_config</name>
<type>function</type>
<docblock line="54">
<description><![CDATA[Convenience function to load config files]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="54" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="59">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/MM.php" hash="6725573f5bc81ec902ceb4156316fa5b" 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/MM_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/libraries/data_store.php" hash="8d15c1816330c074a0c1987c58967e7b" 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>Data_Store</name>
<full_name>\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="ea0f273bfb95c57a3d8399477e105ec7" 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>Session</name>
<full_name>\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="f99fe521580d225fb4a92e8d7df92294" 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>sys_autoload</name>
<type>function</type>
<docblock line="27">
<description><![CDATA[Function to autoload system libraries]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="27" name="param" description="string" type="" variable="$name"/>
</docblock>
<argument line="32">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="54" package="miniMVC">
<name>autoload</name>
<type>function</type>
<docblock line="49">
<description><![CDATA[Function to autoload libraries/classes]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="49" name="param" description="string" type="" variable="$name"/>
</docblock>
<argument line="54">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="93" package="miniMVC">
<name>shutdown</name>
<type>function</type>
<docblock line="86">
<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="86" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="126" package="miniMVC">
<name>on_error</name>
<type>function</type>
<docblock line="117">
<description><![CDATA[Custom error handler]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="117" name="param" description="" type="int" variable="$severity">
<type by_reference="false">int</type>
</tag>
<tag line="117" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="117" name="param" description="" type="string" variable="$filepath">
<type by_reference="false">string</type>
</tag>
<tag line="117" name="param" description="" type="int" variable="$line">
<type by_reference="false">int</type>
</tag>
<tag line="117" name="return" description="" type="\ErrorException">
<type by_reference="false">\ErrorException</type>
</tag>
</docblock>
<argument line="126">
<name>$severity</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="126">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="126">
<name>$filepath</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="126">
<name>$line</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="139" package="miniMVC">
<name>on_exception</name>
<type>function</type>
<docblock line="133">
<description><![CDATA[Custom exception handlererror_get_last]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="133" name="param" description="" type="\Exception" variable="$exception">
<type by_reference="false">\Exception</type>
</tag>
<tag line="133" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="139">
<name>$exception</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="161" package="miniMVC">
<name>show_404</name>
<type>function</type>
<docblock line="156">
<description><![CDATA[General 404 function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="156" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="186" package="miniMVC">
<name>show_error</name>
<type>function</type>
<docblock line="180">
<description><![CDATA[Fatal Error page function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="180" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="180" name="param" description="" type="int" variable="$status_code">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="186">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="186">
<name>$status_code</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="213" package="miniMVC">
<name>is_like_array</name>
<type>function</type>
<docblock line="207">
<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="207" name="param" description="" type="mixed" variable="$var">
<type by_reference="false">mixed</type>
</tag>
<tag line="207" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="213">
<name>$var</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="231" package="miniMVC">
<name>controller_methods</name>
<type>function</type>
<docblock line="225">
<description><![CDATA[Returns routable methods for the specified controller class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="225" name="param" description="" type="string" variable="$controller">
<type by_reference="false">string</type>
</tag>
<tag line="225" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="231">
<name>$controller</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="250" package="miniMVC">
<name>site_url</name>
<type>function</type>
<docblock line="244">
<description><![CDATA[Returns a full url from a url segment]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="244" name="param" description="" type="string" variable="$segment">
<type by_reference="false">string</type>
</tag>
<tag line="244" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="250">
<name>$segment</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="264" package="miniMVC">
<name>to_string</name>
<type>function</type>
<docblock line="257">
<description><![CDATA[Prints out the contents of the object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="257" name="param" description="" type="\object/array" variable="$data">
<type by_reference="false">\object/array</type>
</tag>
<tag line="257" name="param" description="" type="string" variable="$method">
<type by_reference="false">string</type>
</tag>
<tag line="257" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="264">
<name>$data</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="264">
<name>$method</name>
<default><![CDATA['print_r']]></default>
<type/>
</argument>
</function>
<function namespace="default" line="300" package="miniMVC">
<name>do_include</name>
<type>function</type>
<docblock line="294">
<description><![CDATA[Array_map callback to load a folder of classes at once]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="294" name="param" description="" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="294" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="300">
<name>$path</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="315" package="miniMVC">
<name>init</name>
<type>function</type>
<docblock line="310">
<description><![CDATA[Load required classes for bootstraping]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="310" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="default" line="345" package="miniMVC">
<name>route</name>
<type>function</type>
<docblock line="340">
<description><![CDATA[Calls the appropriate module/controller/function based on the url]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="340" 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>