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