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