1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:41 -0800' --> |
6 |
<TITLE>Docs for page xml_utils.inc</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
11 |
|
12 |
<!-- Links --> |
13 |
<a NAME="top"></A> |
14 |
<table WIDTH="100%" class="links"> |
15 |
<TR> |
16 |
<TD class="font10"> |
17 |
Links: |
18 |
<A HREF="#classes_summary" class="links" title="Classes created in this file">Classes</A> |
19 |
<A HREF="#includes_summary" class="links" title="Include Statements Summary">Includes</A> |
20 |
<A HREF="#globals_summary" class="links" title="Global Variable Summary">Globals</A> |
21 |
<A HREF="#constant_summary" class="links" title="Constant Summary">Constants</A> |
22 |
<A HREF="#functions_summary" class="links" title="Function Summary">Functions</A> |
23 |
<A HREF="#includes_detail" class="links" title="Include Statements Detail">Includes Detail</A> |
24 |
<A HREF="#global_detail" class="links" title="Global Variable Detail">Globals Detail</A> |
25 |
<A HREF="#constant_detail" class="links" title="Constant Detail">Constants Detail</A> |
26 |
<A HREF="#function_detail" class="links" title="Function Detail">Functions Detail</A> |
27 |
</TD> |
28 |
</TR> |
29 |
</TABLE> |
30 |
<BR> |
31 |
|
32 |
<h2>File: Program_Root/tag_utils/xml_utils.inc</h2> |
33 |
<!-- ========== Info from phpDoc block ========= --> |
34 |
This file holds helper functions |
35 |
<BR> |
36 |
for things related to XMLTagClass |
37 |
objects/data |
38 |
|
39 |
$Id: _tag_utils_xml_utils_inc.html,v 1.20 2002/11/25 17:56:10 hemna Exp $ |
40 |
|
41 |
<UL> |
42 |
|
43 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
44 |
|
45 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
46 |
|
47 |
</UL> |
48 |
|
49 |
<br> |
50 |
<!-- =========== Used Classes =========== --> |
51 |
<A NAME='classes_summary'><!-- --></A> |
52 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
53 |
<TR CLASS='TableHeadingColor'> |
54 |
<TD> |
55 |
<span class="font12bold">Classes defined in this file</span> |
56 |
<A HREF="#top" CLASS="links">^TOP</A> |
57 |
</TD> |
58 |
</TR> |
59 |
</TABLE> |
60 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
61 |
<THEAD> |
62 |
<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR> |
63 |
</THEAD> |
64 |
<TBODY> |
65 |
|
66 |
</TBODY> |
67 |
</TABLE> |
68 |
<br> |
69 |
<br> |
70 |
<!-- =========== Includes SUMMARY =========== --> |
71 |
<A NAME='includes_summary'><!-- --></A> |
72 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
73 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
74 |
<TD> |
75 |
<span CLASS="font12bold">Include Statements Summary</span> |
76 |
<A HREF="#top" CLASS="links">^TOP</A> |
77 |
</TD> |
78 |
</TR> |
79 |
</TABLE> |
80 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
81 |
<THEAD> |
82 |
<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> |
83 |
</THEAD> |
84 |
<TBODY> |
85 |
|
86 |
</TBODY> |
87 |
</TABLE> |
88 |
<br> |
89 |
|
90 |
<br> |
91 |
<!-- =========== CONSTANT SUMMARY =========== --> |
92 |
<A NAME='global_summary'><!-- --></A> |
93 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
94 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
95 |
<TD> |
96 |
<FONT SIZE='+2'><B>Global Variable Summary</B></FONT> |
97 |
<A HREF="#top" CLASS="links">^TOP</A> |
98 |
</TD> |
99 |
</TR> |
100 |
</TABLE> |
101 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
102 |
<THEAD> |
103 |
<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> |
104 |
</THEAD> |
105 |
<TBODY> |
106 |
|
107 |
</TBODY> |
108 |
</TABLE> |
109 |
<br> |
110 |
|
111 |
|
112 |
<br> |
113 |
<!-- =========== CONSTANT SUMMARY =========== --> |
114 |
<A NAME='constant_summary'><!-- --></A> |
115 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
116 |
<TR CLASS='TableHeadingColor'> |
117 |
<TD> |
118 |
<span CLASS="font12bold">Constant Summary</span> |
119 |
<A HREF="#top" CLASS="links">^TOP</A> |
120 |
</TD> |
121 |
</TR> |
122 |
</TABLE> |
123 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
124 |
<THEAD> |
125 |
<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> |
126 |
</THEAD> |
127 |
<TBODY> |
128 |
|
129 |
</TBODY> |
130 |
</TABLE> |
131 |
<br> |
132 |
|
133 |
<br> |
134 |
<!-- =========== Function SUMMARY =========== --> |
135 |
<A NAME='Function_summary'><!-- --></A> |
136 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
137 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
138 |
<TD> |
139 |
<span class="font12bold">Function Summary</span> |
140 |
<A HREF="#top" CLASS="links">^TOP</A> |
141 |
</TD> |
142 |
</TR> |
143 |
|
144 |
|
145 |
<!-- =========== Summary =========== --> |
146 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
147 |
<TD> |
148 |
<CODE><B><A HREF='_tag_utils_xml_utils_inc.html#array_to_xml_tree'> array_to_xml_tree ( $arr )</A></B></CODE> |
149 |
<BR> |
150 |
<blockquote> This function converts an array to |
151 |
an xml document. </blockquote> |
152 |
</TD> |
153 |
</TR> |
154 |
|
155 |
<!-- =========== Summary =========== --> |
156 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
157 |
<TD> |
158 |
<CODE><B><A HREF='_tag_utils_xml_utils_inc.html#xml_doctype'>DOCTYPEtag xml_doctype ( $doc_element, [$source = "PUBLIC"], [$link1 = NULL], [$link2 = NULL] )</A></B></CODE> |
159 |
<BR> |
160 |
<blockquote> This function is used to build a |
161 |
DOCTYPE tag </blockquote> |
162 |
</TD> |
163 |
</TR> |
164 |
|
165 |
<!-- =========== Summary =========== --> |
166 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
167 |
<TD> |
168 |
<CODE><B><A HREF='_tag_utils_xml_utils_inc.html#xml_stylesheet'>XMLSTYLESHEETtag xml_stylesheet ( $href, [$type = "text/css"] )</A></B></CODE> |
169 |
<BR> |
170 |
<blockquote> This function is used to build an |
171 |
xml-stylesheet tag </blockquote> |
172 |
</TD> |
173 |
</TR> |
174 |
|
175 |
<!-- =========== Summary =========== --> |
176 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
177 |
<TD> |
178 |
<CODE><B><A HREF='_tag_utils_xml_utils_inc.html#xml_tag'>XMLTagClass xml_tag ( $name, [$attributes = array()] )</A></B></CODE> |
179 |
<BR> |
180 |
<blockquote> This is a simple wrapper function |
181 |
for building XMLTagClass objects </blockquote> |
182 |
</TD> |
183 |
</TR> |
184 |
|
185 |
</TABLE> |
186 |
|
187 |
<br> |
188 |
<!-- ============ Includes DETAIL =========== --> |
189 |
|
190 |
<A NAME='includes_detail'></A> |
191 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
192 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
193 |
<TD> |
194 |
<span CLASS="font12bold">Include Statements Detail</span> |
195 |
<A HREF="#top" CLASS="links">^TOP</A> |
196 |
</TD> |
197 |
</TR> |
198 |
</TABLE> |
199 |
|
200 |
|
201 |
|
202 |
<br> |
203 |
<!-- ============ GLOBALS DETAIL =========== --> |
204 |
|
205 |
<A NAME='global_detail'></A> |
206 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
207 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
208 |
<TD> |
209 |
<span CLASS="font12bold">Global Variable Detail</span> |
210 |
<A HREF="#top" CLASS="links">^TOP</A> |
211 |
</TD> |
212 |
</TR> |
213 |
</TABLE> |
214 |
|
215 |
|
216 |
|
217 |
<br> |
218 |
<!-- ============ CONSTANT DETAIL =========== --> |
219 |
|
220 |
<A NAME='constant_detail'></A> |
221 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
222 |
<TR CLASS='TableHeadingColor'> |
223 |
<TD> |
224 |
<span CLASS="font12bold">Constant Detail</span> |
225 |
<A HREF="#top" CLASS="links">^TOP</A> |
226 |
</TD> |
227 |
</TR> |
228 |
</TABLE> |
229 |
|
230 |
|
231 |
|
232 |
<br> |
233 |
<!-- ============ FUNCTION DETAIL =========== --> |
234 |
|
235 |
<A NAME='function_detail'></A> |
236 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
237 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
238 |
<TD> |
239 |
<span class="font12bold">Function Detail</span> |
240 |
<A HREF="#top" CLASS="links">^TOP</A> |
241 |
</TD> |
242 |
</TR> |
243 |
</TABLE> |
244 |
<BR> |
245 |
|
246 |
<DIV CLASS="function"> |
247 |
<A NAME='array_to_xml_tree'><!-- --></A> |
248 |
<SPAN CLASS="font12bold">array_to_xml_tree</SPAN> |
249 |
<BR> |
250 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
251 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
252 |
<span class="font10bold" style="color: #0000FF">array_to_xml_tree ( $arr )</SPAN> |
253 |
<BR> |
254 |
|
255 |
<BR> |
256 |
<SPAN CLASS="font10bold">Description : </SPAN> |
257 |
<!-- ========== Info from phpDoc block ========= --> |
258 |
This function converts an array to |
259 |
an xml document. |
260 |
<BR> |
261 |
|
262 |
<DL> |
263 |
<DT class="font10bold">Function Parameters:</DT> |
264 |
|
265 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">1</SPAN></SPAN> </DD> |
266 |
|
267 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$arr</SPAN></SPAN> </DD> |
268 |
|
269 |
|
270 |
<DT class="font10bold">Function Info:</DT> |
271 |
|
272 |
</DL> |
273 |
|
274 |
</DIV> |
275 |
<BR> |
276 |
|
277 |
<DIV CLASS="function"> |
278 |
<A NAME='xml_doctype'><!-- --></A> |
279 |
<SPAN CLASS="font12bold">xml_doctype</SPAN> |
280 |
<BR> |
281 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
282 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/DOCTYPEtag.html">DOCTYPEtag</a></SPAN> |
283 |
<span class="font10bold" style="color: #0000FF">xml_doctype ( $doc_element, [$source = "PUBLIC"], [$link1 = NULL], [$link2 = NULL] )</SPAN> |
284 |
<BR> |
285 |
|
286 |
<BR> |
287 |
<SPAN CLASS="font10bold">Description : </SPAN> |
288 |
<!-- ========== Info from phpDoc block ========= --> |
289 |
This function is used to build a |
290 |
DOCTYPE tag |
291 |
<BR> |
292 |
|
293 |
<DL> |
294 |
<DT class="font10bold">Function Parameters:</DT> |
295 |
|
296 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$doc_element</SPAN></SPAN> - the document element name (ie. 'HTML')</DD> |
297 |
|
298 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$source</SPAN></SPAN> - the source (ie. 'PUBLIC')</DD> |
299 |
|
300 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$link1</SPAN></SPAN> - link 1 (ie. '-//W3C//DTD XHTML 1.0 Transitional//EN' )</DD> |
301 |
|
302 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$link2</SPAN></SPAN> - link 2 (ie. 'DTD/xhtml1-transitional.dtd' )</DD> |
303 |
|
304 |
|
305 |
<DT class="font10bold">Function Info:</DT> |
306 |
|
307 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD> |
308 |
|
309 |
</DL> |
310 |
|
311 |
</DIV> |
312 |
<BR> |
313 |
|
314 |
<DIV CLASS="function"> |
315 |
<A NAME='xml_stylesheet'><!-- --></A> |
316 |
<SPAN CLASS="font12bold">xml_stylesheet</SPAN> |
317 |
<BR> |
318 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
319 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/XMLSTYLESHEETtag.html">XMLSTYLESHEETtag</a></SPAN> |
320 |
<span class="font10bold" style="color: #0000FF">xml_stylesheet ( $href, [$type = "text/css"] )</SPAN> |
321 |
<BR> |
322 |
|
323 |
<BR> |
324 |
<SPAN CLASS="font10bold">Description : </SPAN> |
325 |
<!-- ========== Info from phpDoc block ========= --> |
326 |
This function is used to build an |
327 |
xml-stylesheet tag |
328 |
<BR> |
329 |
|
330 |
<DL> |
331 |
<DT class="font10bold">Function Parameters:</DT> |
332 |
|
333 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$href</SPAN></SPAN> - the href attribute</DD> |
334 |
|
335 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$type</SPAN></SPAN> - the type attribute</DD> |
336 |
|
337 |
|
338 |
<DT class="font10bold">Function Info:</DT> |
339 |
|
340 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD> |
341 |
|
342 |
</DL> |
343 |
|
344 |
</DIV> |
345 |
<BR> |
346 |
|
347 |
<DIV CLASS="function"> |
348 |
<A NAME='xml_tag'><!-- --></A> |
349 |
<SPAN CLASS="font12bold">xml_tag</SPAN> |
350 |
<BR> |
351 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
352 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></SPAN> |
353 |
<span class="font10bold" style="color: #0000FF">xml_tag ( $name, [$attributes = array()] )</SPAN> |
354 |
<BR> |
355 |
|
356 |
<BR> |
357 |
<SPAN CLASS="font10bold">Description : </SPAN> |
358 |
<!-- ========== Info from phpDoc block ========= --> |
359 |
This is a simple wrapper function |
360 |
for building XMLTagClass objects |
361 |
<BR> |
362 |
|
363 |
<DL> |
364 |
<DT class="font10bold">Function Parameters:</DT> |
365 |
|
366 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">2</SPAN></SPAN> - any content that lives in the |
367 |
PCDATA portion of the XML tag</DD> |
368 |
|
369 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - the xml tag name</DD> |
370 |
|
371 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> - the name="value" pairs of |
372 |
tag attributes</DD> |
373 |
|
374 |
|
375 |
<DT class="font10bold">Function Info:</DT> |
376 |
|
377 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD> |
378 |
|
379 |
</DL> |
380 |
|
381 |
</DIV> |
382 |
<BR> |
383 |
|
384 |
|
385 |
<br> |
386 |
</HTML> |