1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<head> |
<head> |
5 |
<!-- template designed by Marco Von Ballmoos --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<title>Docs For Class XMLDocumentClass</title> |
<title>Docs For Class XMLDocumentClass</title> |
7 |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
</head> |
</head> |
10 |
<body> |
<body> |
11 |
<div class="page-body"> |
<div class="page-body"> |
12 |
<h2 class="class-name">Class XMLDocumentClass</h2> |
<h2 class="class-name">Class XMLDocumentClass</h2> |
13 |
|
|
14 |
<a name="sec-description"></a> |
<a name="sec-description"></a> |
15 |
<div class="info-box"> |
<div class="info-box"> |
16 |
<div class="info-box-title">Description</div> |
<div class="info-box-title">Description</div> |
17 |
<div class="nav-bar"> |
<div class="nav-bar"> |
18 |
<span class="disabled">Description</span> | |
<span class="disabled">Description</span> | |
19 |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-descendents">Descendents</a> |
20 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
21 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
22 |
|
|
23 |
</div> |
</div> |
24 |
<div class="info-box-body"> |
<div class="info-box-body"> |
25 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
26 |
<p class="short-description">This class lets you build a complete xml document and render it.</p> |
<p class="short-description">This class lets you build a complete xml document and render it.</p> |
27 |
<p class="description"><p>It automatically creates the root xml tag that will contain all of the content. The name of the tag is the first parameter to the constructor. You can add/change the attributes to the root tag via the set_root_attributes() or the set_root_attribute() methods.</p></p> |
<p class="description"><p>It automatically creates the root xml tag that will contain all of the content. The name of the tag is the first parameter to the constructor. You can add/change the attributes to the root tag via the set_root_attributes() or the set_root_attribute() methods.</p></p> |
28 |
<ul class="tags"> |
<ul class="tags"> |
29 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
30 |
</ul> |
</ul> |
31 |
<p class="notes"> |
<p class="notes"> |
32 |
Located in <a class="field" href="_widgets_xml_XMLDocumentClass_inc.html">Program_Root/widgets/xml/XMLDocumentClass.inc</a> (line <span class="field">29</span>) |
Located in <a class="field" href="_widgets_xml_XMLDocumentClass_inc.html">/widgets/xml/XMLDocumentClass.inc</a> (line <span class="field">29</span>) |
33 |
</p> |
</p> |
34 |
|
|
35 |
|
|
36 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
37 |
| |
| |
|
--XMLDocumentClass</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="../phpHtmlLib/WMLDocumentClass.html">WMLDocumentClass</a></td> |
|
|
<td> |
|
|
This class lets you build a complete WML document and render it |
|
|
</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/SVGDocumentClass.html">SVGDocumentClass</a></td> |
|
|
<td> |
|
|
This class lets you build a complete SVG document. |
|
|
</td> |
|
|
</tr> |
|
|
</table> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-var-summary"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Variable Summary</span></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">mixed</span> |
|
|
<a href="#$dtd" title="details" class="var-name">$dtd</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$root_name" title="details" class="var-name">$root_name</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_doctype_links" title="details" class="var-name">$_doctype_links</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">string</span> |
|
|
<a href="#$_doctype_source" title="details" class="var-name">$_doctype_source</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_http_content_type" title="details" class="var-name">$_http_content_type</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
|
|
<a href="#$_root_tag" title="details" class="var-name">$_root_tag</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">boolean</span> |
|
|
<a href="#$_show_char_encoding" title="details" class="var-name">$_show_char_encoding</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_show_http_header" title="details" class="var-name">$_show_http_header</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_xml_obj" title="details" class="var-name">$_xml_obj</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">object</span> |
|
|
<a href="#$_xml_stylesheet_container" title="details" class="var-name">$_xml_stylesheet_container</a> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-method-summary"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Method Summary</span></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="#XMLDocumentClass" title="details" class="method-name">XMLDocumentClass</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$root_name</span>, [<span class="var-type">string</span> <span class="var-name">$dtd</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$root_attributes</span> = <span class="var-default">array()</span>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#add" title="details" class="method-name">add</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#add_reference" title="details" class="method-name">add_reference</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#add_xml_stylesheet_link" title="details" class="method-name">add_xml_stylesheet_link</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$href</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#dump_http_header" title="details" class="method-name">dump_http_header</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_doctype_source" title="details" class="method-name">get_doctype_source</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_encoding" title="details" class="method-name">get_encoding</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_http_content_type" title="details" class="method-name">get_http_content_type</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">array</span> |
|
|
<a href="#get_root_attributes" title="details" class="method-name">get_root_attributes</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#get_root_name" title="details" class="method-name">get_root_name</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#push" title="details" class="method-name">push</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#push_reference" title="details" class="method-name">push_reference</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">string</span> |
|
|
<a href="#render" title="details" class="method-name">render</a> |
|
|
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">int</span> <span class="var-name">1</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#reset_content" title="details" class="method-name">reset_content</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_doctype_link" title="details" class="method-name">set_doctype_link</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_doctype_source" title="details" class="method-name">set_doctype_source</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$source</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_encoding" title="details" class="method-name">set_encoding</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$charset</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_http_content_type" title="details" class="method-name">set_http_content_type</a> |
|
|
([<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/xml"</span>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_root_attribute" title="details" class="method-name">set_root_attribute</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_root_attributes" title="details" class="method-name">set_root_attributes</a> |
|
|
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_root_name" title="details" class="method-name">set_root_name</a> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$root_name</span>, <span class="var-type">string</span> <span class="var-name">$doc_name</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#show_character_encoding" title="details" class="method-name">show_character_encoding</a> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#show_http_header" title="details" class="method-name">show_http_header</a> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#_build_doctype" title="details" class="method-name">_build_doctype</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#_build_root_tag" title="details" class="method-name">_build_root_tag</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#_build_xml_stylesheet_container" title="details" class="method-name">_build_xml_stylesheet_container</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></span> |
|
|
<a href="#_create_xml_obj" title="details" class="method-name">_create_xml_obj</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-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$dtd" id="$dtd"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$dtd</span> |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">69</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Holds the url of dtd</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$root_name" id="$root_name"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$root_name</span> |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">76</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Holds the name of the root xml</p> |
|
|
<p class="description"><p>element as well as the DOCTYPE document_element attribute</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_doctype_links" id="$_doctype_links"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_doctype_links</span> |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">105</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This contains the doctype links</p> |
|
|
<p class="description"><p>attributes. There can be a maximum of 2 according to the XML spec</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_doctype_source" id="$_doctype_source"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$_doctype_source</span> |
|
|
= <span class="var-default"> "SYSTEM"</span> (line <span class="line-number">98</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">the DOCTYPE source attribute</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_http_content_type" id="$_http_content_type"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_http_content_type</span> |
|
|
= <span class="var-default"> "application/xml"</span> (line <span class="line-number">111</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The http content-type</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_root_tag" id="$_root_tag"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
|
|
<span class="var-name">$_root_tag</span> |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">83</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The root xml tag for all data</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">var:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_show_char_encoding" id="$_show_char_encoding"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$_show_char_encoding</span> |
|
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">64</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this is a hack to show the character encoding or not.</p> |
|
|
<p class="description"><p>DEFAULT: on</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_show_http_header" id="$_show_http_header"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_show_http_header</span> |
|
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">55</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This flag tells if we should output the header content type.</p> |
|
|
<p class="description"><p>this is usefull for folks using this class for output not destined for a browser.</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_xml_obj" id="$_xml_obj"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_xml_obj</span> |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">37</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">holds the xml tag object that</p> |
|
|
<p class="description"><p>all content will be wrapped in</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_xml_stylesheet_container" id="$_xml_stylesheet_container"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">object</span> |
|
|
<span class="var-name">$_xml_stylesheet_container</span> |
|
|
= <span class="var-default"> NULL</span> (line <span class="line-number">119</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The container for all the xml-stylesheet tags</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<h4>Inherited Variables</h4> |
|
|
<A NAME='inherited_vars'><!-- --></A> |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
|
|
<blockquote> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</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-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="methodXMLDocumentClass" id="XMLDocumentClass"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">Constructor XMLDocumentClass</span> (line <span class="line-number">130</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The constructor</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
XMLDocumentClass |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$root_name</span>, [<span class="var-type">string</span> <span class="var-name">$dtd</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$root_attributes</span> = <span class="var-default">array()</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$root_name</span><span class="var-description">: <p>- the root xml tag's name</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$dtd</span><span class="var-description">: <p>- the link path to the DTD (if any)</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$root_attributes</span><span class="var-description">: <p>- the root tag's attributes</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodadd" id="add"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">add</span> (line <span class="line-number">197</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p> |
|
|
<p class="description"><p>push content onto content stack adds content to tag as a FIFO. You can have n number of parameters. each one will get added in succession to the content.</p></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"> |
|
|
add |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$content</span><span class="var-description">: <p>- either string, or tag object.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt> |
|
|
<dd>add content onto content stack</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodadd_reference" id="add_reference"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">add_reference</span> (line <span class="line-number">239</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p> |
|
|
<p class="description"><p>push content onto content stack adds content to tag as a FIFO You can only add 1 element at a time, and it will be added as a reference. So you can't do push_reference("something");, since "something" is a static.</p></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"> |
|
|
add_reference |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$content</span><span class="var-description">: <p>- either string, or tag object. the tag object gets stored as a reference to the original, so you can push it, then modify it later.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></dt> |
|
|
<dd>Add content onto content stack so you can change the item later.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodadd_xml_stylesheet_link" id="add_xml_stylesheet_link"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">add_xml_stylesheet_link</span> (line <span class="line-number">269</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to add a new xml-stylesheet tag to the top portion of the document.</p> |
|
|
<p class="description"><p>This will automatically get added after the xml tag and before the <!DOCTYPE > tag</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
add_xml_stylesheet_link |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$href</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$href</span><span class="var-description">: <p>- the href for the stylesheet link</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methoddump_http_header" id="dump_http_header"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">dump_http_header</span> (line <span class="line-number">447</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to output the http header for this document.</p> |
|
|
<p class="description"><p>It makes a call to php's Header() to set the Content-type</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
dump_http_header |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_doctype_source" id="get_doctype_source"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_doctype_source</span> (line <span class="line-number">483</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the current DOCTYPE tag's source attribute</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_doctype_source |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_encoding" id="get_encoding"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_encoding</span> (line <span class="line-number">333</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function gets the current encoding type</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- the current encoding type for the xml</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_encoding |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_http_content_type" id="get_http_content_type"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_http_content_type</span> (line <span class="line-number">436</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the current value of the http header content type</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_http_content_type |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_root_attributes" id="get_root_attributes"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_root_attributes</span> (line <span class="line-number">383</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to get the root xml tag's attributes</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">array</span> |
|
|
<span class="method-name"> |
|
|
get_root_attributes |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodget_root_name" id="get_root_name"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_root_name</span> (line <span class="line-number">353</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function gets the document name</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- the current document name for the xml</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
get_root_name |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodpush" id="push"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">push</span> (line <span class="line-number">216</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Same as add().</p> |
|
|
<p class="description"><p>NOTE: only exists for 1.1.x compatibility</p></p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">access:</span> public</li> |
|
|
<li><span class="field">deprecated:</span> </li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
push |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$content</span><span class="var-description">: <p>- either string, or tag object.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt> |
|
|
<dd>Same as add().</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodpush_reference" id="push_reference"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">push_reference</span> (line <span class="line-number">255</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Same as add_reference NOTE : only exists for compatibility with 1.1.x</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"> |
|
|
push_reference |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">&$content</span><span class="var-description">: <p>- a reference to some variable.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></dt> |
|
|
<dd>Same as add_reference NOTE : only exists for compatibility with 1.1.x</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodrender" id="render"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">render</span> (line <span class="line-number">152</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">function that will render the XML Document.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>the raw html output.</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">string</span> |
|
|
<span class="method-name"> |
|
|
render |
|
|
</span> |
|
|
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">int</span> <span class="var-name">1</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">1</span><span class="var-description">: <p>- the output debug flag to maintain compatibility w/ the API.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for the container.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
|
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodreset_content" id="reset_content"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">reset_content</span> (line <span class="line-number">291</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p> |
|
|
<p class="description"><p>destroy existing content and start with new content.</p></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"> |
|
|
reset_content |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$content</span><span class="var-description">: <p>can be tag object, or raw (string).</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></dt> |
|
|
<dd>destroy existing content and start with new content.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodset_doctype_link" id="set_doctype_link"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_doctype_link</span> (line <span class="line-number">392</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This method is used to set the link attributes</p> |
|
|
<p class="description"><p>for the DOCTYPE tag</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_doctype_link |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_doctype_source" id="set_doctype_source"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_doctype_source</span> (line <span class="line-number">464</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this function is used to change the DOCTYPE tag's source attribute. By default it is set to SYSTEM.</p> |
|
|
<p class="description"><p>(ie <!DOCTYPE html SYSTEM > ) ^^^^^^</p><p>NOTE: only 2 valid values 'SYSTEM', 'PUBLIC'</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_doctype_source |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$source</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$source</span><span class="var-description">: <p>- the new source attribute</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_encoding" id="set_encoding"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_encoding</span> (line <span class="line-number">323</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">set the character set</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_encoding |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$charset</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$charset</span><span class="var-description">: <p>- the charset for the meta tag</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_http_content_type" id="set_http_content_type"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_http_content_type</span> (line <span class="line-number">426</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the http header content-type for output to browsers</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_http_content_type |
|
|
</span> |
|
|
([<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/xml"</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$type</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_root_attribute" id="set_root_attribute"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_root_attribute</span> (line <span class="line-number">373</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This sets 1 root tag attribute value pair</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_root_attribute |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$name</span><span class="var-description">: <p>- the attribute name</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$value</span><span class="var-description">: <p>- the attribute value</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_root_attributes" id="set_root_attributes"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_root_attributes</span> (line <span class="line-number">363</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the root xml tag's attributes</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_root_attributes |
|
|
</span> |
|
|
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$attributes</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_root_name" id="set_root_name"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_root_name</span> (line <span class="line-number">343</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Set the document name and the root tag's name.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_root_name |
|
|
</span> |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$root_name</span>, <span class="var-type">string</span> <span class="var-name">$doc_name</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$doc_name</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodshow_character_encoding" id="show_character_encoding"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">show_character_encoding</span> (line <span class="line-number">405</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">method to update the flag that lets us know to show/render the character encoding string in the xml tag or not</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
show_character_encoding |
|
|
</span> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$flag</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodshow_http_header" id="show_http_header"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">show_http_header</span> (line <span class="line-number">416</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this function is used to set the flag that tells this class to automatically output the content type in the http header</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
show_http_header |
|
|
</span> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$flag</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_doctype" id="_build_doctype"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_doctype</span> (line <span class="line-number">492</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This method builds the DOCTYPE tag for the document</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
_build_doctype |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_root_tag" id="_build_root_tag"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_root_tag</span> (line <span class="line-number">314</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the root xml</p> |
|
|
<p class="description"><p>tag that will contain all of the Document's xml tags</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
_build_root_tag |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_xml_stylesheet_container" id="_build_xml_stylesheet_container"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_xml_stylesheet_container</span> (line <span class="line-number">277</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the _xml_stylesheet_container</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
_build_xml_stylesheet_container |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_create_xml_obj" id="_create_xml_obj"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_create_xml_obj</span> (line <span class="line-number">304</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the local</p> |
|
|
<p class="description"><p>xml container object that holds all xml tags that are pushed into this class</p></p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></span> |
|
|
<span class="method-name"> |
|
|
_create_xml_obj |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<h4>Inherited Methods</h4> |
|
|
<a name='inherited_methods'><!-- --></a> |
|
|
<!-- =========== Summary =========== --> |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
|
|
<blockquote> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
|
|
</blockquote> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<p class="notes" id="credit"> |
|
|
Documention generated on Thu, 31 Jul 2003 18:34:04 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
|
|
</p> |
|
|
</div></body> |
|
|
</html> |
|
38 |
|
--XMLDocumentClass</pre> |
39 |
|
|
40 |
|
</div> |
41 |
|
</div> |
42 |
|
|
43 |
|
<a name="sec-descendents"></a> |
44 |
|
<div class="info-box"> |
45 |
|
<div class="info-box-title">Direct descendents</div> |
46 |
|
<div class="nav-bar"> |
47 |
|
<a href="#sec-description">Description</a> | |
48 |
|
<span class="disabled">Descendents</span> |
49 |
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
50 |
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
51 |
|
|
52 |
|
</div> |
53 |
|
<div class="info-box-body"> |
54 |
|
<table cellpadding="2" cellspacing="0" class="class-table"> |
55 |
|
<tr> |
56 |
|
<th class="class-table-header">Class</th> |
57 |
|
<th class="class-table-header">Description</th> |
58 |
|
</tr> |
59 |
|
<tr> |
60 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/SVGDocumentClass.html">SVGDocumentClass</a></td> |
61 |
|
<td> |
62 |
|
This class lets you build a complete SVG document. |
63 |
|
</td> |
64 |
|
</tr> |
65 |
|
<tr> |
66 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/WMLDocumentClass.html">WMLDocumentClass</a></td> |
67 |
|
<td> |
68 |
|
This class lets you build a complete WML document and render it |
69 |
|
</td> |
70 |
|
</tr> |
71 |
|
</table> |
72 |
|
</div> |
73 |
|
</div> |
74 |
|
|
75 |
|
|
76 |
|
<a name="sec-var-summary"></a> |
77 |
|
<div class="info-box"> |
78 |
|
<div class="info-box-title">Variable Summary</span></div> |
79 |
|
<div class="nav-bar"> |
80 |
|
<a href="#sec-description">Description</a> | |
81 |
|
<a href="#sec-descendents">Descendents</a> | |
82 |
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
83 |
|
| |
84 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
85 |
|
|
86 |
|
</div> |
87 |
|
<div class="info-box-body"> |
88 |
|
<div class="var-summary"> |
89 |
|
<div class="var-title"> |
90 |
|
<span class="var-type">mixed</span> |
91 |
|
<a href="#$dtd" title="details" class="var-name">$dtd</a> |
92 |
|
</div> |
93 |
|
<div class="var-title"> |
94 |
|
<span class="var-type">mixed</span> |
95 |
|
<a href="#$root_name" title="details" class="var-name">$root_name</a> |
96 |
|
</div> |
97 |
|
<div class="var-title"> |
98 |
|
<span class="var-type">mixed</span> |
99 |
|
<a href="#$_doctype_links" title="details" class="var-name">$_doctype_links</a> |
100 |
|
</div> |
101 |
|
<div class="var-title"> |
102 |
|
<span class="var-type">string</span> |
103 |
|
<a href="#$_doctype_source" title="details" class="var-name">$_doctype_source</a> |
104 |
|
</div> |
105 |
|
<div class="var-title"> |
106 |
|
<span class="var-type">mixed</span> |
107 |
|
<a href="#$_http_content_type" title="details" class="var-name">$_http_content_type</a> |
108 |
|
</div> |
109 |
|
<div class="var-title"> |
110 |
|
<span class="var-type"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
111 |
|
<a href="#$_root_tag" title="details" class="var-name">$_root_tag</a> |
112 |
|
</div> |
113 |
|
<div class="var-title"> |
114 |
|
<span class="var-type">boolean</span> |
115 |
|
<a href="#$_show_char_encoding" title="details" class="var-name">$_show_char_encoding</a> |
116 |
|
</div> |
117 |
|
<div class="var-title"> |
118 |
|
<span class="var-type">mixed</span> |
119 |
|
<a href="#$_show_http_header" title="details" class="var-name">$_show_http_header</a> |
120 |
|
</div> |
121 |
|
<div class="var-title"> |
122 |
|
<span class="var-type">mixed</span> |
123 |
|
<a href="#$_xml_obj" title="details" class="var-name">$_xml_obj</a> |
124 |
|
</div> |
125 |
|
<div class="var-title"> |
126 |
|
<span class="var-type">object</span> |
127 |
|
<a href="#$_xml_stylesheet_container" title="details" class="var-name">$_xml_stylesheet_container</a> |
128 |
|
</div> |
129 |
|
</div> |
130 |
|
</div> |
131 |
|
</div> |
132 |
|
|
133 |
|
<a name="sec-method-summary"></a> |
134 |
|
<div class="info-box"> |
135 |
|
<div class="info-box-title">Method Summary</span></div> |
136 |
|
<div class="nav-bar"> |
137 |
|
<a href="#sec-description">Description</a> | |
138 |
|
<a href="#sec-descendents">Descendents</a> | |
139 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
140 |
|
|
141 |
|
| |
142 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
143 |
|
</div> |
144 |
|
<div class="info-box-body"> |
145 |
|
<div class="method-summary"> |
146 |
|
|
147 |
|
<div class="method-definition"> |
148 |
|
<span class="method-result">XMLDocumentClass</span> |
149 |
|
<a href="#XMLDocumentClass" title="details" class="method-name">XMLDocumentClass</a> |
150 |
|
(<span class="var-type">string</span> <span class="var-name">$root_name</span>, [<span class="var-type">string</span> <span class="var-name">$dtd</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$root_attributes</span> = <span class="var-default">array()</span>]) |
151 |
|
</div> |
152 |
|
|
153 |
|
<div class="method-definition"> |
154 |
|
<span class="method-result">void</span> |
155 |
|
<a href="#add" title="details" class="method-name">add</a> |
156 |
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
157 |
|
</div> |
158 |
|
|
159 |
|
<div class="method-definition"> |
160 |
|
<span class="method-result">void</span> |
161 |
|
<a href="#add_reference" title="details" class="method-name">add_reference</a> |
162 |
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
163 |
|
</div> |
164 |
|
|
165 |
|
<div class="method-definition"> |
166 |
|
<span class="method-result">void</span> |
167 |
|
<a href="#add_xml_stylesheet_link" title="details" class="method-name">add_xml_stylesheet_link</a> |
168 |
|
(<span class="var-type">string</span> <span class="var-name">$href</span>) |
169 |
|
</div> |
170 |
|
|
171 |
|
<div class="method-definition"> |
172 |
|
<span class="method-result">void</span> |
173 |
|
<a href="#dump_http_header" title="details" class="method-name">dump_http_header</a> |
174 |
|
() |
175 |
|
</div> |
176 |
|
|
177 |
|
<div class="method-definition"> |
178 |
|
<span class="method-result">string</span> |
179 |
|
<a href="#get_doctype_source" title="details" class="method-name">get_doctype_source</a> |
180 |
|
() |
181 |
|
</div> |
182 |
|
|
183 |
|
<div class="method-definition"> |
184 |
|
<span class="method-result">string</span> |
185 |
|
<a href="#get_encoding" title="details" class="method-name">get_encoding</a> |
186 |
|
() |
187 |
|
</div> |
188 |
|
|
189 |
|
<div class="method-definition"> |
190 |
|
<span class="method-result">string</span> |
191 |
|
<a href="#get_http_content_type" title="details" class="method-name">get_http_content_type</a> |
192 |
|
() |
193 |
|
</div> |
194 |
|
|
195 |
|
<div class="method-definition"> |
196 |
|
<span class="method-result">array</span> |
197 |
|
<a href="#get_root_attributes" title="details" class="method-name">get_root_attributes</a> |
198 |
|
() |
199 |
|
</div> |
200 |
|
|
201 |
|
<div class="method-definition"> |
202 |
|
<span class="method-result">string</span> |
203 |
|
<a href="#get_root_name" title="details" class="method-name">get_root_name</a> |
204 |
|
() |
205 |
|
</div> |
206 |
|
|
207 |
|
<div class="method-definition"> |
208 |
|
<span class="method-result">void</span> |
209 |
|
<a href="#push" title="details" class="method-name">push</a> |
210 |
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
211 |
|
</div> |
212 |
|
|
213 |
|
<div class="method-definition"> |
214 |
|
<span class="method-result">void</span> |
215 |
|
<a href="#push_reference" title="details" class="method-name">push_reference</a> |
216 |
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
217 |
|
</div> |
218 |
|
|
219 |
|
<div class="method-definition"> |
220 |
|
<span class="method-result">string</span> |
221 |
|
<a href="#render" title="details" class="method-name">render</a> |
222 |
|
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">int</span> <span class="var-name">1</span>) |
223 |
|
</div> |
224 |
|
|
225 |
|
<div class="method-definition"> |
226 |
|
<span class="method-result">void</span> |
227 |
|
<a href="#reset_content" title="details" class="method-name">reset_content</a> |
228 |
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
229 |
|
</div> |
230 |
|
|
231 |
|
<div class="method-definition"> |
232 |
|
<span class="method-result">void</span> |
233 |
|
<a href="#set_doctype_link" title="details" class="method-name">set_doctype_link</a> |
234 |
|
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
235 |
|
</div> |
236 |
|
|
237 |
|
<div class="method-definition"> |
238 |
|
<span class="method-result">void</span> |
239 |
|
<a href="#set_doctype_source" title="details" class="method-name">set_doctype_source</a> |
240 |
|
(<span class="var-type">string</span> <span class="var-name">$source</span>) |
241 |
|
</div> |
242 |
|
|
243 |
|
<div class="method-definition"> |
244 |
|
<span class="method-result">void</span> |
245 |
|
<a href="#set_encoding" title="details" class="method-name">set_encoding</a> |
246 |
|
(<span class="var-type">string</span> <span class="var-name">$charset</span>) |
247 |
|
</div> |
248 |
|
|
249 |
|
<div class="method-definition"> |
250 |
|
<span class="method-result">void</span> |
251 |
|
<a href="#set_http_content_type" title="details" class="method-name">set_http_content_type</a> |
252 |
|
([<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/xml"</span>]) |
253 |
|
</div> |
254 |
|
|
255 |
|
<div class="method-definition"> |
256 |
|
<span class="method-result">void</span> |
257 |
|
<a href="#set_root_attribute" title="details" class="method-name">set_root_attribute</a> |
258 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
259 |
|
</div> |
260 |
|
|
261 |
|
<div class="method-definition"> |
262 |
|
<span class="method-result">void</span> |
263 |
|
<a href="#set_root_attributes" title="details" class="method-name">set_root_attributes</a> |
264 |
|
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
265 |
|
</div> |
266 |
|
|
267 |
|
<div class="method-definition"> |
268 |
|
<span class="method-result">void</span> |
269 |
|
<a href="#set_root_name" title="details" class="method-name">set_root_name</a> |
270 |
|
(<span class="var-type">mixed</span> <span class="var-name">$root_name</span>, <span class="var-type">string</span> <span class="var-name">$doc_name</span>) |
271 |
|
</div> |
272 |
|
|
273 |
|
<div class="method-definition"> |
274 |
|
<span class="method-result">void</span> |
275 |
|
<a href="#show_character_encoding" title="details" class="method-name">show_character_encoding</a> |
276 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
277 |
|
</div> |
278 |
|
|
279 |
|
<div class="method-definition"> |
280 |
|
<span class="method-result">void</span> |
281 |
|
<a href="#show_http_header" title="details" class="method-name">show_http_header</a> |
282 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
283 |
|
</div> |
284 |
|
|
285 |
|
<div class="method-definition"> |
286 |
|
<span class="method-result">void</span> |
287 |
|
<a href="#_build_doctype" title="details" class="method-name">_build_doctype</a> |
288 |
|
() |
289 |
|
</div> |
290 |
|
|
291 |
|
<div class="method-definition"> |
292 |
|
<span class="method-result">void</span> |
293 |
|
<a href="#_build_root_tag" title="details" class="method-name">_build_root_tag</a> |
294 |
|
() |
295 |
|
</div> |
296 |
|
|
297 |
|
<div class="method-definition"> |
298 |
|
<span class="method-result">void</span> |
299 |
|
<a href="#_build_xml_stylesheet_container" title="details" class="method-name">_build_xml_stylesheet_container</a> |
300 |
|
() |
301 |
|
</div> |
302 |
|
|
303 |
|
<div class="method-definition"> |
304 |
|
<span class="method-result"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></span> |
305 |
|
<a href="#_create_xml_obj" title="details" class="method-name">_create_xml_obj</a> |
306 |
|
() |
307 |
|
</div> |
308 |
|
</div> |
309 |
|
</div> |
310 |
|
</div> |
311 |
|
|
312 |
|
<a name="sec-vars"></a> |
313 |
|
<div class="info-box"> |
314 |
|
<div class="info-box-title">Variables</div> |
315 |
|
<div class="nav-bar"> |
316 |
|
<a href="#sec-description">Description</a> | |
317 |
|
<a href="#sec-descendents">Descendents</a> | |
318 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
319 |
|
|
320 |
|
|
321 |
|
| |
322 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
323 |
|
|
324 |
|
</div> |
325 |
|
<div class="info-box-body"> |
326 |
|
<a name="var$dtd" id="$dtd"><!-- --></A> |
327 |
|
<div class="evenrow"> |
328 |
|
|
329 |
|
<div class="var-header"> |
330 |
|
<span class="var-title"> |
331 |
|
<span class="var-type">mixed</span> |
332 |
|
<span class="var-name">$dtd</span> |
333 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">69</span>) |
334 |
|
</span> |
335 |
|
</div> |
336 |
|
|
337 |
|
<!-- ========== Info from phpDoc block ========= --> |
338 |
|
<p class="short-description">Holds the url of dtd</p> |
339 |
|
|
340 |
|
|
341 |
|
|
342 |
|
|
343 |
|
|
344 |
|
</div> |
345 |
|
<a name="var$root_name" id="$root_name"><!-- --></A> |
346 |
|
<div class="oddrow"> |
347 |
|
|
348 |
|
<div class="var-header"> |
349 |
|
<span class="var-title"> |
350 |
|
<span class="var-type">mixed</span> |
351 |
|
<span class="var-name">$root_name</span> |
352 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">76</span>) |
353 |
|
</span> |
354 |
|
</div> |
355 |
|
|
356 |
|
<!-- ========== Info from phpDoc block ========= --> |
357 |
|
<p class="short-description">Holds the name of the root xml</p> |
358 |
|
<p class="description"><p>element as well as the DOCTYPE document_element attribute</p></p> |
359 |
|
|
360 |
|
|
361 |
|
|
362 |
|
|
363 |
|
|
364 |
|
</div> |
365 |
|
<a name="var$_doctype_links" id="$_doctype_links"><!-- --></A> |
366 |
|
<div class="evenrow"> |
367 |
|
|
368 |
|
<div class="var-header"> |
369 |
|
<span class="var-title"> |
370 |
|
<span class="var-type">mixed</span> |
371 |
|
<span class="var-name">$_doctype_links</span> |
372 |
|
= <span class="var-default">array()</span> (line <span class="line-number">105</span>) |
373 |
|
</span> |
374 |
|
</div> |
375 |
|
|
376 |
|
<!-- ========== Info from phpDoc block ========= --> |
377 |
|
<p class="short-description">This contains the doctype links</p> |
378 |
|
<p class="description"><p>attributes. There can be a maximum of 2 according to the XML spec</p></p> |
379 |
|
|
380 |
|
|
381 |
|
|
382 |
|
|
383 |
|
|
384 |
|
</div> |
385 |
|
<a name="var$_doctype_source" id="$_doctype_source"><!-- --></A> |
386 |
|
<div class="oddrow"> |
387 |
|
|
388 |
|
<div class="var-header"> |
389 |
|
<span class="var-title"> |
390 |
|
<span class="var-type">string</span> |
391 |
|
<span class="var-name">$_doctype_source</span> |
392 |
|
= <span class="var-default"> "SYSTEM"</span> (line <span class="line-number">98</span>) |
393 |
|
</span> |
394 |
|
</div> |
395 |
|
|
396 |
|
<!-- ========== Info from phpDoc block ========= --> |
397 |
|
<p class="short-description">the DOCTYPE source attribute</p> |
398 |
|
|
399 |
|
|
400 |
|
|
401 |
|
|
402 |
|
|
403 |
|
</div> |
404 |
|
<a name="var$_http_content_type" id="$_http_content_type"><!-- --></A> |
405 |
|
<div class="evenrow"> |
406 |
|
|
407 |
|
<div class="var-header"> |
408 |
|
<span class="var-title"> |
409 |
|
<span class="var-type">mixed</span> |
410 |
|
<span class="var-name">$_http_content_type</span> |
411 |
|
= <span class="var-default"> "application/xml"</span> (line <span class="line-number">111</span>) |
412 |
|
</span> |
413 |
|
</div> |
414 |
|
|
415 |
|
<!-- ========== Info from phpDoc block ========= --> |
416 |
|
<p class="short-description">The http content-type</p> |
417 |
|
|
418 |
|
|
419 |
|
|
420 |
|
|
421 |
|
|
422 |
|
</div> |
423 |
|
<a name="var$_root_tag" id="$_root_tag"><!-- --></A> |
424 |
|
<div class="oddrow"> |
425 |
|
|
426 |
|
<div class="var-header"> |
427 |
|
<span class="var-title"> |
428 |
|
<span class="var-type"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
429 |
|
<span class="var-name">$_root_tag</span> |
430 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">83</span>) |
431 |
|
</span> |
432 |
|
</div> |
433 |
|
|
434 |
|
<!-- ========== Info from phpDoc block ========= --> |
435 |
|
<p class="short-description">The root xml tag for all data</p> |
436 |
|
<ul class="tags"> |
437 |
|
<li><span class="field">var:</span> object</li> |
438 |
|
</ul> |
439 |
|
|
440 |
|
|
441 |
|
|
442 |
|
|
443 |
|
|
444 |
|
</div> |
445 |
|
<a name="var$_show_char_encoding" id="$_show_char_encoding"><!-- --></A> |
446 |
|
<div class="evenrow"> |
447 |
|
|
448 |
|
<div class="var-header"> |
449 |
|
<span class="var-title"> |
450 |
|
<span class="var-type">boolean</span> |
451 |
|
<span class="var-name">$_show_char_encoding</span> |
452 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">64</span>) |
453 |
|
</span> |
454 |
|
</div> |
455 |
|
|
456 |
|
<!-- ========== Info from phpDoc block ========= --> |
457 |
|
<p class="short-description">this is a hack to show the character encoding or not.</p> |
458 |
|
<p class="description"><p>DEFAULT: on</p></p> |
459 |
|
|
460 |
|
|
461 |
|
|
462 |
|
|
463 |
|
|
464 |
|
</div> |
465 |
|
<a name="var$_show_http_header" id="$_show_http_header"><!-- --></A> |
466 |
|
<div class="oddrow"> |
467 |
|
|
468 |
|
<div class="var-header"> |
469 |
|
<span class="var-title"> |
470 |
|
<span class="var-type">mixed</span> |
471 |
|
<span class="var-name">$_show_http_header</span> |
472 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">55</span>) |
473 |
|
</span> |
474 |
|
</div> |
475 |
|
|
476 |
|
<!-- ========== Info from phpDoc block ========= --> |
477 |
|
<p class="short-description">This flag tells if we should output the header content type.</p> |
478 |
|
<p class="description"><p>this is usefull for folks using this class for output not destined for a browser.</p></p> |
479 |
|
|
480 |
|
|
481 |
|
|
482 |
|
|
483 |
|
|
484 |
|
</div> |
485 |
|
<a name="var$_xml_obj" id="$_xml_obj"><!-- --></A> |
486 |
|
<div class="evenrow"> |
487 |
|
|
488 |
|
<div class="var-header"> |
489 |
|
<span class="var-title"> |
490 |
|
<span class="var-type">mixed</span> |
491 |
|
<span class="var-name">$_xml_obj</span> |
492 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">37</span>) |
493 |
|
</span> |
494 |
|
</div> |
495 |
|
|
496 |
|
<!-- ========== Info from phpDoc block ========= --> |
497 |
|
<p class="short-description">holds the xml tag object that</p> |
498 |
|
<p class="description"><p>all content will be wrapped in</p></p> |
499 |
|
|
500 |
|
|
501 |
|
|
502 |
|
|
503 |
|
|
504 |
|
</div> |
505 |
|
<a name="var$_xml_stylesheet_container" id="$_xml_stylesheet_container"><!-- --></A> |
506 |
|
<div class="oddrow"> |
507 |
|
|
508 |
|
<div class="var-header"> |
509 |
|
<span class="var-title"> |
510 |
|
<span class="var-type">object</span> |
511 |
|
<span class="var-name">$_xml_stylesheet_container</span> |
512 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">119</span>) |
513 |
|
</span> |
514 |
|
</div> |
515 |
|
|
516 |
|
<!-- ========== Info from phpDoc block ========= --> |
517 |
|
<p class="short-description">The container for all the xml-stylesheet tags</p> |
518 |
|
|
519 |
|
|
520 |
|
|
521 |
|
|
522 |
|
|
523 |
|
</div> |
524 |
|
|
525 |
|
</div> |
526 |
|
</div> |
527 |
|
|
528 |
|
<a name="sec-methods"></a> |
529 |
|
<div class="info-box"> |
530 |
|
<div class="info-box-title">Methods</div> |
531 |
|
<div class="nav-bar"> |
532 |
|
<a href="#sec-description">Description</a> | |
533 |
|
<a href="#sec-descendents">Descendents</a> | |
534 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
535 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
536 |
|
|
537 |
|
</div> |
538 |
|
<div class="info-box-body"> |
539 |
|
<A NAME='method_detail'></A> |
540 |
|
<a name="methodXMLDocumentClass" id="XMLDocumentClass"><!-- --></a> |
541 |
|
<div class="evenrow"> |
542 |
|
|
543 |
|
<div class="method-header"> |
544 |
|
<span class="method-title">Constructor XMLDocumentClass</span> (line <span class="line-number">130</span>) |
545 |
|
</div> |
546 |
|
|
547 |
|
<!-- ========== Info from phpDoc block ========= --> |
548 |
|
<p class="short-description">The constructor</p> |
549 |
|
|
550 |
|
<div class="method-signature"> |
551 |
|
<span class="method-result">XMLDocumentClass</span> |
552 |
|
<span class="method-name"> |
553 |
|
XMLDocumentClass |
554 |
|
</span> |
555 |
|
(<span class="var-type">string</span> <span class="var-name">$root_name</span>, [<span class="var-type">string</span> <span class="var-name">$dtd</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$root_attributes</span> = <span class="var-default">array()</span>]) |
556 |
|
</div> |
557 |
|
|
558 |
|
<ul class="parameters"> |
559 |
|
<li> |
560 |
|
<span class="var-type">string</span> |
561 |
|
<span class="var-name">$root_name</span><span class="var-description">: - the root xml tag's name</span> </li> |
562 |
|
<li> |
563 |
|
<span class="var-type">string</span> |
564 |
|
<span class="var-name">$dtd</span><span class="var-description">: - the link path to the DTD (if any)</span> </li> |
565 |
|
<li> |
566 |
|
<span class="var-type">array</span> |
567 |
|
<span class="var-name">$root_attributes</span><span class="var-description">: - the root tag's attributes</span> </li> |
568 |
|
</ul> |
569 |
|
|
570 |
|
|
571 |
|
</div> |
572 |
|
<a name="methodadd" id="add"><!-- --></a> |
573 |
|
<div class="oddrow"> |
574 |
|
|
575 |
|
<div class="method-header"> |
576 |
|
<span class="method-title">add</span> (line <span class="line-number">197</span>) |
577 |
|
</div> |
578 |
|
|
579 |
|
<!-- ========== Info from phpDoc block ========= --> |
580 |
|
<p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p> |
581 |
|
<p class="description"><p>push content onto content stack adds content to tag as a FIFO. You can have n number of parameters. each one will get added in succession to the content.</p></p> |
582 |
|
<ul class="tags"> |
583 |
|
<li><span class="field">access:</span> public</li> |
584 |
|
</ul> |
585 |
|
|
586 |
|
<div class="method-signature"> |
587 |
|
<span class="method-result">void</span> |
588 |
|
<span class="method-name"> |
589 |
|
add |
590 |
|
</span> |
591 |
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
592 |
|
</div> |
593 |
|
|
594 |
|
<ul class="parameters"> |
595 |
|
<li> |
596 |
|
<span class="var-type">mixed</span> |
597 |
|
<span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li> |
598 |
|
</ul> |
599 |
|
|
600 |
|
<hr class="separator" /> |
601 |
|
<div class="notes">Redefinition of:</div> |
602 |
|
<dl> |
603 |
|
<dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt> |
604 |
|
<dd>add content onto content stack</dd> |
605 |
|
</dl> |
606 |
|
|
607 |
|
</div> |
608 |
|
<a name="methodadd_reference" id="add_reference"><!-- --></a> |
609 |
|
<div class="evenrow"> |
610 |
|
|
611 |
|
<div class="method-header"> |
612 |
|
<span class="method-title">add_reference</span> (line <span class="line-number">239</span>) |
613 |
|
</div> |
614 |
|
|
615 |
|
<!-- ========== Info from phpDoc block ========= --> |
616 |
|
<p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p> |
617 |
|
<p class="description"><p>push content onto content stack adds content to tag as a FIFO You can only add 1 element at a time, and it will be added as a reference. So you can't do push_reference("something");, since "something" is a static.</p></p> |
618 |
|
<ul class="tags"> |
619 |
|
<li><span class="field">access:</span> public</li> |
620 |
|
</ul> |
621 |
|
|
622 |
|
<div class="method-signature"> |
623 |
|
<span class="method-result">void</span> |
624 |
|
<span class="method-name"> |
625 |
|
add_reference |
626 |
|
</span> |
627 |
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
628 |
|
</div> |
629 |
|
|
630 |
|
<ul class="parameters"> |
631 |
|
<li> |
632 |
|
<span class="var-type">mixed</span> |
633 |
|
<span class="var-name">$content</span><span class="var-description">: - either string, or tag object. the tag object gets stored as a reference to the original, so you can push it, then modify it later.</span> </li> |
634 |
|
</ul> |
635 |
|
|
636 |
|
<hr class="separator" /> |
637 |
|
<div class="notes">Redefinition of:</div> |
638 |
|
<dl> |
639 |
|
<dt><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></dt> |
640 |
|
<dd>Add content onto content stack so you can change the item later.</dd> |
641 |
|
</dl> |
642 |
|
|
643 |
|
</div> |
644 |
|
<a name="methodadd_xml_stylesheet_link" id="add_xml_stylesheet_link"><!-- --></a> |
645 |
|
<div class="oddrow"> |
646 |
|
|
647 |
|
<div class="method-header"> |
648 |
|
<span class="method-title">add_xml_stylesheet_link</span> (line <span class="line-number">269</span>) |
649 |
|
</div> |
650 |
|
|
651 |
|
<!-- ========== Info from phpDoc block ========= --> |
652 |
|
<p class="short-description">This function is used to add a new xml-stylesheet tag to the top portion of the document.</p> |
653 |
|
<p class="description"><p>This will automatically get added after the xml tag and before the <!DOCTYPE > tag</p></p> |
654 |
|
|
655 |
|
<div class="method-signature"> |
656 |
|
<span class="method-result">void</span> |
657 |
|
<span class="method-name"> |
658 |
|
add_xml_stylesheet_link |
659 |
|
</span> |
660 |
|
(<span class="var-type">string</span> <span class="var-name">$href</span>) |
661 |
|
</div> |
662 |
|
|
663 |
|
<ul class="parameters"> |
664 |
|
<li> |
665 |
|
<span class="var-type">string</span> |
666 |
|
<span class="var-name">$href</span><span class="var-description">: - the href for the stylesheet link</span> </li> |
667 |
|
</ul> |
668 |
|
|
669 |
|
|
670 |
|
</div> |
671 |
|
<a name="methoddump_http_header" id="dump_http_header"><!-- --></a> |
672 |
|
<div class="evenrow"> |
673 |
|
|
674 |
|
<div class="method-header"> |
675 |
|
<span class="method-title">dump_http_header</span> (line <span class="line-number">447</span>) |
676 |
|
</div> |
677 |
|
|
678 |
|
<!-- ========== Info from phpDoc block ========= --> |
679 |
|
<p class="short-description">This function is used to output the http header for this document.</p> |
680 |
|
<p class="description"><p>It makes a call to php's Header() to set the Content-type</p></p> |
681 |
|
|
682 |
|
<div class="method-signature"> |
683 |
|
<span class="method-result">void</span> |
684 |
|
<span class="method-name"> |
685 |
|
dump_http_header |
686 |
|
</span> |
687 |
|
() |
688 |
|
</div> |
689 |
|
|
690 |
|
|
691 |
|
|
692 |
|
</div> |
693 |
|
<a name="methodget_doctype_source" id="get_doctype_source"><!-- --></a> |
694 |
|
<div class="oddrow"> |
695 |
|
|
696 |
|
<div class="method-header"> |
697 |
|
<span class="method-title">get_doctype_source</span> (line <span class="line-number">483</span>) |
698 |
|
</div> |
699 |
|
|
700 |
|
<!-- ========== Info from phpDoc block ========= --> |
701 |
|
<p class="short-description">This function returns the current DOCTYPE tag's source attribute</p> |
702 |
|
|
703 |
|
<div class="method-signature"> |
704 |
|
<span class="method-result">string</span> |
705 |
|
<span class="method-name"> |
706 |
|
get_doctype_source |
707 |
|
</span> |
708 |
|
() |
709 |
|
</div> |
710 |
|
|
711 |
|
|
712 |
|
|
713 |
|
</div> |
714 |
|
<a name="methodget_encoding" id="get_encoding"><!-- --></a> |
715 |
|
<div class="evenrow"> |
716 |
|
|
717 |
|
<div class="method-header"> |
718 |
|
<span class="method-title">get_encoding</span> (line <span class="line-number">333</span>) |
719 |
|
</div> |
720 |
|
|
721 |
|
<!-- ========== Info from phpDoc block ========= --> |
722 |
|
<p class="short-description">This function gets the current encoding type</p> |
723 |
|
<ul class="tags"> |
724 |
|
<li><span class="field">return:</span> - the current encoding type for the xml</li> |
725 |
|
</ul> |
726 |
|
|
727 |
|
<div class="method-signature"> |
728 |
|
<span class="method-result">string</span> |
729 |
|
<span class="method-name"> |
730 |
|
get_encoding |
731 |
|
</span> |
732 |
|
() |
733 |
|
</div> |
734 |
|
|
735 |
|
|
736 |
|
|
737 |
|
</div> |
738 |
|
<a name="methodget_http_content_type" id="get_http_content_type"><!-- --></a> |
739 |
|
<div class="oddrow"> |
740 |
|
|
741 |
|
<div class="method-header"> |
742 |
|
<span class="method-title">get_http_content_type</span> (line <span class="line-number">436</span>) |
743 |
|
</div> |
744 |
|
|
745 |
|
<!-- ========== Info from phpDoc block ========= --> |
746 |
|
<p class="short-description">This function returns the current value of the http header content type</p> |
747 |
|
|
748 |
|
<div class="method-signature"> |
749 |
|
<span class="method-result">string</span> |
750 |
|
<span class="method-name"> |
751 |
|
get_http_content_type |
752 |
|
</span> |
753 |
|
() |
754 |
|
</div> |
755 |
|
|
756 |
|
|
757 |
|
|
758 |
|
</div> |
759 |
|
<a name="methodget_root_attributes" id="get_root_attributes"><!-- --></a> |
760 |
|
<div class="evenrow"> |
761 |
|
|
762 |
|
<div class="method-header"> |
763 |
|
<span class="method-title">get_root_attributes</span> (line <span class="line-number">383</span>) |
764 |
|
</div> |
765 |
|
|
766 |
|
<!-- ========== Info from phpDoc block ========= --> |
767 |
|
<p class="short-description">This function is used to get the root xml tag's attributes</p> |
768 |
|
|
769 |
|
<div class="method-signature"> |
770 |
|
<span class="method-result">array</span> |
771 |
|
<span class="method-name"> |
772 |
|
get_root_attributes |
773 |
|
</span> |
774 |
|
() |
775 |
|
</div> |
776 |
|
|
777 |
|
|
778 |
|
|
779 |
|
</div> |
780 |
|
<a name="methodget_root_name" id="get_root_name"><!-- --></a> |
781 |
|
<div class="oddrow"> |
782 |
|
|
783 |
|
<div class="method-header"> |
784 |
|
<span class="method-title">get_root_name</span> (line <span class="line-number">353</span>) |
785 |
|
</div> |
786 |
|
|
787 |
|
<!-- ========== Info from phpDoc block ========= --> |
788 |
|
<p class="short-description">This function gets the document name</p> |
789 |
|
<ul class="tags"> |
790 |
|
<li><span class="field">return:</span> - the current document name for the xml</li> |
791 |
|
</ul> |
792 |
|
|
793 |
|
<div class="method-signature"> |
794 |
|
<span class="method-result">string</span> |
795 |
|
<span class="method-name"> |
796 |
|
get_root_name |
797 |
|
</span> |
798 |
|
() |
799 |
|
</div> |
800 |
|
|
801 |
|
|
802 |
|
|
803 |
|
</div> |
804 |
|
<a name="methodpush" id="push"><!-- --></a> |
805 |
|
<div class="evenrow"> |
806 |
|
|
807 |
|
<div class="method-header"> |
808 |
|
<span class="method-title">push</span> (line <span class="line-number">216</span>) |
809 |
|
</div> |
810 |
|
|
811 |
|
<!-- ========== Info from phpDoc block ========= --> |
812 |
|
<p class="short-description">Same as add().</p> |
813 |
|
<p class="description"><p>NOTE: only exists for 1.1.x compatibility</p></p> |
814 |
|
<ul class="tags"> |
815 |
|
<li><span class="field">access:</span> public</li> |
816 |
|
<li><span class="field">deprecated:</span> </li> |
817 |
|
</ul> |
818 |
|
|
819 |
|
<div class="method-signature"> |
820 |
|
<span class="method-result">void</span> |
821 |
|
<span class="method-name"> |
822 |
|
push |
823 |
|
</span> |
824 |
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
825 |
|
</div> |
826 |
|
|
827 |
|
<ul class="parameters"> |
828 |
|
<li> |
829 |
|
<span class="var-type">mixed</span> |
830 |
|
<span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li> |
831 |
|
</ul> |
832 |
|
|
833 |
|
<hr class="separator" /> |
834 |
|
<div class="notes">Redefinition of:</div> |
835 |
|
<dl> |
836 |
|
<dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt> |
837 |
|
<dd>Same as add().</dd> |
838 |
|
</dl> |
839 |
|
|
840 |
|
</div> |
841 |
|
<a name="methodpush_reference" id="push_reference"><!-- --></a> |
842 |
|
<div class="oddrow"> |
843 |
|
|
844 |
|
<div class="method-header"> |
845 |
|
<span class="method-title">push_reference</span> (line <span class="line-number">255</span>) |
846 |
|
</div> |
847 |
|
|
848 |
|
<!-- ========== Info from phpDoc block ========= --> |
849 |
|
<p class="short-description">Same as add_reference NOTE : only exists for compatibility with 1.1.x</p> |
850 |
|
<ul class="tags"> |
851 |
|
<li><span class="field">access:</span> public</li> |
852 |
|
</ul> |
853 |
|
|
854 |
|
<div class="method-signature"> |
855 |
|
<span class="method-result">void</span> |
856 |
|
<span class="method-name"> |
857 |
|
push_reference |
858 |
|
</span> |
859 |
|
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
860 |
|
</div> |
861 |
|
|
862 |
|
<ul class="parameters"> |
863 |
|
<li> |
864 |
|
<span class="var-type">mixed</span> |
865 |
|
<span class="var-name">&$content</span><span class="var-description">: - a reference to some variable.</span> </li> |
866 |
|
</ul> |
867 |
|
|
868 |
|
<hr class="separator" /> |
869 |
|
<div class="notes">Redefinition of:</div> |
870 |
|
<dl> |
871 |
|
<dt><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></dt> |
872 |
|
<dd>Same as add_reference NOTE : only exists for compatibility with 1.1.x</dd> |
873 |
|
</dl> |
874 |
|
|
875 |
|
</div> |
876 |
|
<a name="methodrender" id="render"><!-- --></a> |
877 |
|
<div class="evenrow"> |
878 |
|
|
879 |
|
<div class="method-header"> |
880 |
|
<span class="method-title">render</span> (line <span class="line-number">152</span>) |
881 |
|
</div> |
882 |
|
|
883 |
|
<!-- ========== Info from phpDoc block ========= --> |
884 |
|
<p class="short-description">function that will render the XML Document.</p> |
885 |
|
<ul class="tags"> |
886 |
|
<li><span class="field">return:</span> the raw html output.</li> |
887 |
|
</ul> |
888 |
|
|
889 |
|
<div class="method-signature"> |
890 |
|
<span class="method-result">string</span> |
891 |
|
<span class="method-name"> |
892 |
|
render |
893 |
|
</span> |
894 |
|
(<span class="var-type">int</span> <span class="var-name">$indent_level</span>, <span class="var-type">int</span> <span class="var-name">1</span>) |
895 |
|
</div> |
896 |
|
|
897 |
|
<ul class="parameters"> |
898 |
|
<li> |
899 |
|
<span class="var-type">int</span> |
900 |
|
<span class="var-name">1</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li> |
901 |
|
<li> |
902 |
|
<span class="var-type">int</span> |
903 |
|
<span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li> |
904 |
|
</ul> |
905 |
|
|
906 |
|
<hr class="separator" /> |
907 |
|
<div class="notes">Redefinition of:</div> |
908 |
|
<dl> |
909 |
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
910 |
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
911 |
|
</dl> |
912 |
|
|
913 |
|
</div> |
914 |
|
<a name="methodreset_content" id="reset_content"><!-- --></a> |
915 |
|
<div class="oddrow"> |
916 |
|
|
917 |
|
<div class="method-header"> |
918 |
|
<span class="method-title">reset_content</span> (line <span class="line-number">291</span>) |
919 |
|
</div> |
920 |
|
|
921 |
|
<!-- ========== Info from phpDoc block ========= --> |
922 |
|
<p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p> |
923 |
|
<p class="description"><p>destroy existing content and start with new content.</p></p> |
924 |
|
<ul class="tags"> |
925 |
|
<li><span class="field">access:</span> public</li> |
926 |
|
</ul> |
927 |
|
|
928 |
|
<div class="method-signature"> |
929 |
|
<span class="method-result">void</span> |
930 |
|
<span class="method-name"> |
931 |
|
reset_content |
932 |
|
</span> |
933 |
|
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
934 |
|
</div> |
935 |
|
|
936 |
|
<ul class="parameters"> |
937 |
|
<li> |
938 |
|
<span class="var-type">mixed</span> |
939 |
|
<span class="var-name">$content</span><span class="var-description">: can be tag object, or raw (string).</span> </li> |
940 |
|
</ul> |
941 |
|
|
942 |
|
<hr class="separator" /> |
943 |
|
<div class="notes">Redefinition of:</div> |
944 |
|
<dl> |
945 |
|
<dt><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></dt> |
946 |
|
<dd>destroy existing content and start with new content.</dd> |
947 |
|
</dl> |
948 |
|
|
949 |
|
</div> |
950 |
|
<a name="methodset_doctype_link" id="set_doctype_link"><!-- --></a> |
951 |
|
<div class="evenrow"> |
952 |
|
|
953 |
|
<div class="method-header"> |
954 |
|
<span class="method-title">set_doctype_link</span> (line <span class="line-number">392</span>) |
955 |
|
</div> |
956 |
|
|
957 |
|
<!-- ========== Info from phpDoc block ========= --> |
958 |
|
<p class="short-description">This method is used to set the link attributes</p> |
959 |
|
<p class="description"><p>for the DOCTYPE tag</p></p> |
960 |
|
|
961 |
|
<div class="method-signature"> |
962 |
|
<span class="method-result">void</span> |
963 |
|
<span class="method-name"> |
964 |
|
set_doctype_link |
965 |
|
</span> |
966 |
|
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
967 |
|
</div> |
968 |
|
|
969 |
|
|
970 |
|
|
971 |
|
</div> |
972 |
|
<a name="methodset_doctype_source" id="set_doctype_source"><!-- --></a> |
973 |
|
<div class="oddrow"> |
974 |
|
|
975 |
|
<div class="method-header"> |
976 |
|
<span class="method-title">set_doctype_source</span> (line <span class="line-number">464</span>) |
977 |
|
</div> |
978 |
|
|
979 |
|
<!-- ========== Info from phpDoc block ========= --> |
980 |
|
<p class="short-description">this function is used to change the DOCTYPE tag's source attribute. By default it is set to SYSTEM.</p> |
981 |
|
<p class="description"><p>(ie <!DOCTYPE html SYSTEM > ) ^^^^^^</p><p>NOTE: only 2 valid values 'SYSTEM', 'PUBLIC'</p></p> |
982 |
|
|
983 |
|
<div class="method-signature"> |
984 |
|
<span class="method-result">void</span> |
985 |
|
<span class="method-name"> |
986 |
|
set_doctype_source |
987 |
|
</span> |
988 |
|
(<span class="var-type">string</span> <span class="var-name">$source</span>) |
989 |
|
</div> |
990 |
|
|
991 |
|
<ul class="parameters"> |
992 |
|
<li> |
993 |
|
<span class="var-type">string</span> |
994 |
|
<span class="var-name">$source</span><span class="var-description">: - the new source attribute</span> </li> |
995 |
|
</ul> |
996 |
|
|
997 |
|
|
998 |
|
</div> |
999 |
|
<a name="methodset_encoding" id="set_encoding"><!-- --></a> |
1000 |
|
<div class="evenrow"> |
1001 |
|
|
1002 |
|
<div class="method-header"> |
1003 |
|
<span class="method-title">set_encoding</span> (line <span class="line-number">323</span>) |
1004 |
|
</div> |
1005 |
|
|
1006 |
|
<!-- ========== Info from phpDoc block ========= --> |
1007 |
|
<p class="short-description">set the character set</p> |
1008 |
|
|
1009 |
|
<div class="method-signature"> |
1010 |
|
<span class="method-result">void</span> |
1011 |
|
<span class="method-name"> |
1012 |
|
set_encoding |
1013 |
|
</span> |
1014 |
|
(<span class="var-type">string</span> <span class="var-name">$charset</span>) |
1015 |
|
</div> |
1016 |
|
|
1017 |
|
<ul class="parameters"> |
1018 |
|
<li> |
1019 |
|
<span class="var-type">string</span> |
1020 |
|
<span class="var-name">$charset</span><span class="var-description">: - the charset for the meta tag</span> </li> |
1021 |
|
</ul> |
1022 |
|
|
1023 |
|
|
1024 |
|
</div> |
1025 |
|
<a name="methodset_http_content_type" id="set_http_content_type"><!-- --></a> |
1026 |
|
<div class="oddrow"> |
1027 |
|
|
1028 |
|
<div class="method-header"> |
1029 |
|
<span class="method-title">set_http_content_type</span> (line <span class="line-number">426</span>) |
1030 |
|
</div> |
1031 |
|
|
1032 |
|
<!-- ========== Info from phpDoc block ========= --> |
1033 |
|
<p class="short-description">This function is used to set the http header content-type for output to browsers</p> |
1034 |
|
|
1035 |
|
<div class="method-signature"> |
1036 |
|
<span class="method-result">void</span> |
1037 |
|
<span class="method-name"> |
1038 |
|
set_http_content_type |
1039 |
|
</span> |
1040 |
|
([<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/xml"</span>]) |
1041 |
|
</div> |
1042 |
|
|
1043 |
|
<ul class="parameters"> |
1044 |
|
<li> |
1045 |
|
<span class="var-type">string</span> |
1046 |
|
<span class="var-name">$type</span> </li> |
1047 |
|
</ul> |
1048 |
|
|
1049 |
|
|
1050 |
|
</div> |
1051 |
|
<a name="methodset_root_attribute" id="set_root_attribute"><!-- --></a> |
1052 |
|
<div class="evenrow"> |
1053 |
|
|
1054 |
|
<div class="method-header"> |
1055 |
|
<span class="method-title">set_root_attribute</span> (line <span class="line-number">373</span>) |
1056 |
|
</div> |
1057 |
|
|
1058 |
|
<!-- ========== Info from phpDoc block ========= --> |
1059 |
|
<p class="short-description">This sets 1 root tag attribute value pair</p> |
1060 |
|
|
1061 |
|
<div class="method-signature"> |
1062 |
|
<span class="method-result">void</span> |
1063 |
|
<span class="method-name"> |
1064 |
|
set_root_attribute |
1065 |
|
</span> |
1066 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
1067 |
|
</div> |
1068 |
|
|
1069 |
|
<ul class="parameters"> |
1070 |
|
<li> |
1071 |
|
<span class="var-type">string</span> |
1072 |
|
<span class="var-name">$name</span><span class="var-description">: - the attribute name</span> </li> |
1073 |
|
<li> |
1074 |
|
<span class="var-type">string</span> |
1075 |
|
<span class="var-name">$value</span><span class="var-description">: - the attribute value</span> </li> |
1076 |
|
</ul> |
1077 |
|
|
1078 |
|
|
1079 |
|
</div> |
1080 |
|
<a name="methodset_root_attributes" id="set_root_attributes"><!-- --></a> |
1081 |
|
<div class="oddrow"> |
1082 |
|
|
1083 |
|
<div class="method-header"> |
1084 |
|
<span class="method-title">set_root_attributes</span> (line <span class="line-number">363</span>) |
1085 |
|
</div> |
1086 |
|
|
1087 |
|
<!-- ========== Info from phpDoc block ========= --> |
1088 |
|
<p class="short-description">This function is used to set the root xml tag's attributes</p> |
1089 |
|
|
1090 |
|
<div class="method-signature"> |
1091 |
|
<span class="method-result">void</span> |
1092 |
|
<span class="method-name"> |
1093 |
|
set_root_attributes |
1094 |
|
</span> |
1095 |
|
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
1096 |
|
</div> |
1097 |
|
|
1098 |
|
<ul class="parameters"> |
1099 |
|
<li> |
1100 |
|
<span class="var-type">array</span> |
1101 |
|
<span class="var-name">$attributes</span> </li> |
1102 |
|
</ul> |
1103 |
|
|
1104 |
|
|
1105 |
|
</div> |
1106 |
|
<a name="methodset_root_name" id="set_root_name"><!-- --></a> |
1107 |
|
<div class="evenrow"> |
1108 |
|
|
1109 |
|
<div class="method-header"> |
1110 |
|
<span class="method-title">set_root_name</span> (line <span class="line-number">343</span>) |
1111 |
|
</div> |
1112 |
|
|
1113 |
|
<!-- ========== Info from phpDoc block ========= --> |
1114 |
|
<p class="short-description">Set the document name and the root tag's name.</p> |
1115 |
|
|
1116 |
|
<div class="method-signature"> |
1117 |
|
<span class="method-result">void</span> |
1118 |
|
<span class="method-name"> |
1119 |
|
set_root_name |
1120 |
|
</span> |
1121 |
|
(<span class="var-type">mixed</span> <span class="var-name">$root_name</span>, <span class="var-type">string</span> <span class="var-name">$doc_name</span>) |
1122 |
|
</div> |
1123 |
|
|
1124 |
|
<ul class="parameters"> |
1125 |
|
<li> |
1126 |
|
<span class="var-type">string</span> |
1127 |
|
<span class="var-name">$doc_name</span> </li> |
1128 |
|
</ul> |
1129 |
|
|
1130 |
|
|
1131 |
|
</div> |
1132 |
|
<a name="methodshow_character_encoding" id="show_character_encoding"><!-- --></a> |
1133 |
|
<div class="oddrow"> |
1134 |
|
|
1135 |
|
<div class="method-header"> |
1136 |
|
<span class="method-title">show_character_encoding</span> (line <span class="line-number">405</span>) |
1137 |
|
</div> |
1138 |
|
|
1139 |
|
<!-- ========== Info from phpDoc block ========= --> |
1140 |
|
<p class="short-description">method to update the flag that lets us know to show/render the character encoding string in the xml tag or not</p> |
1141 |
|
|
1142 |
|
<div class="method-signature"> |
1143 |
|
<span class="method-result">void</span> |
1144 |
|
<span class="method-name"> |
1145 |
|
show_character_encoding |
1146 |
|
</span> |
1147 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
1148 |
|
</div> |
1149 |
|
|
1150 |
|
<ul class="parameters"> |
1151 |
|
<li> |
1152 |
|
<span class="var-type">boolean</span> |
1153 |
|
<span class="var-name">$flag</span> </li> |
1154 |
|
</ul> |
1155 |
|
|
1156 |
|
|
1157 |
|
</div> |
1158 |
|
<a name="methodshow_http_header" id="show_http_header"><!-- --></a> |
1159 |
|
<div class="evenrow"> |
1160 |
|
|
1161 |
|
<div class="method-header"> |
1162 |
|
<span class="method-title">show_http_header</span> (line <span class="line-number">416</span>) |
1163 |
|
</div> |
1164 |
|
|
1165 |
|
<!-- ========== Info from phpDoc block ========= --> |
1166 |
|
<p class="short-description">this function is used to set the flag that tells this class to automatically output the content type in the http header</p> |
1167 |
|
|
1168 |
|
<div class="method-signature"> |
1169 |
|
<span class="method-result">void</span> |
1170 |
|
<span class="method-name"> |
1171 |
|
show_http_header |
1172 |
|
</span> |
1173 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
1174 |
|
</div> |
1175 |
|
|
1176 |
|
<ul class="parameters"> |
1177 |
|
<li> |
1178 |
|
<span class="var-type">boolean</span> |
1179 |
|
<span class="var-name">$flag</span> </li> |
1180 |
|
</ul> |
1181 |
|
|
1182 |
|
|
1183 |
|
</div> |
1184 |
|
<a name="method_build_doctype" id="_build_doctype"><!-- --></a> |
1185 |
|
<div class="oddrow"> |
1186 |
|
|
1187 |
|
<div class="method-header"> |
1188 |
|
<span class="method-title">_build_doctype</span> (line <span class="line-number">492</span>) |
1189 |
|
</div> |
1190 |
|
|
1191 |
|
<!-- ========== Info from phpDoc block ========= --> |
1192 |
|
<p class="short-description">This method builds the DOCTYPE tag for the document</p> |
1193 |
|
|
1194 |
|
<div class="method-signature"> |
1195 |
|
<span class="method-result">void</span> |
1196 |
|
<span class="method-name"> |
1197 |
|
_build_doctype |
1198 |
|
</span> |
1199 |
|
() |
1200 |
|
</div> |
1201 |
|
|
1202 |
|
|
1203 |
|
|
1204 |
|
</div> |
1205 |
|
<a name="method_build_root_tag" id="_build_root_tag"><!-- --></a> |
1206 |
|
<div class="evenrow"> |
1207 |
|
|
1208 |
|
<div class="method-header"> |
1209 |
|
<span class="method-title">_build_root_tag</span> (line <span class="line-number">314</span>) |
1210 |
|
</div> |
1211 |
|
|
1212 |
|
<!-- ========== Info from phpDoc block ========= --> |
1213 |
|
<p class="short-description">This function builds the root xml</p> |
1214 |
|
<p class="description"><p>tag that will contain all of the Document's xml tags</p></p> |
1215 |
|
|
1216 |
|
<div class="method-signature"> |
1217 |
|
<span class="method-result">void</span> |
1218 |
|
<span class="method-name"> |
1219 |
|
_build_root_tag |
1220 |
|
</span> |
1221 |
|
() |
1222 |
|
</div> |
1223 |
|
|
1224 |
|
|
1225 |
|
|
1226 |
|
</div> |
1227 |
|
<a name="method_build_xml_stylesheet_container" id="_build_xml_stylesheet_container"><!-- --></a> |
1228 |
|
<div class="oddrow"> |
1229 |
|
|
1230 |
|
<div class="method-header"> |
1231 |
|
<span class="method-title">_build_xml_stylesheet_container</span> (line <span class="line-number">277</span>) |
1232 |
|
</div> |
1233 |
|
|
1234 |
|
<!-- ========== Info from phpDoc block ========= --> |
1235 |
|
<p class="short-description">This function builds the _xml_stylesheet_container</p> |
1236 |
|
|
1237 |
|
<div class="method-signature"> |
1238 |
|
<span class="method-result">void</span> |
1239 |
|
<span class="method-name"> |
1240 |
|
_build_xml_stylesheet_container |
1241 |
|
</span> |
1242 |
|
() |
1243 |
|
</div> |
1244 |
|
|
1245 |
|
|
1246 |
|
|
1247 |
|
</div> |
1248 |
|
<a name="method_create_xml_obj" id="_create_xml_obj"><!-- --></a> |
1249 |
|
<div class="evenrow"> |
1250 |
|
|
1251 |
|
<div class="method-header"> |
1252 |
|
<span class="method-title">_create_xml_obj</span> (line <span class="line-number">304</span>) |
1253 |
|
</div> |
1254 |
|
|
1255 |
|
<!-- ========== Info from phpDoc block ========= --> |
1256 |
|
<p class="short-description">This function builds the local</p> |
1257 |
|
<p class="description"><p>xml container object that holds all xml tags that are pushed into this class</p></p> |
1258 |
|
<ul class="tags"> |
1259 |
|
<li><span class="field">return:</span> object</li> |
1260 |
|
</ul> |
1261 |
|
|
1262 |
|
<div class="method-signature"> |
1263 |
|
<span class="method-result"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></span> |
1264 |
|
<span class="method-name"> |
1265 |
|
_create_xml_obj |
1266 |
|
</span> |
1267 |
|
() |
1268 |
|
</div> |
1269 |
|
|
1270 |
|
|
1271 |
|
|
1272 |
|
</div> |
1273 |
|
<h4>Inherited Methods</h4> |
1274 |
|
<a name='inherited_methods'><!-- --></a> |
1275 |
|
<!-- =========== Summary =========== --> |
1276 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
1277 |
|
<blockquote> |
1278 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
1279 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
1280 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
1281 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
1282 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
1283 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
1284 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
1285 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
1286 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
1287 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
1288 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
1289 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
1290 |
|
</blockquote> |
1291 |
|
|
1292 |
|
</div> |
1293 |
|
</div> |
1294 |
|
|
1295 |
|
|
1296 |
|
<p class="notes" id="credit"> |
1297 |
|
Documentation generated on Thu, 1 Apr 2004 09:40:24 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
1298 |
|
</p> |
1299 |
|
</div></body> |
1300 |
|
</html> |