|
<?xml version="1.0" encoding="iso-8859-1"?> |
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
|
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
|
<head> |
|
|
<!-- template designed by Marco Von Ballmoos --> |
|
|
<title>Docs for page xml_utils.inc</title> |
|
|
<link rel="stylesheet" href="../media/stylesheet.css" /> |
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
|
|
</head> |
|
|
<body> |
|
|
<div class="page-body"> |
|
|
<h2 class="file-name">Program_Root/tag_utils/xml_utils.inc</h2> |
|
|
|
|
|
<a name="sec-description"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Description</div> |
|
|
<div class="nav-bar"> |
|
|
<span class="disabled">Description</span> | |
|
|
<a href="#sec-functions">Functions</a> |
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This file holds helper functions for things related to XMLTagClass objects/data</p> |
|
|
<p class="description"><p>$Id$</p></p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
|
|
</ul> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="sec-functions"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Functions</div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<span class="disabled">Functions</span> |
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<a name="functionarray_to_xml_tree" id="functionarray_to_xml_tree"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div> |
|
|
<span class="method-title">array_to_xml_tree</span> (line <span class="line-number">108</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function converts an array to an xml document.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
array_to_xml_tree |
|
|
</span> |
|
|
(<span class="var-type">array</span> <span class="var-name">$arr</span>, <span class="var-type">string</span> <span class="var-name">1</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">1</span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$arr</span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="functionxml_ctag" id="functionxml_ctag"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div> |
|
|
<span class="method-title">xml_ctag</span> (line <span class="line-number">51</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds an xml tag, just as xml_tag() does, but turns on the auto wrapping of CDATA for the content for the tag.</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/XMLTagClass.html">XMLTagClass</a></span> |
|
|
<span class="method-name"> |
|
|
&xml_ctag |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">2</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">2</span><span class="var-description">: <p>- any content that lives in the PCDATA portion of the XML tag</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$name</span><span class="var-description">: <p>- the xml tag name</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$attributes</span><span class="var-description">: <p>- the name="value" pairs of tag attributes</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="functionxml_doctype" id="functionxml_doctype"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div> |
|
|
<span class="method-title">xml_doctype</span> (line <span class="line-number">70</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to build a DOCTYPE tag</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/DOCTYPEtag.html">DOCTYPEtag</a></span> |
|
|
<span class="method-name"> |
|
|
xml_doctype |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$doc_element</span>, [<span class="var-type">string</span> <span class="var-name">$source</span> = <span class="var-default">"PUBLIC"</span>], [<span class="var-type">string</span> <span class="var-name">$link1</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$link2</span> = <span class="var-default">NULL</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$doc_element</span><span class="var-description">: <p>- the document element name (ie. 'HTML')</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$source</span><span class="var-description">: <p>- the source (ie. 'PUBLIC')</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$link1</span><span class="var-description">: <p>- link 1 (ie. '-//W3C//DTD XHTML 1.0 Transitional//EN' )</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$link2</span><span class="var-description">: <p>- link 2 (ie. 'DTD/xhtml1-transitional.dtd' )</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="functionxml_stylesheet" id="functionxml_stylesheet"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div> |
|
|
<span class="method-title">xml_stylesheet</span> (line <span class="line-number">94</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to build an xml-stylesheet tag</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/XMLSTYLESHEETtag.html">XMLSTYLESHEETtag</a></span> |
|
|
<span class="method-name"> |
|
|
xml_stylesheet |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$href</span>, [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"text/css"</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 attribute</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$type</span><span class="var-description">: <p>- the type attribute</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="functionxml_tag" id="functionxml_tag"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div> |
|
|
<span class="method-title">xml_tag</span> (line <span class="line-number">29</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This is a simple wrapper function for building XMLTagClass objects</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/XMLTagClass.html">XMLTagClass</a></span> |
|
|
<span class="method-name"> |
|
|
&xml_tag |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">2</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">2</span><span class="var-description">: <p>- any content that lives in the PCDATA portion of the XML tag</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$name</span><span class="var-description">: <p>- the xml tag name</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$attributes</span><span class="var-description">: <p>- the name="value" pairs of tag attributes</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<p class="notes" id="credit"> |
|
|
Documention generated on Thu, 31 Jul 2003 18:34:08 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
|
|
</p> |
|
|
</div></body> |
|
|
</html> |
|
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"> |
3 |
|
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
|
<head> |
5 |
|
<!-- template designed by Marco Von Ballmoos --> |
6 |
|
<title>Docs for page xml_utils.inc</title> |
7 |
|
<link rel="stylesheet" href="../media/stylesheet.css" /> |
8 |
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
|
</head> |
10 |
|
<body> |
11 |
|
<div class="page-body"> |
12 |
|
<h2 class="file-name">/tag_utils/xml_utils.inc</h2> |
13 |
|
|
14 |
|
<a name="sec-description"></a> |
15 |
|
<div class="info-box"> |
16 |
|
<div class="info-box-title">Description</div> |
17 |
|
<div class="nav-bar"> |
18 |
|
<span class="disabled">Description</span> | |
19 |
|
<a href="#sec-functions">Functions</a> |
20 |
|
</div> |
21 |
|
<div class="info-box-body"> |
22 |
|
<!-- ========== Info from phpDoc block ========= --> |
23 |
|
<p class="short-description">This file holds helper functions for things related to XMLTagClass objects/data</p> |
24 |
|
<p class="description"><p>$Id$</p></p> |
25 |
|
<ul class="tags"> |
26 |
|
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
27 |
|
</ul> |
28 |
|
|
29 |
|
</div> |
30 |
|
</div> |
31 |
|
|
32 |
|
|
33 |
|
|
34 |
|
|
35 |
|
|
36 |
|
<a name="sec-functions"></a> |
37 |
|
<div class="info-box"> |
38 |
|
<div class="info-box-title">Functions</div> |
39 |
|
<div class="nav-bar"> |
40 |
|
<a href="#sec-description">Description</a> | |
41 |
|
<span class="disabled">Functions</span> |
42 |
|
</div> |
43 |
|
<div class="info-box-body"> |
44 |
|
<a name="functionarray_to_xml_tree" id="functionarray_to_xml_tree"><!-- --></a> |
45 |
|
<div class="evenrow"> |
46 |
|
|
47 |
|
<div> |
48 |
|
<span class="method-title">array_to_xml_tree</span> (line <span class="line-number">110</span>) |
49 |
|
</div> |
50 |
|
|
51 |
|
<!-- ========== Info from phpDoc block ========= --> |
52 |
|
<p class="short-description">This function converts an array to an xml document.</p> |
53 |
|
|
54 |
|
<div class="method-signature"> |
55 |
|
<span class="method-result">void</span> |
56 |
|
<span class="method-name"> |
57 |
|
array_to_xml_tree |
58 |
|
</span> |
59 |
|
(<span class="var-type">array</span> <span class="var-name">$arr</span>, <span class="var-type">string</span> <span class="var-name">1</span>) |
60 |
|
</div> |
61 |
|
|
62 |
|
<ul class="parameters"> |
63 |
|
<li> |
64 |
|
<span class="var-type">string</span> |
65 |
|
<span class="var-name">1</span> </li> |
66 |
|
<li> |
67 |
|
<span class="var-type">array</span> |
68 |
|
<span class="var-name">$arr</span> </li> |
69 |
|
</ul> |
70 |
|
|
71 |
|
|
72 |
|
</div> |
73 |
|
<a name="functionxml_ctag" id="functionxml_ctag"><!-- --></a> |
74 |
|
<div class="oddrow"> |
75 |
|
|
76 |
|
<div> |
77 |
|
<span class="method-title">xml_ctag</span> (line <span class="line-number">53</span>) |
78 |
|
</div> |
79 |
|
|
80 |
|
<!-- ========== Info from phpDoc block ========= --> |
81 |
|
<p class="short-description">This builds an xml tag, just as xml_tag() does, but turns on the auto wrapping of CDATA for the content for the tag.</p> |
82 |
|
<ul class="tags"> |
83 |
|
<li><span class="field">return:</span> object</li> |
84 |
|
</ul> |
85 |
|
|
86 |
|
<div class="method-signature"> |
87 |
|
<span class="method-result"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
88 |
|
<span class="method-name"> |
89 |
|
&xml_ctag |
90 |
|
</span> |
91 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">2</span>) |
92 |
|
</div> |
93 |
|
|
94 |
|
<ul class="parameters"> |
95 |
|
<li> |
96 |
|
<span class="var-type">mixed</span> |
97 |
|
<span class="var-name">2</span><span class="var-description">: - any content that lives in the PCDATA portion of the XML tag</span> </li> |
98 |
|
<li> |
99 |
|
<span class="var-type">string</span> |
100 |
|
<span class="var-name">$name</span><span class="var-description">: - the xml tag name</span> </li> |
101 |
|
<li> |
102 |
|
<span class="var-type">array</span> |
103 |
|
<span class="var-name">$attributes</span><span class="var-description">: - the name="value" pairs of tag attributes</span> </li> |
104 |
|
</ul> |
105 |
|
|
106 |
|
|
107 |
|
</div> |
108 |
|
<a name="functionxml_doctype" id="functionxml_doctype"><!-- --></a> |
109 |
|
<div class="evenrow"> |
110 |
|
|
111 |
|
<div> |
112 |
|
<span class="method-title">xml_doctype</span> (line <span class="line-number">72</span>) |
113 |
|
</div> |
114 |
|
|
115 |
|
<!-- ========== Info from phpDoc block ========= --> |
116 |
|
<p class="short-description">This function is used to build a DOCTYPE tag</p> |
117 |
|
<ul class="tags"> |
118 |
|
<li><span class="field">return:</span> object</li> |
119 |
|
</ul> |
120 |
|
|
121 |
|
<div class="method-signature"> |
122 |
|
<span class="method-result"><a href="../phpHtmlLib/DOCTYPEtag.html">DOCTYPEtag</a></span> |
123 |
|
<span class="method-name"> |
124 |
|
xml_doctype |
125 |
|
</span> |
126 |
|
(<span class="var-type">string</span> <span class="var-name">$doc_element</span>, [<span class="var-type">string</span> <span class="var-name">$source</span> = <span class="var-default">"PUBLIC"</span>], [<span class="var-type">string</span> <span class="var-name">$link1</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$link2</span> = <span class="var-default">NULL</span>]) |
127 |
|
</div> |
128 |
|
|
129 |
|
<ul class="parameters"> |
130 |
|
<li> |
131 |
|
<span class="var-type">string</span> |
132 |
|
<span class="var-name">$doc_element</span><span class="var-description">: - the document element name (ie. 'HTML')</span> </li> |
133 |
|
<li> |
134 |
|
<span class="var-type">string</span> |
135 |
|
<span class="var-name">$source</span><span class="var-description">: - the source (ie. 'PUBLIC')</span> </li> |
136 |
|
<li> |
137 |
|
<span class="var-type">string</span> |
138 |
|
<span class="var-name">$link1</span><span class="var-description">: - link 1 (ie. '-//W3C//DTD XHTML 1.0 Transitional//EN' )</span> </li> |
139 |
|
<li> |
140 |
|
<span class="var-type">string</span> |
141 |
|
<span class="var-name">$link2</span><span class="var-description">: - link 2 (ie. 'DTD/xhtml1-transitional.dtd' )</span> </li> |
142 |
|
</ul> |
143 |
|
|
144 |
|
|
145 |
|
</div> |
146 |
|
<a name="functionxml_stylesheet" id="functionxml_stylesheet"><!-- --></a> |
147 |
|
<div class="oddrow"> |
148 |
|
|
149 |
|
<div> |
150 |
|
<span class="method-title">xml_stylesheet</span> (line <span class="line-number">96</span>) |
151 |
|
</div> |
152 |
|
|
153 |
|
<!-- ========== Info from phpDoc block ========= --> |
154 |
|
<p class="short-description">This function is used to build an xml-stylesheet tag</p> |
155 |
|
<ul class="tags"> |
156 |
|
<li><span class="field">return:</span> object</li> |
157 |
|
</ul> |
158 |
|
|
159 |
|
<div class="method-signature"> |
160 |
|
<span class="method-result"><a href="../phpHtmlLib/XMLSTYLESHEETtag.html">XMLSTYLESHEETtag</a></span> |
161 |
|
<span class="method-name"> |
162 |
|
xml_stylesheet |
163 |
|
</span> |
164 |
|
(<span class="var-type">string</span> <span class="var-name">$href</span>, [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"text/css"</span>]) |
165 |
|
</div> |
166 |
|
|
167 |
|
<ul class="parameters"> |
168 |
|
<li> |
169 |
|
<span class="var-type">string</span> |
170 |
|
<span class="var-name">$href</span><span class="var-description">: - the href attribute</span> </li> |
171 |
|
<li> |
172 |
|
<span class="var-type">string</span> |
173 |
|
<span class="var-name">$type</span><span class="var-description">: - the type attribute</span> </li> |
174 |
|
</ul> |
175 |
|
|
176 |
|
|
177 |
|
</div> |
178 |
|
<a name="functionxml_tag" id="functionxml_tag"><!-- --></a> |
179 |
|
<div class="evenrow"> |
180 |
|
|
181 |
|
<div> |
182 |
|
<span class="method-title">xml_tag</span> (line <span class="line-number">31</span>) |
183 |
|
</div> |
184 |
|
|
185 |
|
<!-- ========== Info from phpDoc block ========= --> |
186 |
|
<p class="short-description">This is a simple wrapper function for building XMLTagClass objects</p> |
187 |
|
<ul class="tags"> |
188 |
|
<li><span class="field">return:</span> object</li> |
189 |
|
<li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_XMLTagClass.cls.html#helper">Creating an XML tag object with a function.</a></li> |
190 |
|
</ul> |
191 |
|
|
192 |
|
<div class="method-signature"> |
193 |
|
<span class="method-result"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
194 |
|
<span class="method-name"> |
195 |
|
&xml_tag |
196 |
|
</span> |
197 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">2</span>) |
198 |
|
</div> |
199 |
|
|
200 |
|
<ul class="parameters"> |
201 |
|
<li> |
202 |
|
<span class="var-type">mixed</span> |
203 |
|
<span class="var-name">2</span><span class="var-description">: - any content that lives in the PCDATA portion of the XML tag</span> </li> |
204 |
|
<li> |
205 |
|
<span class="var-type">string</span> |
206 |
|
<span class="var-name">$name</span><span class="var-description">: - the xml tag name</span> </li> |
207 |
|
<li> |
208 |
|
<span class="var-type">array</span> |
209 |
|
<span class="var-name">$attributes</span><span class="var-description">: - the name="value" pairs of tag attributes</span> </li> |
210 |
|
</ul> |
211 |
|
|
212 |
|
|
213 |
|
</div> |
214 |
|
</div> |
215 |
|
</div> |
216 |
|
|
217 |
|
<p class="notes" id="credit"> |
218 |
|
Documentation generated on Thu, 1 Apr 2004 09:40:27 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
219 |
|
</p> |
220 |
|
</div></body> |
221 |
|
</html> |