<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Moc10_Form</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Moc10_Form</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Moc10_Form</p>
<ul class="tags">
<li><span class="field">author:</span> Nick Sagona, III <<a href="mailto:hide@address.com">hide@address.com</a>></li>
<li><span class="field">version:</span> 1.9.7</li>
<li><span class="field">copyright:</span> Copyright (c) 2009-2011 Moc 10 Media, LLC. (http://www.moc10media.com)</li>
<li><span class="field">license:</span> <a href="http://www.moc10phplibrary.com/LICENSE.TXT">New BSD License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Form.php.html">/Form.php</a> (line <span class="field">33</span>)
</p>
<pre><a href="../Moc10_Dom/Moc10_Dom.html">Moc10_Dom</a>
|
--Moc10_Form</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_action" title="details" class="var-name">$_action</a>
</div>
<div class="var-title">
<span class="var-type"><a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span>
<a href="#$_form" title="details" class="var-name">$_form</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$_initValues" title="details" class="var-name">$_initValues</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_method" title="details" class="var-name">$_method</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_template" title="details" class="var-name">$_template</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">string</span> <span class="var-name">$action</span>, <span class="var-type">string</span> <span class="var-name">$method</span>, [<span class="var-type">string</span> <span class="var-name">$indent</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#addElements" title="details" class="method-name">addElements</a>
(<span class="var-type">array|string</span> <span class="var-name">$e</span>)
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getAttributes" title="details" class="method-name">getAttributes</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getElements" title="details" class="method-name">getElements</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getTemplate" title="details" class="method-name">getTemplate</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#isValid" title="details" class="method-name">isValid</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#processInitValues" title="details" class="method-name">processInitValues</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#render" title="details" class="method-name">render</a>
([<span class="var-type">boolean</span> <span class="var-name">$ret</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setAttributes" title="details" class="method-name">setAttributes</a>
(<span class="var-type">array|string</span> <span class="var-name">$a</span>, [<span class="var-type">string</span> <span class="var-name">$v</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setInitValues" title="details" class="method-name">setInitValues</a>
(<span class="var-type">array</span> <span class="var-name">$values</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setPostValues" title="details" class="method-name">setPostValues</a>
(<span class="var-type">array</span> <span class="var-name">$post</span>, [<span class="var-type">boolean</span> <span class="var-name">$filter</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setTemplate" title="details" class="method-name">setTemplate</a>
(<span class="var-type">string</span> <span class="var-name">$tmpl</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#__toString" title="details" class="method-name">__toString</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$_action" id="$_action"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_action</span>
= <span class="var-default"> null</span> (line <span class="line-number">46</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Form action</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_form" id="$_form"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type"><a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span>
<span class="var-name">$_form</span>
= <span class="var-default"> null</span> (line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Form element node</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_initValues" id="$_initValues"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$_initValues</span>
= <span class="var-default">array()</span> (line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Form init values for quick setup</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_method" id="$_method"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_method</span>
= <span class="var-default"> null</span> (line <span class="line-number">52</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Form method</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_template" id="$_template"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_template</span>
= <span class="var-default"> null</span> (line <span class="line-number">58</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Form template for HTML formatting.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<a name='inherited_vars'><!-- --></a>
<p>Inherited from <span class="classname"><a href="../Moc10_Dom/Moc10_Dom.html">Moc10_Dom</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_charset">Moc10_Dom::$_charset</a></span><br />
</span>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_childNodes">Moc10_Dom::$_childNodes</a></span><br />
</span>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_contentType">Moc10_Dom::$_contentType</a></span><br />
</span>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_doctypes">Moc10_Dom::$_doctypes</a></span><br />
</span>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_indent">Moc10_Dom::$_indent</a></span><br />
</span>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_lang">Moc10_Dom::$_lang</a></span><br />
</span>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_output">Moc10_Dom::$_output</a></span><br />
</span>
<span class="var-title">
<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom.html#var$_type">Moc10_Dom::$_type</a></span><br />
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<a name='method_detail'></a>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">76</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description">Instantiate the form object</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">string</span> <span class="var-name">$action</span>, <span class="var-type">string</span> <span class="var-name">$method</span>, [<span class="var-type">string</span> <span class="var-name">$indent</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$action</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$method</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$indent</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Moc10_Dom/Moc10_Dom.html#method__construct">Moc10_Dom::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="methodaddElements" id="addElements"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">addElements</span> (line <span class="line-number">359</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a form element or elements to the form object.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
addElements
</span>
(<span class="var-type">array|string</span> <span class="var-name">$e</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array|string</span>
<span class="var-name">$e</span> </li>
</ul>
</div>
<a name="methodgetAttributes" id="getAttributes"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getAttributes</span> (line <span class="line-number">346</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the attributes of the form object.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getAttributes
</span>
()
</div>
</div>
<a name="methodgetElements" id="getElements"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getElements</span> (line <span class="line-number">371</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the elements of the form object.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getElements
</span>
()
</div>
</div>
<a name="methodgetTemplate" id="getTemplate"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getTemplate</span> (line <span class="line-number">320</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the form template for the render method to utilize.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getTemplate
</span>
()
</div>
</div>
<a name="methodisValid" id="isValid"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">isValid</span> (line <span class="line-number">383</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determine whether or not the form object is valid and return the result.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
isValid
</span>
()
</div>
</div>
<a name="methodprocessInitValues" id="processInitValues"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">processInitValues</span> (line <span class="line-number">118</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Process the init values of the form object.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
processInitValues
</span>
()
</div>
</div>
<a name="methodrender" id="render"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">render</span> (line <span class="line-number">410</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Render the form object using the defined template. The template should use a simple search and replace format that contains [{element}] and/or [{element_label}] for the placeholders that will be swapped out.</p>
<p class="description">Required fields' labels have class="required" and error messages have class="error" for styling purposes.</p>
<ul class="tags">
<li><span class="field">throws:</span> Exception</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
render
</span>
([<span class="var-type">boolean</span> <span class="var-name">$ret</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">boolean</span>
<span class="var-name">$ret</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Moc10_Dom/Moc10_Dom.html#methodrender">Moc10_Dom::render()</a></dt>
<dd>Method to render the document and its elements.</dd>
</dl>
</div>
<a name="methodsetAttributes" id="setAttributes"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setAttributes</span> (line <span class="line-number">334</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set an attribute or attributes for the form object.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setAttributes
</span>
(<span class="var-type">array|string</span> <span class="var-name">$a</span>, [<span class="var-type">string</span> <span class="var-name">$v</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array|string</span>
<span class="var-name">$a</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$v</span> </li>
</ul>
</div>
<a name="methodsetInitValues" id="setInitValues"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setInitValues</span> (line <span class="line-number">98</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the init values of the form object.</p>
<ul class="tags">
<li><span class="field">throws:</span> Exception</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setInitValues
</span>
(<span class="var-type">array</span> <span class="var-name">$values</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$values</span> </li>
</ul>
</div>
<a name="methodsetPostValues" id="setPostValues"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setPostValues</span> (line <span class="line-number">210</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set $_POST values to $initValues.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setPostValues
</span>
(<span class="var-type">array</span> <span class="var-name">$post</span>, [<span class="var-type">boolean</span> <span class="var-name">$filter</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$post</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$filter</span> </li>
</ul>
</div>
<a name="methodsetTemplate" id="setTemplate"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setTemplate</span> (line <span class="line-number">308</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set a form template for the render method to utilize.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setTemplate
</span>
(<span class="var-type">string</span> <span class="var-name">$tmpl</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$tmpl</span> </li>
</ul>
</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__toString</span> (line <span class="line-number">517</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Output the form object in a basic HTML format. Each form element is formatted to a 1:1 label to element ratio, using <dl>, <dt> and <dd> tags. Required fields' labels have class="required" and error messages have class="error" for styling purposes.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
__toString
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../Moc10_Dom/Moc10_Dom.html">Moc10_Dom</a></span></p>
<blockquote>
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#method__construct">Moc10_Dom::__construct()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodaddChildren">Moc10_Dom::addChildren()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodgetCharset">Moc10_Dom::getCharset()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodgetChildren">Moc10_Dom::getChildren()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodgetIndent">Moc10_Dom::getIndent()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodgetType">Moc10_Dom::getType()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodremoveChildren">Moc10_Dom::removeChildren()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodrender">Moc10_Dom::render()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodsetCharset">Moc10_Dom::setCharset()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodsetDTD">Moc10_Dom::setDTD()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodsetIndent">Moc10_Dom::setIndent()</a></span><br />
<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom.html#methodsetType">Moc10_Dom::setType()</a></span><br />
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 12 Jan 2011 01:17:43 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>