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