<?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_Dom</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_Dom</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-descendents">Descendents</a>
| <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_Dom</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="_Dom.php.html">/Dom.php</a> (line <span class="field">33</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</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">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../Moc10_Feed/Moc10_Feed_Writer.html">Moc10_Feed_Writer</a></td>
<td>
Moc10_Feed_Writer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../Moc10_Form/Moc10_Form.html">Moc10_Form</a></td>
<td>
Moc10_Form
</td>
</tr>
</table>
</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> |
<a href="#sec-descendents">Descendents</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="#$_charset" title="details" class="var-name">$_charset</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$_childNodes" title="details" class="var-name">$_childNodes</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_contentType" title="details" class="var-name">$_contentType</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$_doctypes" title="details" class="var-name">$_doctypes</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_indent" title="details" class="var-name">$_indent</a>
</div>
<div class="var-title">
<span class="var-type"><a href="../Moc10_Language/Moc10_Language.html">Moc10_Language</a></span>
<a href="#$_lang" title="details" class="var-name">$_lang</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_output" title="details" class="var-name">$_output</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_type" title="details" class="var-name">$_type</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-descendents">Descendents</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">$type</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$charset</span> = <span class="var-default">'utf-8'</span>], [<span class="var-type">array|<a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span> <span class="var-name">$childNode</span> = <span class="var-default">null</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="#addChildren" title="details" class="method-name">addChildren</a>
(<span class="var-type">array|<a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span> <span class="var-name">$c</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getCharset" title="details" class="method-name">getCharset</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getChildren" title="details" class="method-name">getChildren</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getIndent" title="details" class="method-name">getIndent</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getType" title="details" class="method-name">getType</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#removeChildren" title="details" class="method-name">removeChildren</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="#setCharset" title="details" class="method-name">setCharset</a>
(<span class="var-type">string</span> <span class="var-name">$chr</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setDTD" title="details" class="method-name">setDTD</a>
(<span class="var-type">string</span> <span class="var-name">$dtd</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setIndent" title="details" class="method-name">setIndent</a>
(<span class="var-type">string</span> <span class="var-name">$ind</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setType" title="details" class="method-name">setType</a>
(<span class="var-type">string</span> <span class="var-name">$type</span>)
</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-descendents">Descendents</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$_charset" id="$_charset"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_charset</span>
= <span class="var-default"> 'utf-8'</span> (line <span class="line-number">52</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Document charset</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_childNodes" id="$_childNodes"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$_childNodes</span>
= <span class="var-default">array()</span> (line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Document children</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_contentType" id="$_contentType"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_contentType</span>
= <span class="var-default"> 'text/html'</span> (line <span class="line-number">46</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Document content type</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_doctypes" id="$_doctypes"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$_doctypes</span>
= <span class="var-default">array('HTML_TRANS' => "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">\n",<br /> 'HTML_STRICT' => "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">\n",<br /> 'HTML_FRAMES' => "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Frameset//EN\" \"http://www.w3.org/TR/html4/frameset.dtd\">\n",<br /> 'XHTML_TRANS' => "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n",<br /> 'XHTML_STRICT' => "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n",<br /> 'XHTML_FRAMES' => "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Frameset//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd\">\n",<br /> 'XHTML11' => "<?xml version=\"1.0\" encoding=\"[{charset}]\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">\n",<br /> 'XML' => "<?xml version=\"1.0\" encoding=\"[{charset}]\"?>\n",<br /> 'RSS' => "<?xml version=\"1.0\" encoding=\"[{charset}]\"?>\n",<br /> 'ATOM' => "<?xml version=\"1.0\" encoding=\"[{charset}]\"?>\n")</span> (line <span class="line-number">76</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Document doctypes</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_indent" id="$_indent"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_indent</span>
= <span class="var-default"> null</span> (line <span class="line-number">58</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Document indent</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_lang" id="$_lang"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type"><a href="../Moc10_Language/Moc10_Language.html">Moc10_Language</a></span>
<span class="var-name">$_lang</span>
= <span class="var-default"> null</span> (line <span class="line-number">91</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Language object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_output" id="$_output"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_output</span>
= <span class="var-default"> null</span> (line <span class="line-number">70</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Document output</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_type" id="$_type"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_type</span>
= <span class="var-default"> null</span> (line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Document type</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
</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-descendents">Descendents</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">105</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description">Instantiate the document 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">
__construct
</span>
([<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$charset</span> = <span class="var-default">'utf-8'</span>], [<span class="var-type">array|<a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span> <span class="var-name">$childNode</span> = <span class="var-default">null</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">$type</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$charset</span> </li>
<li>
<span class="var-type">array|<a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span>
<span class="var-name">$childNode</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$indent</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../Moc10_Feed/Moc10_Feed_Writer.html#method__construct">Moc10_Feed_Writer::__construct()</a>
: Constructor
</li>
<li>
<a href="../Moc10_Form/Moc10_Form.html#method__construct">Moc10_Form::__construct()</a>
: Constructor
</li>
</ul>
</div>
<a name="methodaddChildren" id="addChildren"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">addChildren</span> (line <span class="line-number">229</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a child or children to the child element.</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">
addChildren
</span>
(<span class="var-type">array|<a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span> <span class="var-name">$c</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array|<a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span>
<span class="var-name">$c</span> </li>
</ul>
</div>
<a name="methodgetCharset" id="getCharset"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getCharset</span> (line <span class="line-number">149</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to return the document charset.</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">
getCharset
</span>
()
</div>
</div>
<a name="methodgetChildren" id="getChildren"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getChildren</span> (line <span class="line-number">263</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the child nodes of the document.</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">
getChildren
</span>
()
</div>
</div>
<a name="methodgetIndent" id="getIndent"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getIndent</span> (line <span class="line-number">161</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to return the document indent.</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">
getIndent
</span>
()
</div>
</div>
<a name="methodgetType" id="getType"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getType</span> (line <span class="line-number">137</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to return the document type.</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">
getType
</span>
()
</div>
</div>
<a name="methodremoveChildren" id="removeChildren"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">removeChildren</span> (line <span class="line-number">275</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove all child nodes from the document 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">
removeChildren
</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">288</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to render the document and its elements.</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">
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">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../Moc10_Form/Moc10_Form.html#methodrender">Moc10_Form::render()</a>
: 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.
</li>
</ul>
</div>
<a name="methodsetCharset" id="setCharset"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setCharset</span> (line <span class="line-number">202</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to set the document charset.</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">
setCharset
</span>
(<span class="var-type">string</span> <span class="var-name">$chr</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$chr</span> </li>
</ul>
</div>
<a name="methodsetDTD" id="setDTD"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setDTD</span> (line <span class="line-number">187</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to set the document type declaration in the doctype header.</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">
setDTD
</span>
(<span class="var-type">string</span> <span class="var-name">$dtd</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$dtd</span> </li>
</ul>
</div>
<a name="methodsetIndent" id="setIndent"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setIndent</span> (line <span class="line-number">215</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to set the document indent.</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">
setIndent
</span>
(<span class="var-type">string</span> <span class="var-name">$ind</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$ind</span> </li>
</ul>
</div>
<a name="methodsetType" id="setType"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setType</span> (line <span class="line-number">174</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Method to set the document type.</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">
setType
</span>
(<span class="var-type">string</span> <span class="var-name">$type</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$type</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 12 Jan 2011 01:17:42 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>