miniMVC/docs/structure.xml

1779 lines
78 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="miniMVC">
<file path="sys/core/Page.php" hash="60ca096d502dc547609abbb1e4b9e109" 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="miniMVC" line="27" package="miniMVC\System">
<name>Page</name>
<full_name>\miniMVC\Page</full_name>
<extends>\miniMVC\Output</extends>
<docblock line="18">
<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="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="System"/>
</docblock>
<property final="false" static="false" visibility="private" line="34" package="Default">
<name>$meta</name>
<default><![CDATA[]]></default>
<docblock line="29">
<description><![CDATA[Meta tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="29" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="41" package="Default">
<name>$head_js</name>
<default><![CDATA[]]></default>
<docblock line="36">
<description><![CDATA[JS tags for the header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="36" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="48" package="Default">
<name>$foot_js</name>
<default><![CDATA[]]></default>
<docblock line="43">
<description><![CDATA[JS tags for the footer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="43" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="55" package="Default">
<name>$css</name>
<default><![CDATA[]]></default>
<docblock line="50">
<description><![CDATA[CSS tags for the page]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="50" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="62" package="Default">
<name>$title</name>
<default><![CDATA[]]></default>
<docblock line="57">
<description><![CDATA[Page title]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="57" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="69" package="Default">
<name>$head_tags</name>
<default><![CDATA[]]></default>
<docblock line="64">
<description><![CDATA[Additional header tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="64" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="76" package="Default">
<name>$body_class</name>
<default><![CDATA[]]></default>
<docblock line="71">
<description><![CDATA[Class(es) to apply to the main body tag]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="71" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="83" package="Default">
<name>$body_id</name>
<default><![CDATA[]]></default>
<docblock line="78">
<description><![CDATA[Id to apply to the body tag]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="78" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="90" package="Default">
<name>$base</name>
<default><![CDATA[]]></default>
<docblock line="85">
<description><![CDATA[Base tag]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="85" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="98" package="">
<name>__construct</name>
<type>function</type>
<docblock line="92">
<description><![CDATA[Set up the page class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="92" name="param" description="object" type="" variable="$controller"/>
<tag line="92" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="98">
<name>$controller</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="118" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="115">
<description><![CDATA[call the parent destructor]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="miniMVC" line="135" package="">
<name>_headers</name>
<type>function</type>
<docblock line="125">
<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="125" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="125" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="135">
<name>$html5</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="176" package="">
<name>set_meta</name>
<type>function</type>
<docblock line="168">
<description><![CDATA[Set Meta]]></description>
<long-description><![CDATA[<p>Sets meta tags, with codeigniter native meta tag helper</p>]]></long-description>
<tag line="168" name="param" description="" type="array" variable="$meta">
<type by_reference="false">array</type>
</tag>
<tag line="168" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="176">
<name>$meta</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="191" package="">
<name>set_head_js_group</name>
<type>function</type>
<docblock line="184">
<description><![CDATA[Sets minified javascript group in header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="184" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="184" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="184" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="191">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="191">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="211" package="">
<name>set_css_group</name>
<type>function</type>
<docblock line="206">
<description><![CDATA[Sets a minified css group]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="206" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="206" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="211">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="232" package="">
<name>set_foot_js_group</name>
<type>function</type>
<docblock line="225">
<description><![CDATA[Sets a minified javascript group for the page footer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="225" name="param" description="" type="string" variable="$group">
<type by_reference="false">string</type>
</tag>
<tag line="225" name="param" description="" type="bool" variable="$debug">
<type by_reference="false">bool</type>
</tag>
<tag line="225" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="232">
<name>$group</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="232">
<name>$debug</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="248" package="">
<name>set_title</name>
<type>function</type>
<docblock line="242">
<description><![CDATA[Sets html title string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="242" name="param" description="" type="string" variable="$title">
<type by_reference="false">string</type>
</tag>
<tag line="242" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="248">
<name>$title</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="265" package="">
<name>set_body_class</name>
<type>function</type>
<docblock line="259">
<description><![CDATA[Sets custom body class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="259" name="param" description="" type="string" variable="$class">
<type by_reference="false">string</type>
</tag>
<tag line="259" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="265">
<name>$class</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="279" package="">
<name>set_body_id</name>
<type>function</type>
<docblock line="273">
<description><![CDATA[Sets custom body id]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="273" name="param" description="" type="string" variable="$id">
<type by_reference="false">string</type>
</tag>
<tag line="273" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="279">
<name>$id</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="293" package="">
<name>set_base</name>
<type>function</type>
<docblock line="287">
<description><![CDATA[Sets custom base href]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="287" name="param" description="href" type="string" variable="$href">
<type by_reference="false">string</type>
</tag>
<tag line="287" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="293">
<name>$href</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="309" package="">
<name>set_css_tag</name>
<type>function</type>
<docblock line="301">
<description><![CDATA[Sets custom css tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="301" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="301" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="301" name="param" description="" type="string" variable="$media">
<type by_reference="false">string</type>
</tag>
<tag line="301" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="309">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="309">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
<argument line="309">
<name>$media</name>
<default><![CDATA["all"]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="337" package="">
<name>set_head_tag</name>
<type>function</type>
<docblock line="331">
<description><![CDATA[Sets a custom tag in the header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="331" name="param" description="" type="string" variable="$tag">
<type by_reference="false">string</type>
</tag>
<tag line="331" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="337">
<name>$tag</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="351" package="">
<name>build_header</name>
<type>function</type>
<docblock line="345">
<description><![CDATA[Sets custom page header]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="345" name="param" description="" type="bool" variable="$html5">
<type by_reference="false">bool</type>
</tag>
<tag line="345" name="return" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
<argument line="351">
<name>$html5</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="409" package="">
<name>build_footer</name>
<type>function</type>
<docblock line="406">
<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="miniMVC" line="429" package="">
<name>script_tag</name>
<type>function</type>
<docblock line="420">
<description><![CDATA[Script Tag]]></description>
<long-description><![CDATA[<p>Helper function for making script tags</p>]]></long-description>
<tag line="420" name="param" description="" type="string" variable="$js">
<type by_reference="false">string</type>
</tag>
<tag line="420" name="param" description="" type="bool" variable="$domain">
<type by_reference="false">bool</type>
</tag>
<tag line="420" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="429">
<name>$js</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="429">
<name>$domain</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="455" package="">
<name>set_message</name>
<type>function</type>
<docblock line="446">
<description><![CDATA[Set Message]]></description>
<long-description><![CDATA[<p>Adds a message to the page</p>]]></long-description>
<tag line="446" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
<tag line="446" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="446" name="param" description="" type="bool" variable="$return">
<type by_reference="false">bool</type>
</tag>
<tag line="446" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="455">
<name>$type</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="455">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="455">
<name>$return</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="471" package="">
<name>redirect_303</name>
<type>function</type>
<docblock line="465">
<description><![CDATA[Redirect 303]]></description>
<long-description><![CDATA[<p>Shortcut function for 303 redirect</p>]]></long-description>
<tag line="465" name="param" description="" type="string" variable="$url">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="471">
<name>$url</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="486" package="">
<name>render</name>
<type>function</type>
<docblock line="479">
<description><![CDATA[Render]]></description>
<long-description><![CDATA[<p>Shortcut function for building a page</p>]]></long-description>
<tag line="479" name="param" description="" type="string" variable="$view">
<type by_reference="false">string</type>
</tag>
<tag line="479" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="486">
<name>$view</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="486">
<name>$data</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="503" package="">
<name>output_string</name>
<type>function</type>
<docblock line="495">
<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="495" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="503">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="miniMVC" line="518" package="">
<name>_meta</name>
<type>function</type>
<docblock line="512">
<description><![CDATA[Private helper function to generate meta tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="512" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="512" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="518">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="miniMVC" line="540" package="">
<name>_link_tag</name>
<type>function</type>
<docblock line="534">
<description><![CDATA[Private helper function to generate link tags]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="534" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="534" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="540">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/Model.php" hash="b361e4ab2beba0e44d6dbcbed91dfa5d" 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="miniMVC" line="24" package="miniMVC\System">
<name>Model</name>
<full_name>\miniMVC\Model</full_name>
<extends>\miniMVC\miniMVC</extends>
<docblock line="18">
<description><![CDATA[Base Model Class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="System"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="32" package="">
<name>__construct</name>
<type>function</type>
<docblock line="26">
<description><![CDATA[Initialize the model class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="param" description="" type="array" variable="$args">
<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>$args</name>
<default><![CDATA[[]]]></default>
<type>array</type>
</argument>
</method>
</class>
</file>
<file path="sys/core/traits/Singleton.php" hash="e6d59efcf93bb66f355bf6ae3d77d8b6" 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="miniMVC" line="38" package="miniMVC">
<name>__construct</name>
<type>function</type>
<docblock line="35">
<description><![CDATA[Protected constructor for creating the one instance]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</function>
<function namespace="miniMVC" line="46" package="miniMVC">
<name>__invoke</name>
<type>function</type>
<docblock line="40">
<description><![CDATA[PHP magic method that is called when an object is treated as a function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="40" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="40" name="return" description="" type="\miniMVC\self">
<type by_reference="false">\miniMVC\self</type>
</tag>
</docblock>
<argument line="46">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="58" package="miniMVC">
<name>get_instance</name>
<type>function</type>
<docblock line="53">
<description><![CDATA[Singleton getter function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="53" name="return" description="" type="\miniMVC\self">
<type by_reference="false">\miniMVC\self</type>
</tag>
</docblock>
</function>
<function namespace="miniMVC" line="75" package="miniMVC">
<name>__clone</name>
<type>function</type>
<docblock line="72">
<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="8d32b935def1aff8b8b347f95d2f834c" 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="miniMVC" line="34" package="miniMVC">
<name>__construct</name>
<type>function</type>
<docblock line="28">
<description><![CDATA[Constructor for creating the objects]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="28" name="param" description="" type="array" variable="$members">
<type by_reference="false">array</type>
</tag>
<tag line="28" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="34">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="51" package="miniMVC">
<name>__call</name>
<type>function</type>
<docblock line="45">
<description><![CDATA[PHP magic method to facilitate dynamic methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="45" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="45" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="51">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="51">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
</file>
<file path="sys/core/traits/Generic.php" hash="1321b8e04f6b8767b254bb505b515fa0" 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="miniMVC" line="31" package="miniMVC">
<name>__toString</name>
<type>function</type>
<docblock line="26">
<description><![CDATA[Prints out the contents of the object when used as a string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</function>
<function namespace="miniMVC" line="80" package="miniMVC">
<name>__invoke</name>
<type>function</type>
<docblock line="75">
<description><![CDATA[PHP magic method that is called when an object is treated as a function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="75" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="80">
<name>$args</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</function>
</file>
<file path="sys/core/Controller.php" hash="667aad9a95f4bf98f4b53998f6b56b61" 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="miniMVC" line="24" package="miniMVC\System">
<name>Controller</name>
<full_name>\miniMVC\Controller</full_name>
<extends>\miniMVC\miniMVC</extends>
<docblock line="18">
<description><![CDATA[Base Controller Class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="System"/>
</docblock>
<property final="false" static="false" visibility="protected" line="31" package="Default">
<name>$page</name>
<default><![CDATA[]]></default>
<docblock line="26">
<description><![CDATA[Instance of Page class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="var" description="" type="\miniMVC\Page">
<type by_reference="false">\miniMVC\Page</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="38" package="">
<name>__construct</name>
<type>function</type>
<docblock line="33">
<description><![CDATA[Create the controller object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="33" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="55" package="">
<name>load_model</name>
<type>function</type>
<docblock line="48">
<description><![CDATA[Function for loading a model into the current class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="48" name="param" description="" type="string" variable="$file">
<type by_reference="false">string</type>
</tag>
<tag line="48" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
<tag line="48" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="55">
<name>$file</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="55">
<name>$args</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="87" package="">
<name>load_view</name>
<type>function</type>
<docblock line="79">
<description><![CDATA[Function for loading a view]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="79" name="param" description="" type="string" variable="$file">
<type by_reference="false">string</type>
</tag>
<tag line="79" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
<tag line="79" name="param" description="" type="bool" variable="$return">
<type by_reference="false">bool</type>
</tag>
<tag line="79" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="87">
<name>$file</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="87">
<name>$data</name>
<default><![CDATA[[]]]></default>
<type>array</type>
</argument>
<argument line="87">
<name>$return</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/db.php" hash="64d50a594d7c19c615ecb0206df92c62" 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="miniMVC" line="24" package="miniMVC\System">
<name>DB</name>
<full_name>\miniMVC\DB</full_name>
<extends>\Query_Builder</extends>
<docblock line="18">
<description><![CDATA[Extend PHP's PDO class to add some more functionality]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="System"/>
</docblock>
<property final="false" static="true" visibility="private" line="33" package="Default">
<name>$instance</name>
<default><![CDATA[[]]]></default>
<docblock line="28">
<description><![CDATA[DB connection instances]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="28" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" namespace="miniMVC" line="42" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="35">
<description><![CDATA[Indexed singleton method]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="35" name="param" description="" type="string" variable="$dbname">
<type by_reference="false">string</type>
</tag>
<tag line="35" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
<tag line="35" name="return" description="" type="\miniMVC\DB">
<type by_reference="false">\miniMVC\DB</type>
</tag>
</docblock>
<argument line="42">
<name>$dbname</name>
<default><![CDATA["default"]]></default>
<type/>
</argument>
<argument line="42">
<name>$options</name>
<default><![CDATA[[]]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="72" package="">
<name>get_last_error</name>
<type>function</type>
<docblock line="67">
<description><![CDATA[Returns the last error from the database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="67" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/core/miniMVC.php" hash="2ff96660ae603ae633f21ad9469d07b0" 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="miniMVC" line="24" package="miniMVC\System">
<name>miniMVC</name>
<full_name>\miniMVC\miniMVC</full_name>
<extends>\miniMVC\MM</extends>
<docblock line="18">
<description><![CDATA[Base class for the framework]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="System"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="33" package="">
<name>__construct</name>
<type>function</type>
<docblock line="28">
<description><![CDATA[Constructor - Any classes loaded here become subclasses of miniMVC]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="28" name="param" description="" type="array" variable="$members">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="33">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="46" package="">
<name>unload</name>
<type>function</type>
<docblock line="41">
<description><![CDATA[Convenience function to remove an object from the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="41" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="46">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="61" package="">
<name>load_config</name>
<type>function</type>
<docblock line="56">
<description><![CDATA[Convenience function to load config files]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="56" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="61">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/MM.php" hash="e020442762736ad7b25a819d1583152d" 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="miniMVC" line="24" package="miniMVC\System">
<name>MM</name>
<full_name>\miniMVC\MM</full_name>
<extends>\ArrayObject</extends>
<docblock line="18">
<description><![CDATA[Class for standalone JSObject objects]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="System"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="33" package="">
<name>__construct</name>
<type>function</type>
<docblock line="28">
<description><![CDATA[Create the ArrayObject/JSObject hybrid object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="28" name="param" description="array" type="" variable="$members"/>
</docblock>
<argument line="33">
<name>$members</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="54" package="">
<name>__call</name>
<type>function</type>
<docblock line="46">
<description><![CDATA[Allow calling of array methods on the object and
dynamic methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="46" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="46" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="46" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="54">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="54">
<name>$params</name>
<default><![CDATA[[]]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/core/Output.php" hash="d4b32bf7dce445b5daa28f07bc719298" package="Default">
<parse_markers>
<error line="1" code="50007">No page-level DocBlock was found in file sys/core/Output.php</error>
</parse_markers>
<class final="false" abstract="false" namespace="miniMVC" line="23" package="miniMVC\System">
<name>Output</name>
<full_name>\miniMVC\Output</full_name>
<extends>\miniMVC\MM</extends>
<docblock line="17">
<description><![CDATA[Class for displaying output and setting http headers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="17" name="package" description="miniMVC"/>
<tag line="17" name="subpackage" description="System"/>
</docblock>
<property final="false" static="false" visibility="private" line="30" package="Default">
<name>$buffer</name>
<default><![CDATA[]]></default>
<docblock line="25">
<description><![CDATA[Content for outputting]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="25" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="37" package="Default">
<name>$headers</name>
<default><![CDATA[]]></default>
<docblock line="32">
<description><![CDATA[HTTP headers to send]]></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="public" namespace="miniMVC" line="44" package="">
<name>__construct</name>
<type>function</type>
<docblock line="39">
<description><![CDATA[Initialize the output class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="39" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="56" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="50">
<description><![CDATA[PHP magic method called when ending the script
Used for outputing HTML]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="50" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="99" package="">
<name>set_header</name>
<type>function</type>
<docblock line="93">
<description><![CDATA[Sets a header for later output]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="93" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="93" name="param" description="" type="string" variable="$val">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="99">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="99">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="111" package="">
<name>append_output</name>
<type>function</type>
<docblock line="106">
<description><![CDATA[Adds text to the output buffer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="106" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="111">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="123" package="">
<name>set_output</name>
<type>function</type>
<docblock line="118">
<description><![CDATA[Sets the output buffer]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="118" name="param" description="" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="123">
<name>$string</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="133" package="">
<name>flush_headers</name>
<type>function</type>
<docblock line="130">
<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="d0cff7dd482f59df76b3438fe9033357" 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="miniMVC" line="24" package="miniMVC\Libraries">
<name>Data_Store</name>
<full_name>\miniMVC\Data_Store</full_name>
<extends/>
<docblock line="18">
<description><![CDATA[Class for using JSON as a key->value data store]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="Libraries"/>
</docblock>
<property final="false" static="false" visibility="private" line="29" package="Default">
<name>$current</name>
<default><![CDATA[]]></default>
<docblock line="26">
<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="34" package="Default">
<name>$instance</name>
<default><![CDATA[]]></default>
<docblock line="31">
<description><![CDATA[Singleton instance]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="protected" namespace="miniMVC" line="39" package="">
<name>__construct</name>
<type>function</type>
<docblock line="36">
<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="miniMVC" line="63" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="60">
<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="miniMVC" line="75" package="">
<name>__clone</name>
<type>function</type>
<docblock line="72">
<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="miniMVC" line="88" package="">
<name>__get</name>
<type>function</type>
<docblock line="82">
<description><![CDATA[Magic method to simplify isset checking for config options]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="82" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="82" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="88">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="103" package="">
<name>__set</name>
<type>function</type>
<docblock line="97">
<description><![CDATA[Magic method to simplify setting config options]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="97" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="97" name="param" description="mixed" type="" variable="$val"/>
</docblock>
<argument line="103">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="103">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="true" visibility="public" namespace="miniMVC" line="116" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="110">
<description><![CDATA[Static method to retreive current instance
of the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="110" name="return" description="" type="\miniMVC\self">
<type by_reference="false">\miniMVC\self</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="135" package="">
<name>del</name>
<type>function</type>
<docblock line="129">
<description><![CDATA[Removes a key from the data store]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="129" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="129" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="135">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="147" package="">
<name>get_all</name>
<type>function</type>
<docblock line="142">
<description><![CDATA[Return the entire data store object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="142" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/libraries/session.php" hash="67c15805b1cf4092a6866eece79b66ae" 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="miniMVC" line="24" package="miniMVC\Libraries">
<name>Session</name>
<full_name>\miniMVC\Session</full_name>
<extends/>
<docblock line="18">
<description><![CDATA[Class to improve handling of PHP sessions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="miniMVC"/>
<tag line="18" name="subpackage" description="Libraries"/>
</docblock>
<property final="false" static="false" visibility="protected" line="39" package="Default">
<name>$sess</name>
<default><![CDATA[[]]]></default>
<docblock line="34">
<description><![CDATA[Reference to session superglobal]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="34" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="protected" namespace="miniMVC" line="44" package="">
<name>__construct</name>
<type>function</type>
<docblock line="41">
<description><![CDATA[Start a session]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="62" package="">
<name>__set</name>
<type>function</type>
<docblock line="55">
<description><![CDATA[Set a session value]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="55" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="55" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="55" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="62">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="62">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="75" package="">
<name>__get</name>
<type>function</type>
<docblock line="69">
<description><![CDATA[Retreive a session value]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="69" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="69" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="75">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="miniMVC" line="87" package="">
<name>destroy</name>
<type>function</type>
<docblock line="82">
<description><![CDATA[Destroy a session]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="82" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/common.php" hash="65c3745683afaec2ca05ae0d9875cba3" 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="miniMVC" line="34" package="miniMVC">
<name>sys_autoload</name>
<type>function</type>
<docblock line="29">
<description><![CDATA[Function to autoload system libraries]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="29" name="param" description="string" type="" variable="$name"/>
</docblock>
<argument line="34">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="58" package="miniMVC">
<name>autoload</name>
<type>function</type>
<docblock line="53">
<description><![CDATA[Function to autoload libraries/classes]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="53" name="param" description="string" type="" variable="$name"/>
</docblock>
<argument line="58">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="107" package="miniMVC">
<name>shutdown</name>
<type>function</type>
<docblock line="100">
<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="100" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="miniMVC" line="140" package="miniMVC">
<name>on_error</name>
<type>function</type>
<docblock line="131">
<description><![CDATA[Custom error handler]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="131" name="param" description="" type="int" variable="$severity">
<type by_reference="false">int</type>
</tag>
<tag line="131" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="131" name="param" description="" type="string" variable="$filepath">
<type by_reference="false">string</type>
</tag>
<tag line="131" name="param" description="" type="int" variable="$line">
<type by_reference="false">int</type>
</tag>
<tag line="131" name="return" description="" type="\miniMVC\ErrorException">
<type by_reference="false">\miniMVC\ErrorException</type>
</tag>
</docblock>
<argument line="140">
<name>$severity</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="140">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="140">
<name>$filepath</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="140">
<name>$line</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="153" package="miniMVC">
<name>on_exception</name>
<type>function</type>
<docblock line="147">
<description><![CDATA[Custom exception handlererror_get_last]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="147" name="param" description="" type="\miniMVC\Exception" variable="$exception">
<type by_reference="false">\miniMVC\Exception</type>
</tag>
<tag line="147" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="153">
<name>$exception</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="175" package="miniMVC">
<name>show_404</name>
<type>function</type>
<docblock line="170">
<description><![CDATA[General 404 function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="170" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="miniMVC" line="200" package="miniMVC">
<name>show_error</name>
<type>function</type>
<docblock line="194">
<description><![CDATA[Fatal Error page function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="194" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="194" name="param" description="" type="int" variable="$status_code">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="200">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="200">
<name>$status_code</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="227" package="miniMVC">
<name>is_like_array</name>
<type>function</type>
<docblock line="221">
<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="221" name="param" description="" type="mixed" variable="$var">
<type by_reference="false">mixed</type>
</tag>
<tag line="221" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="227">
<name>$var</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="245" package="miniMVC">
<name>controller_methods</name>
<type>function</type>
<docblock line="239">
<description><![CDATA[Returns routable methods for the specified controller class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="239" name="param" description="" type="string" variable="$controller">
<type by_reference="false">string</type>
</tag>
<tag line="239" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="245">
<name>$controller</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="264" package="miniMVC">
<name>site_url</name>
<type>function</type>
<docblock line="258">
<description><![CDATA[Returns a full url from a url segment]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="258" name="param" description="" type="string" variable="$segment">
<type by_reference="false">string</type>
</tag>
<tag line="258" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="264">
<name>$segment</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="278" package="miniMVC">
<name>to_string</name>
<type>function</type>
<docblock line="271">
<description><![CDATA[Prints out the contents of the object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="271" name="param" description="" type="\miniMVC\object/array" variable="$data">
<type by_reference="false">\miniMVC\object/array</type>
</tag>
<tag line="271" name="param" description="" type="string" variable="$method">
<type by_reference="false">string</type>
</tag>
<tag line="271" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="278">
<name>$data</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="278">
<name>$method</name>
<default><![CDATA['print_r']]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="314" package="miniMVC">
<name>do_include</name>
<type>function</type>
<docblock line="308">
<description><![CDATA[Array_map callback to load a folder of classes at once]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="308" name="param" description="" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="308" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="314">
<name>$path</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="miniMVC" line="329" package="miniMVC">
<name>init</name>
<type>function</type>
<docblock line="324">
<description><![CDATA[Load required classes for bootstraping]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="324" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
<function namespace="miniMVC" line="353" package="miniMVC">
<name>route</name>
<type>function</type>
<docblock line="348">
<description><![CDATA[Calls the appropriate module/controller/function based on the url]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="348" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</function>
</file>
<file path="index.php" hash="baecffb4547967ea70c605f3aaeb24ae" 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"/>
<namespace name="miniMVC" full_name="miniMVC"/>
<marker count="0">todo</marker>
<marker count="0">fixme</marker>
<deprecated count="0"/>
</project>