1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:24:04 -0800' --> |
6 |
<TITLE>Docs for page xml_utils.inc</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
<!-- Links --> |
11 |
<a NAME="top"></A> |
12 |
<table WIDTH="100%" class="links"> |
13 |
<TR> |
14 |
<TD class="font10"> |
15 |
Links: |
16 |
<A HREF="#classes_summary" class="links" title="Classes created in this file">Classes</A> |
17 |
<A HREF="#includes_summary" class="links" title="Include Statements Summary">Includes</A> |
18 |
<A HREF="#global_summary" class="links" title="Global Variable Summary">Globals</A> |
19 |
<A HREF="#constant_summary" class="links" title="Constant Summary">Constants</A> |
20 |
<A HREF="#function_summary" class="links" title="Function Summary">Functions</A> |
21 |
<A HREF="#includes_detail" class="links" title="Include Statements Detail">Includes Detail</A> |
22 |
<A HREF="#global_detail" class="links" title="Global Variable Detail">Globals Detail</A> |
23 |
<A HREF="#constant_detail" class="links" title="Constant Detail">Constants Detail</A> |
24 |
<A HREF="#function_detail" class="links" title="Function Detail">Functions Detail</A> |
25 |
</TD> |
26 |
</TR> |
27 |
</TABLE> |
28 |
<BR> |
29 |
<h2>File: Program_Root/tag_utils/xml_utils.inc</h2> |
30 |
This file holds helper functions for things related to XMLTagClass objects/data |
31 |
<br /> |
32 |
<p>$Id: _tag_utils_xml_utils_inc.html,v 1.22 2003/02/21 00:44:00 hemna Exp $</p> |
33 |
<UL> |
34 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
35 |
</UL> |
36 |
<!-- =========== Used Classes =========== --> |
37 |
<A NAME='classes_summary'><!-- --></A> |
38 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
39 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
40 |
<TD> |
41 |
<span class="font12bold">Classes defined in this file</span> |
42 |
<A HREF="#top" CLASS="links">^TOP</A> |
43 |
</TD> |
44 |
</TR> |
45 |
</TABLE> |
46 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
47 |
<THEAD> |
48 |
<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR> |
49 |
</THEAD> |
50 |
<TBODY> |
51 |
</TBODY> |
52 |
</TABLE> |
53 |
<br> |
54 |
<!-- =========== Includes SUMMARY =========== --> |
55 |
<A NAME='includes_summary'><!-- --></A> |
56 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
57 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
58 |
<TD> |
59 |
<span CLASS="font12bold">Include Statements Summary</span> |
60 |
<A HREF="#top" CLASS="links">^TOP</A> |
61 |
</TD> |
62 |
</TR> |
63 |
</TABLE> |
64 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
65 |
<THEAD> |
66 |
<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> |
67 |
</THEAD> |
68 |
<TBODY> |
69 |
</TBODY> |
70 |
</TABLE> |
71 |
<br> |
72 |
<br> |
73 |
<!-- =========== GLOBAL VARIABLE SUMMARY =========== --> |
74 |
<A NAME='global_summary'><!-- --></A> |
75 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
76 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
77 |
<TD> |
78 |
<span CLASS="font12bold">Global Variable Summary</span> |
79 |
<A HREF="#top" CLASS="links">^TOP</A> |
80 |
</TD> |
81 |
</TR> |
82 |
</TABLE> |
83 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
84 |
<THEAD> |
85 |
<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> |
86 |
</THEAD> |
87 |
<TBODY> |
88 |
</TBODY> |
89 |
</TABLE> |
90 |
<br> |
91 |
<br> |
92 |
<!-- =========== CONSTANT SUMMARY =========== --> |
93 |
<A NAME='constant_summary'><!-- --></A> |
94 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
95 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
96 |
<TD> |
97 |
<span class="font12bold">Constant Summary</span> |
98 |
<A HREF="#top" CLASS="links">^TOP</A> |
99 |
</TD> |
100 |
</TR> |
101 |
</TABLE> |
102 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
103 |
<THEAD> |
104 |
<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> |
105 |
</THEAD> |
106 |
<TBODY> |
107 |
</TBODY> |
108 |
</TABLE> |
109 |
<br> |
110 |
<br> |
111 |
<!-- =========== FUNCTION SUMMARY =========== --> |
112 |
<A NAME='function_summary'><!-- --></A> |
113 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
114 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
115 |
<TD> |
116 |
<span class="font12bold">Function Summary</span> |
117 |
<A HREF="#top" CLASS="links">^TOP</A> |
118 |
</TD> |
119 |
</TR> |
120 |
|
121 |
<!-- =========== Summary =========== --> |
122 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
123 |
<TD> |
124 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_xml_utils_inc.html#functionarray_to_xml_tree">void array_to_xml_tree ( $arr )</A></B></CODE> |
125 |
<BR> |
126 |
<blockquote> This function converts an array to an xml document. </blockquote> |
127 |
</TD> |
128 |
</TR> |
129 |
<!-- =========== Summary =========== --> |
130 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
131 |
<TD> |
132 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_xml_utils_inc.html#functionxml_doctype"><a href="../phpHtmlLib/DOCTYPEtag.html">DOCTYPEtag</a> xml_doctype ( $doc_element, [$source = "PUBLIC"], [$link1 = NULL], [$link2 = NULL] )</A></B></CODE> |
133 |
<BR> |
134 |
<blockquote> This function is used to build a DOCTYPE tag </blockquote> |
135 |
</TD> |
136 |
</TR> |
137 |
<!-- =========== Summary =========== --> |
138 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
139 |
<TD> |
140 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_xml_utils_inc.html#functionxml_stylesheet"><a href="../phpHtmlLib/XMLSTYLESHEETtag.html">XMLSTYLESHEETtag</a> xml_stylesheet ( $href, [$type = "text/css"] )</A></B></CODE> |
141 |
<BR> |
142 |
<blockquote> This function is used to build an xml-stylesheet tag </blockquote> |
143 |
</TD> |
144 |
</TR> |
145 |
<!-- =========== Summary =========== --> |
146 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
147 |
<TD> |
148 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_xml_utils_inc.html#functionxml_tag"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a> xml_tag ( $name, [$attributes = array()] )</A></B></CODE> |
149 |
<BR> |
150 |
<blockquote> This is a simple wrapper function for building XMLTagClass objects </blockquote> |
151 |
</TD> |
152 |
</TR> |
153 |
</TABLE> |
154 |
<br> |
155 |
<!-- ============ Includes DETAIL =========== --> |
156 |
|
157 |
<A NAME='includes_detail'></A> |
158 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
159 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
160 |
<TD> |
161 |
<span CLASS="font12bold">Include Statements Detail</span> |
162 |
<A HREF="#top" CLASS="links">^TOP</A> |
163 |
</TD> |
164 |
</TR> |
165 |
</TABLE> |
166 |
|
167 |
<br> |
168 |
<!-- ============ GLOBALS DETAIL =========== --> |
169 |
|
170 |
<A NAME='global_detail'></A> |
171 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
172 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
173 |
<TD> |
174 |
<span CLASS="font12bold">Global Variable Detail</span> |
175 |
<A HREF="#top" CLASS="links">^TOP</A> |
176 |
</TD> |
177 |
</TR> |
178 |
</TABLE> |
179 |
|
180 |
<br> |
181 |
<!-- ============ CONSTANT DETAIL =========== --> |
182 |
|
183 |
<A NAME='constant_detail'></A> |
184 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
185 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
186 |
<TD> |
187 |
<span CLASS="font12bold">Constant Detail</span> |
188 |
<A HREF="#top" CLASS="links">^TOP</A> |
189 |
</TD> |
190 |
</TR> |
191 |
</TABLE> |
192 |
|
193 |
<br> |
194 |
<!-- ============ FUNCTION DETAIL =========== --> |
195 |
|
196 |
<A NAME='function_detail'></A> |
197 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
198 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
199 |
<TD> |
200 |
<span class="font12bold">Function Detail</span> |
201 |
<A HREF="#top" CLASS="links">^TOP</A> |
202 |
</TD> |
203 |
</TR> |
204 |
</TABLE> |
205 |
<BR> |
206 |
|
207 |
<DIV CLASS="function"> |
208 |
<A NAME="functionarray_to_xml_tree"><!-- --></A> |
209 |
<SPAN CLASS="font12bold">array_to_xml_tree</SPAN> (line <span class="linenumber">88</span>) |
210 |
<BR> |
211 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
212 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
213 |
<span class="font10bold" style="color: #0000FF">array_to_xml_tree( |
214 |
array $arr, string 1)</SPAN> |
215 |
<BR> |
216 |
<BR> |
217 |
<SPAN CLASS="font10bold">Description : </SPAN> |
218 |
This function converts an array to an xml document. |
219 |
<br /> |
220 |
|
221 |
<DL> |
222 |
<DT class="font10bold">Function Parameters:</DT> |
223 |
<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> |
224 |
<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> |
225 |
|
226 |
<DT class="font10bold">Function Info:</DT> |
227 |
</DL> |
228 |
</DIV> |
229 |
<BR> |
230 |
|
231 |
<DIV CLASS="function"> |
232 |
<A NAME="functionxml_doctype"><!-- --></A> |
233 |
<SPAN CLASS="font12bold">xml_doctype</SPAN> (line <span class="linenumber">50</span>) |
234 |
<BR> |
235 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
236 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/DOCTYPEtag.html">DOCTYPEtag</a></SPAN> |
237 |
<span class="font10bold" style="color: #0000FF">xml_doctype( |
238 |
string $doc_element, [string $source = "PUBLIC"], [string $link1 = NULL], [string $link2 = NULL])</SPAN> |
239 |
<BR> |
240 |
<BR> |
241 |
<SPAN CLASS="font10bold">Description : </SPAN> |
242 |
This function is used to build a DOCTYPE tag |
243 |
<br /> |
244 |
|
245 |
<DL> |
246 |
<DT class="font10bold">Function Parameters:</DT> |
247 |
<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> |
248 |
<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> |
249 |
<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> |
250 |
<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> |
251 |
|
252 |
<DT class="font10bold">Function Info:</DT> |
253 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
254 |
</DL> |
255 |
</DIV> |
256 |
<BR> |
257 |
|
258 |
<DIV CLASS="function"> |
259 |
<A NAME="functionxml_stylesheet"><!-- --></A> |
260 |
<SPAN CLASS="font12bold">xml_stylesheet</SPAN> (line <span class="linenumber">74</span>) |
261 |
<BR> |
262 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
263 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/XMLSTYLESHEETtag.html">XMLSTYLESHEETtag</a></SPAN> |
264 |
<span class="font10bold" style="color: #0000FF">xml_stylesheet( |
265 |
string $href, [string $type = "text/css"])</SPAN> |
266 |
<BR> |
267 |
<BR> |
268 |
<SPAN CLASS="font10bold">Description : </SPAN> |
269 |
This function is used to build an xml-stylesheet tag |
270 |
<br /> |
271 |
|
272 |
<DL> |
273 |
<DT class="font10bold">Function Parameters:</DT> |
274 |
<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> |
275 |
<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> |
276 |
|
277 |
<DT class="font10bold">Function Info:</DT> |
278 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
279 |
</DL> |
280 |
</DIV> |
281 |
<BR> |
282 |
|
283 |
<DIV CLASS="function"> |
284 |
<A NAME="functionxml_tag"><!-- --></A> |
285 |
<SPAN CLASS="font12bold">xml_tag</SPAN> (line <span class="linenumber">29</span>) |
286 |
<BR> |
287 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
288 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></SPAN> |
289 |
<span class="font10bold" style="color: #0000FF">xml_tag( |
290 |
string $name, [array $attributes = array()], mixed 2)</SPAN> |
291 |
<BR> |
292 |
<BR> |
293 |
<SPAN CLASS="font10bold">Description : </SPAN> |
294 |
This is a simple wrapper function for building XMLTagClass objects |
295 |
<br /> |
296 |
|
297 |
<DL> |
298 |
<DT class="font10bold">Function Parameters:</DT> |
299 |
<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 PCDATA portion of the XML tag</DD> |
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">$name</SPAN></SPAN> - the xml tag name</DD> |
301 |
<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 tag attributes</DD> |
302 |
|
303 |
<DT class="font10bold">Function Info:</DT> |
304 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
305 |
</DL> |
306 |
</DIV> |
307 |
<BR> |
308 |
<br> |
309 |
<div id="credit"> |
310 |
<hr> |
311 |
Documention generated on Thu, 20 Feb 2003 16:24:04 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
312 |
</div> |
313 |
</body> |
314 |
</html> |
315 |
</HTML> |