| 1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!--NewPage--> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<HTML> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<HEAD> |
<head> |
| 5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<TITLE>Docs For Class CSSBuilder</TITLE> |
<title>Docs For Class CSSBuilder</title> |
| 7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 |
</HEAD> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
</head> |
| 10 |
|
<body> |
| 11 |
|
<div class="page-body"> |
| 12 |
<!-- Links --> |
<h2 class="class-name">Class CSSBuilder</h2> |
| 13 |
<a NAME="top"></A> |
|
| 14 |
<table WIDTH="100%" class="links"> |
<a name="sec-description"></a> |
| 15 |
<TR> |
<div class="info-box"> |
| 16 |
<TD class="font10"> |
<div class="info-box-title">Description</div> |
| 17 |
Links: |
<div class="nav-bar"> |
| 18 |
<A HREF="#children_summary" class="links" title="Classes extended from CSSBuilder">Child Classes</A> |
<span class="disabled">Description</span> | |
| 19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<a href="#sec-descendents">Descendents</a> |
| 20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 21 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 22 |
<A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> |
|
| 23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
</div> |
| 24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
<div class="info-box-body"> |
| 25 |
</TD> |
<!-- ========== Info from phpDoc block ========= --> |
| 26 |
</TR> |
<p class="short-description">This class is a widget for constructing and rendering css. It exports API's for adding classes, ids and their attributes.</p> |
| 27 |
</TABLE> |
<p class="description"><p>It can render as either a stand alone foo.css type of file, with the appropriate httpd header, or as part of a <style> tag's content that lives as part of an html document.</p><p>This class lets you create classes in the format</p><p>name extends_list { property: value; }</p><p>ie. #foo div, span { font-family: arial, helvetica; font-size: 10pt; }</p></p> |
| 28 |
<BR> |
<ul class="tags"> |
| 29 |
|
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
| 30 |
<!-- Start of Class Data --> |
</ul> |
| 31 |
<H2> |
<p class="notes"> |
| 32 |
Class CSSBuilder |
Located in <a class="field" href="_widgets_CSSBuilder_inc.html">/widgets/CSSBuilder.inc</a> (line <span class="field">41</span>) |
| 33 |
</H2> |
</p> |
| 34 |
|
|
| 35 |
<pre> |
|
| 36 |
CSSBuilder |
<pre></pre> |
| 37 |
</pre> |
|
| 38 |
|
</div> |
| 39 |
<A NAME="children_summary"</A> |
</div> |
| 40 |
<H3> |
|
| 41 |
Classes extended from CSSBuilder: <A HREF="#top" CLASS="links">^TOP</A> |
<a name="sec-descendents"></a> |
| 42 |
</H3> |
<div class="info-box"> |
| 43 |
<a href="../phpHtmlLib/FooterNavCSS.html">FooterNavCSS</a>, <a href="../phpHtmlLib/ActiveTabCSS.html">ActiveTabCSS</a>, <a href="../phpHtmlLib/InfoTableCSS.html">InfoTableCSS</a>, <a href="../phpHtmlLib/NavTableCSS.html">NavTableCSS</a>, <a href="../phpHtmlLib/TextNavCSS.html">TextNavCSS</a>, <a href="../phpHtmlLib/TextCSSNavCSS.html">TextCSSNavCSS</a>, <a href="../phpHtmlLib/VerticalCSSNavTableCSS.html">VerticalCSSNavTableCSS</a>, <a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html">ImageThumbnailWidgetCSS</a>, <a href="../phpHtmlLib/DefaultGUIDataListCSS.html">DefaultGUIDataListCSS</a> |
<div class="info-box-title">Direct descendents</div> |
| 44 |
<p> |
<div class="nav-bar"> |
| 45 |
<b><i>Located in File: Program_Root/widgets/CSSBuilder.inc</i></b><br> |
<a href="#sec-description">Description</a> | |
| 46 |
</p> |
<span class="disabled">Descendents</span> |
| 47 |
<hr> |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 48 |
<!-- ========== Info from phpDoc block ========= --> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 49 |
This class is a widget for constructing and |
|
| 50 |
rendering css. |
</div> |
| 51 |
<BR> |
<div class="info-box-body"> |
| 52 |
It exports API's for adding |
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 53 |
classes, ids and their attributes. |
<tr> |
| 54 |
It can render as either a stand alone |
<th class="class-table-header">Class</th> |
| 55 |
foo.css type of file, with the appropriate |
<th class="class-table-header">Description</th> |
| 56 |
httpd header, or as part of a <style> tag's |
</tr> |
| 57 |
content that lives as part of an html document. |
<tr> |
| 58 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ActiveTabCSS.html">ActiveTabCSS</a></td> |
| 59 |
This class lets you create classes in the format |
<td> |
| 60 |
|
The CSSBuilder object for the ActiveTab widget |
| 61 |
name extends_list { |
</td> |
| 62 |
property: value; |
</tr> |
| 63 |
} |
<tr> |
| 64 |
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/ButtonPanelCSS.html">ButtonPanelCSS</a></td> |
| 65 |
|
<td> |
| 66 |
ie. |
This class defines the css used by the FooterNav Object. |
| 67 |
#foo div, span { |
</td> |
| 68 |
font-family: arial, helvetica; |
</tr> |
| 69 |
font-size: 10pt; |
<tr> |
| 70 |
} |
<td style="padding-right: 2em"><a href="../phpHtmlLib/FooterNavCSS.html">FooterNavCSS</a></td> |
| 71 |
|
<td> |
| 72 |
<UL> |
This class defines the css used by the FooterNav Object. |
| 73 |
|
</td> |
| 74 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
</tr> |
| 75 |
|
<tr> |
| 76 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html">ImageThumbnailWidgetCSS</a></td> |
| 77 |
|
<td> |
| 78 |
</UL> |
This class defines the css used by the FooterNav Object. |
| 79 |
|
</td> |
| 80 |
<hr> |
</tr> |
| 81 |
<!-- =========== VAR SUMMARY =========== --> |
<tr> |
| 82 |
<A NAME='var_summary'><!-- --></A> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/InfoTableCSS.html">InfoTableCSS</a></td> |
| 83 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<td> |
| 84 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
This class defines the css used by the FooterNav Object. |
| 85 |
<TD> |
</td> |
| 86 |
<span CLASS="font12bold">Class Variable Summary</span> |
</tr> |
| 87 |
<A HREF="#top" CLASS="links">^TOP</A> |
<tr> |
| 88 |
</TD> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/NavTableCSS.html">NavTableCSS</a></td> |
| 89 |
</TR> |
<td> |
| 90 |
|
This class defines the css used by the FooterNav Object. |
| 91 |
|
</td> |
| 92 |
<!-- =========== Summary =========== --> |
</tr> |
| 93 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<tr> |
| 94 |
<TD> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/RoundTitleTableCSS.html">RoundTitleTableCSS</a></td> |
| 95 |
<CODE><B><A HREF='CSSBuilder.html#$indent_flag'>$indent_flag</A></B></CODE> |
<td> |
| 96 |
<BR> |
This class defines the css used by the RoundTitleTable Object. |
| 97 |
<blockquote> Flag for pretty (indented) output </blockquote> |
</td> |
| 98 |
<blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote> |
</tr> |
| 99 |
</TD> |
<tr> |
| 100 |
</TR> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/TabListCSS.html">TabListCSS</a></td> |
| 101 |
|
<td> |
| 102 |
<!-- =========== Summary =========== --> |
This class defines the css used by the FooterNav Object. |
| 103 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</td> |
| 104 |
<TD> |
</tr> |
| 105 |
<CODE><B><A HREF='CSSBuilder.html#$_entries'>$_entries</A></B></CODE> |
<tr> |
| 106 |
<BR> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/TextCSSNavCSS.html">TextCSSNavCSS</a></td> |
| 107 |
<blockquote> This holds the entries for the css </blockquote> |
<td> |
| 108 |
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
This class defines the css used by the FooterNav Object. |
| 109 |
</TD> |
</td> |
| 110 |
</TR> |
</tr> |
| 111 |
|
<tr> |
| 112 |
<!-- =========== Summary =========== --> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/TextNavCSS.html">TextNavCSS</a></td> |
| 113 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<td> |
| 114 |
<TD> |
This class defines the css used by the TextNav Object. |
| 115 |
<CODE><B><A HREF='CSSBuilder.html#$_header_flag'>$_header_flag</A></B></CODE> |
</td> |
| 116 |
<BR> |
</tr> |
| 117 |
<blockquote> Flag to let us know if we should </blockquote> |
<tr> |
| 118 |
<blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/VerticalCSSNavTableCSS.html">VerticalCSSNavTableCSS</a></td> |
| 119 |
</TD> |
<td> |
| 120 |
</TR> |
This class defines the css used by the VerticalCSSNavTable Object. |
| 121 |
|
</td> |
| 122 |
</TABLE> |
</tr> |
| 123 |
|
<tr> |
| 124 |
<hr> |
<td style="padding-right: 2em"><a href="../phpHtmlLib/DefaultGUIDataListCSS.html">DefaultGUIDataListCSS</a></td> |
| 125 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
<td> |
| 126 |
<A NAME='var_inherited_summary'><!-- --></A> |
This class defines the css used by the FooterNav Object. |
| 127 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</td> |
| 128 |
<TR CLASS='TableHeadingColor'> |
</tr> |
| 129 |
<TD> |
</table> |
| 130 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
</div> |
| 131 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
| 132 |
</TD> |
|
| 133 |
</TR> |
|
| 134 |
|
<a name="sec-var-summary"></a> |
| 135 |
|
<div class="info-box"> |
| 136 |
</TABLE> |
<div class="info-box-title">Variable Summary</span></div> |
| 137 |
|
<div class="nav-bar"> |
| 138 |
<hr> |
<a href="#sec-description">Description</a> | |
| 139 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
<a href="#sec-descendents">Descendents</a> | |
| 140 |
<A NAME='functions_inherited'><!-- --></A> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 141 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| |
| 142 |
<TR CLASS='TableHeadingColor'> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 143 |
<TD> |
|
| 144 |
<span CLASS="font12bold">Inherited Method Summary</span> |
</div> |
| 145 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="info-box-body"> |
| 146 |
</TD> |
<div class="var-summary"> |
| 147 |
</TR> |
<div class="var-title"> |
| 148 |
|
<span class="var-type">boolean</span> |
| 149 |
|
<a href="#$indent_flag" title="details" class="var-name">$indent_flag</a> |
| 150 |
</TABLE> |
</div> |
| 151 |
|
<div class="var-title"> |
| 152 |
<hr> |
<span class="var-type">array</span> |
| 153 |
<!-- should have constructor at some point --> |
<a href="#$_entries" title="details" class="var-name">$_entries</a> |
| 154 |
<!-- =========== Method SUMMARY =========== --> |
</div> |
| 155 |
<A NAME='Method_summary'><!-- --></A> |
<div class="var-title"> |
| 156 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
<span class="var-type">boolean</span> |
| 157 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<a href="#$_header_flag" title="details" class="var-name">$_header_flag</a> |
| 158 |
<TD> |
</div> |
| 159 |
<span class="font12bold">Method Summary</span> |
</div> |
| 160 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
| 161 |
</TD> |
</div> |
| 162 |
</TR> |
|
| 163 |
|
<a name="sec-method-summary"></a> |
| 164 |
|
<div class="info-box"> |
| 165 |
<!-- =========== Summary =========== --> |
<div class="info-box-title">Method Summary</span></div> |
| 166 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="nav-bar"> |
| 167 |
<TD> |
<a href="#sec-description">Description</a> | |
| 168 |
<CODE><B><A HREF='CSSBuilder.html#constructor CSSBuilder'>void constructor CSSBuilder ( [$header_flag = FALSE] )</A></B></CODE> |
<a href="#sec-descendents">Descendents</a> | |
| 169 |
<BR> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 170 |
<blockquote> The CSSBuilder constructor </blockquote> |
|
| 171 |
</TD> |
| |
| 172 |
</TR> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 173 |
|
</div> |
| 174 |
<!-- =========== Summary =========== --> |
<div class="info-box-body"> |
| 175 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-summary"> |
| 176 |
<TD> |
|
| 177 |
<CODE><B><A HREF='CSSBuilder.html#add_entry'>void add_entry ( $name, $extends, $attributes )</A></B></CODE> |
<div class="method-definition"> |
| 178 |
<BR> |
<span class="method-result">CSSBuilder</span> |
| 179 |
<blockquote> This function adds a new class entry </blockquote> |
<a href="#CSSBuilder" title="details" class="method-name">CSSBuilder</a> |
| 180 |
</TD> |
([<span class="var-type">boolean</span> <span class="var-name">$header_flag</span> = <span class="var-default">FALSE</span>]) |
| 181 |
</TR> |
</div> |
| 182 |
|
|
| 183 |
<!-- =========== Summary =========== --> |
<div class="method-definition"> |
| 184 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-result">void</span> |
| 185 |
<TD> |
<a href="#add_entry" title="details" class="method-name">add_entry</a> |
| 186 |
<CODE><B><A HREF='CSSBuilder.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$attributes</span>) |
| 187 |
<BR> |
</div> |
| 188 |
<blockquote> The render method for compatibility |
|
| 189 |
with the rest of the phphtmllib api </blockquote> |
<div class="method-definition"> |
| 190 |
</TD> |
<span class="method-result">string</span> |
| 191 |
</TR> |
<a href="#render" title="details" class="method-name">render</a> |
| 192 |
|
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
| 193 |
<!-- =========== Summary =========== --> |
</div> |
| 194 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
| 195 |
<TD> |
<div class="method-definition"> |
| 196 |
<CODE><B><A HREF='CSSBuilder.html#set_header_flag'>void set_header_flag ( $flag )</A></B></CODE> |
<span class="method-result">void</span> |
| 197 |
<BR> |
<a href="#set_header_flag" title="details" class="method-name">set_header_flag</a> |
| 198 |
<blockquote> This is used to set/update the header |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
| 199 |
flag. </blockquote> |
</div> |
| 200 |
</TD> |
|
| 201 |
</TR> |
<div class="method-definition"> |
| 202 |
|
<span class="method-result">void</span> |
| 203 |
<!-- =========== Summary =========== --> |
<a href="#update_all_values" title="details" class="method-name">update_all_values</a> |
| 204 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
(<span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$search</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
| 205 |
<TD> |
</div> |
| 206 |
<CODE><B><A HREF='CSSBuilder.html#update_all_values'>void update_all_values ( $property, $search, $value )</A></B></CODE> |
|
| 207 |
<BR> |
<div class="method-definition"> |
| 208 |
<blockquote> This function is a macro for walking the entire |
<span class="method-result">void</span> |
| 209 |
list of classes, looking for particular property |
<a href="#update_properties" title="details" class="method-name">update_properties</a> |
| 210 |
in each class. </blockquote> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$properties</span>) |
| 211 |
</TD> |
</div> |
| 212 |
</TR> |
|
| 213 |
|
<div class="method-definition"> |
| 214 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
| 215 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a href="#update_property" title="details" class="method-name">update_property</a> |
| 216 |
<TD> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
| 217 |
<CODE><B><A HREF='CSSBuilder.html#update_properties'>void update_properties ( $name, $extends, $properties )</A></B></CODE> |
</div> |
| 218 |
<BR> |
|
| 219 |
<blockquote> This function updates a css property value |
<div class="method-definition"> |
| 220 |
for a specific class/id </blockquote> |
<span class="method-result">void</span> |
| 221 |
</TD> |
<a href="#user_setup" title="details" class="method-name">user_setup</a> |
| 222 |
</TR> |
() |
| 223 |
|
</div> |
| 224 |
<!-- =========== Summary =========== --> |
|
| 225 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-definition"> |
| 226 |
<TD> |
<span class="method-result">the</span> |
| 227 |
<CODE><B><A HREF='CSSBuilder.html#update_property'>void update_property ( $name, $extends, $property, $value )</A></B></CODE> |
<a href="#_build_name" title="details" class="method-name">_build_name</a> |
| 228 |
<BR> |
(<span class="var-type">string</span> <span class="var-name">$class</span>) |
| 229 |
<blockquote> This function updates a css property value |
</div> |
| 230 |
for a specific class/id </blockquote> |
|
| 231 |
</TD> |
<div class="method-definition"> |
| 232 |
</TR> |
<span class="method-result">string</span> |
| 233 |
|
<a href="#_build_properties" title="details" class="method-name">_build_properties</a> |
| 234 |
<!-- =========== Summary =========== --> |
(<span class="var-type">array</span> <span class="var-name">$properties</span>, <span class="var-type">array</span> <span class="var-name">$indent_str</span>) |
| 235 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
| 236 |
<TD> |
|
| 237 |
<CODE><B><A HREF='CSSBuilder.html#user_setup'>void user_setup ( )</A></B></CODE> |
<div class="method-definition"> |
| 238 |
<BR> |
<span class="method-result">void</span> |
| 239 |
<blockquote> Call the child class' setup function </blockquote> |
<a href="#_replace_value" title="details" class="method-name">_replace_value</a> |
| 240 |
</TD> |
(<span class="var-type">mixed</span> <span class="var-name">&$item</span>, <span class="var-type">mixed</span> <span class="var-name">$key</span>, <span class="var-type">mixed</span> <span class="var-name">$blah</span>) |
| 241 |
</TR> |
</div> |
| 242 |
|
</div> |
| 243 |
<!-- =========== Summary =========== --> |
</div> |
| 244 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
| 245 |
<TD> |
|
| 246 |
<CODE><B><A HREF='CSSBuilder.html#_build_name'>the _build_name ( $class )</A></B></CODE> |
<a name="sec-vars"></a> |
| 247 |
<BR> |
<div class="info-box"> |
| 248 |
<blockquote> This function is used to construct the css name |
<div class="info-box-title">Variables</div> |
| 249 |
declaration string. </blockquote> |
<div class="nav-bar"> |
| 250 |
</TD> |
<a href="#sec-description">Description</a> | |
| 251 |
</TR> |
<a href="#sec-descendents">Descendents</a> | |
| 252 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 253 |
<!-- =========== Summary =========== --> |
|
| 254 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
| 255 |
<TD> |
| |
| 256 |
<CODE><B><A HREF='CSSBuilder.html#_build_properties'>string _build_properties ( $properties, $indent_str )</A></B></CODE> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 257 |
<BR> |
|
| 258 |
<blockquote> This function is used to construct the |
</div> |
| 259 |
property: value strings for the class </blockquote> |
<div class="info-box-body"> |
| 260 |
</TD> |
<a name="var$indent_flag" id="$indent_flag"><!-- --></A> |
| 261 |
</TR> |
<div class="oddrow"> |
| 262 |
|
|
| 263 |
<!-- =========== Summary =========== --> |
<div class="var-header"> |
| 264 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-title"> |
| 265 |
<TD> |
<span class="var-type">boolean</span> |
| 266 |
<CODE><B><A HREF='CSSBuilder.html#_replace_value'>void _replace_value ( &$item, $key, $blah )</A></B></CODE> |
<span class="var-name">$indent_flag</span> |
| 267 |
<BR> |
= <span class="var-default"> TRUE</span> (line <span class="line-number">75</span>) |
| 268 |
<blockquote> This function does the main work for update_all_values </blockquote> |
</span> |
| 269 |
</TD> |
</div> |
| 270 |
</TR> |
|
| 271 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 272 |
</TABLE> |
<p class="short-description">Flag for pretty (indented) output</p> |
| 273 |
|
<ul class="tags"> |
| 274 |
<hr> |
<li><span class="field">access:</span> public</li> |
| 275 |
<!-- ============ VARIABLE DETAIL =========== --> |
</ul> |
| 276 |
|
|
| 277 |
<A NAME='variable_detail'></A> |
|
| 278 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
| 279 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
| 280 |
<TD> |
|
| 281 |
<span CLASS="font12bold">Variable Detail</span> |
</div> |
| 282 |
<A HREF="#top" CLASS="links">^TOP</A> |
<a name="var$_entries" id="$_entries"><!-- --></A> |
| 283 |
</TD> |
<div class="evenrow"> |
| 284 |
</TR> |
|
| 285 |
</TABLE> |
<div class="var-header"> |
| 286 |
|
<span class="var-title"> |
| 287 |
|
<span class="var-type">array</span> |
| 288 |
<A NAME='$indent_flag'><!-- --></A><H3>$indent_flag</H3> |
<span class="var-name">$_entries</span> |
| 289 |
<b>Data type:</b> boolean<br> |
= <span class="var-default">array()</span> (line <span class="line-number">49</span>) |
| 290 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
| 291 |
Flag for pretty (indented) output |
</div> |
| 292 |
<BR> |
|
| 293 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 294 |
|
<p class="short-description">This holds the entries for the css</p> |
| 295 |
<UL> |
|
| 296 |
|
|
| 297 |
<LI><b>Access</b> - <CODE>public</CODE></LI> |
|
| 298 |
|
|
| 299 |
</UL> |
|
| 300 |
|
</div> |
| 301 |
<HR> |
<a name="var$_header_flag" id="$_header_flag"><!-- --></A> |
| 302 |
|
<div class="oddrow"> |
| 303 |
<A NAME='$_entries'><!-- --></A><H3>$_entries</H3> |
|
| 304 |
<b>Data type:</b> array<br> |
<div class="var-header"> |
| 305 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-title"> |
| 306 |
This holds the entries for the css |
<span class="var-type">boolean</span> |
| 307 |
<BR> |
<span class="var-name">$_header_flag</span> |
| 308 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">59</span>) |
| 309 |
|
</span> |
| 310 |
<UL> |
</div> |
| 311 |
|
|
| 312 |
</UL> |
<!-- ========== Info from phpDoc block ========= --> |
| 313 |
|
<p class="short-description">Flag to let us know if we should output a header content-type value header("Content-Type: text/css");</p> |
| 314 |
<HR> |
|
| 315 |
|
|
| 316 |
<A NAME='$_header_flag'><!-- --></A><H3>$_header_flag</H3> |
|
| 317 |
<b>Data type:</b> boolean<br> |
|
| 318 |
<!-- ========== Info from phpDoc block ========= --> |
|
| 319 |
Flag to let us know if we should |
</div> |
| 320 |
<BR> |
|
| 321 |
output a header content-type value |
</div> |
| 322 |
header("Content-Type: text/css"); |
</div> |
| 323 |
|
|
| 324 |
<UL> |
<a name="sec-methods"></a> |
| 325 |
|
<div class="info-box"> |
| 326 |
</UL> |
<div class="info-box-title">Methods</div> |
| 327 |
|
<div class="nav-bar"> |
| 328 |
<HR> |
<a href="#sec-description">Description</a> | |
| 329 |
|
<a href="#sec-descendents">Descendents</a> | |
| 330 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 331 |
<hr> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 332 |
<!-- ============ FUNCTION DETAIL =========== --> |
|
| 333 |
|
</div> |
| 334 |
<A NAME='function_detail'></A> |
<div class="info-box-body"> |
| 335 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<A NAME='method_detail'></A> |
| 336 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<a name="methodCSSBuilder" id="CSSBuilder"><!-- --></a> |
| 337 |
<TD> |
<div class="evenrow"> |
| 338 |
<span class="font12bold">Method Detail</span> |
|
| 339 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="method-header"> |
| 340 |
</TD> |
<span class="method-title">Constructor CSSBuilder</span> (line <span class="line-number">86</span>) |
| 341 |
</TR> |
</div> |
| 342 |
</TABLE> |
|
| 343 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
| 344 |
|
<p class="short-description">The CSSBuilder constructor</p> |
| 345 |
<DIV CLASS="function"> |
|
| 346 |
<A NAME='constructor CSSBuilder'><!-- --></A> |
<div class="method-signature"> |
| 347 |
<SPAN CLASS="font12bold">constructor CSSBuilder</SPAN> |
<span class="method-result">CSSBuilder</span> |
| 348 |
<BR> |
<span class="method-name"> |
| 349 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
CSSBuilder |
| 350 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</span> |
| 351 |
<span class="font10bold" style="color: #0000FF">constructor CSSBuilder ( [$header_flag = FALSE] )</SPAN> |
([<span class="var-type">boolean</span> <span class="var-name">$header_flag</span> = <span class="var-default">FALSE</span>]) |
| 352 |
<BR> |
</div> |
| 353 |
|
|
| 354 |
<BR> |
<ul class="parameters"> |
| 355 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
| 356 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-type">boolean</span> |
| 357 |
The CSSBuilder constructor |
<span class="var-name">$header_flag</span><span class="var-description">: - output the http header content type mime type or not.</span> </li> |
| 358 |
<BR> |
</ul> |
| 359 |
|
|
| 360 |
<DL> |
|
| 361 |
<DT class="font10bold">Function Parameters:</DT> |
</div> |
| 362 |
|
<a name="methodadd_entry" id="add_entry"><!-- --></a> |
| 363 |
<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">$header_flag</SPAN></SPAN> - output the http header |
<div class="oddrow"> |
| 364 |
content type mime type |
|
| 365 |
or not.</DD> |
<div class="method-header"> |
| 366 |
|
<span class="method-title">add_entry</span> (line <span class="line-number">189</span>) |
| 367 |
|
</div> |
| 368 |
<DT class="font10bold">Function Info:</DT> |
|
| 369 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 370 |
</DL> |
<p class="short-description">This function adds a new class entry</p> |
| 371 |
|
|
| 372 |
</DIV> |
<div class="method-signature"> |
| 373 |
<BR> |
<span class="method-result">void</span> |
| 374 |
|
<span class="method-name"> |
| 375 |
<DIV CLASS="function"> |
add_entry |
| 376 |
<A NAME='add_entry'><!-- --></A> |
</span> |
| 377 |
<SPAN CLASS="font12bold">add_entry</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$attributes</span>) |
| 378 |
<BR> |
</div> |
| 379 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
| 380 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<ul class="parameters"> |
| 381 |
<span class="font10bold" style="color: #0000FF">add_entry ( $name, $extends, $attributes )</SPAN> |
<li> |
| 382 |
<BR> |
<span class="var-type">string</span> |
| 383 |
|
<span class="var-name">$name</span><span class="var-description">: - class/id name</span> </li> |
| 384 |
<BR> |
<li> |
| 385 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-type">string</span> |
| 386 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-name">$extends</span><span class="var-description">: - the list of extends ie #foo div, a { } where "div, a" are the extends</span> </li> |
| 387 |
This function adds a new class entry |
<li> |
| 388 |
<BR> |
<span class="var-type">array</span> |
| 389 |
|
<span class="var-name">$attributes</span><span class="var-description">: - the attributes</span> </li> |
| 390 |
<DL> |
</ul> |
| 391 |
<DT class="font10bold">Function Parameters:</DT> |
|
| 392 |
|
|
| 393 |
<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> - class/id name</DD> |
</div> |
| 394 |
|
<a name="methodrender" id="render"><!-- --></a> |
| 395 |
<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">$extends</SPAN></SPAN> - the list of extends |
<div class="evenrow"> |
| 396 |
ie #foo div, a { } |
|
| 397 |
where "div, a" are the extends</DD> |
<div class="method-header"> |
| 398 |
|
<span class="method-title">render</span> (line <span class="line-number">103</span>) |
| 399 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> - the attributes</DD> |
</div> |
| 400 |
|
|
| 401 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 402 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">The render method for compatibility with the rest of the phphtmllib api</p> |
| 403 |
|
<ul class="tags"> |
| 404 |
</DL> |
<li><span class="field">return:</span> the raw html output.</li> |
| 405 |
|
</ul> |
| 406 |
</DIV> |
|
| 407 |
<BR> |
<div class="method-signature"> |
| 408 |
|
<span class="method-result">string</span> |
| 409 |
<DIV CLASS="function"> |
<span class="method-name"> |
| 410 |
<A NAME='render'><!-- --></A> |
render |
| 411 |
<SPAN CLASS="font12bold">render</SPAN> |
</span> |
| 412 |
<BR> |
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
| 413 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
| 414 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
| 415 |
<span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN> |
<ul class="parameters"> |
| 416 |
<BR> |
<li> |
| 417 |
|
<span class="var-type">int</span> |
| 418 |
<BR> |
<span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li> |
| 419 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
| 420 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="var-type">int</span> |
| 421 |
The render method for compatibility |
<span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li> |
| 422 |
with the rest of the phphtmllib api |
</ul> |
| 423 |
<BR> |
|
| 424 |
|
|
| 425 |
<DL> |
</div> |
| 426 |
<DT class="font10bold">Function Parameters:</DT> |
<a name="methodset_header_flag" id="set_header_flag"><!-- --></a> |
| 427 |
|
<div class="oddrow"> |
| 428 |
<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 |
|
| 429 |
the container.</DD> |
<div class="method-header"> |
| 430 |
|
<span class="method-title">set_header_flag</span> (line <span class="line-number">127</span>) |
| 431 |
<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">$output_debug</SPAN></SPAN> - the output debug flag to |
</div> |
| 432 |
maintain compatibility w/ the API.</DD> |
|
| 433 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 434 |
|
<p class="short-description">This is used to set/update the header flag.</p> |
| 435 |
<DT class="font10bold">Function Info:</DT> |
|
| 436 |
|
<div class="method-signature"> |
| 437 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD> |
<span class="method-result">void</span> |
| 438 |
|
<span class="method-name"> |
| 439 |
</DL> |
set_header_flag |
| 440 |
|
</span> |
| 441 |
</DIV> |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
| 442 |
<BR> |
</div> |
| 443 |
|
|
| 444 |
<DIV CLASS="function"> |
<ul class="parameters"> |
| 445 |
<A NAME='set_header_flag'><!-- --></A> |
<li> |
| 446 |
<SPAN CLASS="font12bold">set_header_flag</SPAN> |
<span class="var-type">boolean</span> |
| 447 |
<BR> |
<span class="var-name">$flag</span> </li> |
| 448 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</ul> |
| 449 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
| 450 |
<span class="font10bold" style="color: #0000FF">set_header_flag ( $flag )</SPAN> |
|
| 451 |
<BR> |
</div> |
| 452 |
|
<a name="methodupdate_all_values" id="update_all_values"><!-- --></a> |
| 453 |
<BR> |
<div class="evenrow"> |
| 454 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
| 455 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-header"> |
| 456 |
This is used to set/update the header |
<span class="method-title">update_all_values</span> (line <span class="line-number">244</span>) |
| 457 |
flag. |
</div> |
| 458 |
<BR> |
|
| 459 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 460 |
<DL> |
<p class="short-description">This function is a macro for walking the entire</p> |
| 461 |
<DT class="font10bold">Function Parameters:</DT> |
<p class="description"><p>list of classes, looking for particular property in each class. It then tries to match the current value of that property and then replaces the value with the new value.</p><p>NOTE: this is a way of templating themes. you create the original css w/ a value of something like _DARK_COLOR_ and use this function to replace all occurrences with #dbdbdb</p></p> |
| 462 |
|
|
| 463 |
<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-signature"> |
| 464 |
|
<span class="method-result">void</span> |
| 465 |
|
<span class="method-name"> |
| 466 |
<DT class="font10bold">Function Info:</DT> |
update_all_values |
| 467 |
|
</span> |
| 468 |
</DL> |
(<span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$search</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
| 469 |
|
</div> |
| 470 |
</DIV> |
|
| 471 |
<BR> |
<ul class="parameters"> |
| 472 |
|
<li> |
| 473 |
<DIV CLASS="function"> |
<span class="var-type">string</span> |
| 474 |
<A NAME='update_all_values'><!-- --></A> |
<span class="var-name">$property</span><span class="var-description">: - the property that the search lives in</span> </li> |
| 475 |
<SPAN CLASS="font12bold">update_all_values</SPAN> |
<li> |
| 476 |
<BR> |
<span class="var-type">string</span> |
| 477 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="var-name">$search</span><span class="var-description">: - the original value to find</span> </li> |
| 478 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<li> |
| 479 |
<span class="font10bold" style="color: #0000FF">update_all_values ( $property, $search, $value )</SPAN> |
<span class="var-type">string</span> |
| 480 |
<BR> |
<span class="var-name">$value</span><span class="var-description">: - the new value</span> </li> |
| 481 |
|
</ul> |
| 482 |
<BR> |
|
| 483 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
| 484 |
<!-- ========== Info from phpDoc block ========= --> |
</div> |
| 485 |
This function is a macro for walking the entire |
<a name="methodupdate_properties" id="update_properties"><!-- --></a> |
| 486 |
list of classes, looking for particular property |
<div class="oddrow"> |
| 487 |
in each class. |
|
| 488 |
<BR> |
<div class="method-header"> |
| 489 |
It then tries to match |
<span class="method-title">update_properties</span> (line <span class="line-number">219</span>) |
| 490 |
the current value of that property and then |
</div> |
| 491 |
replaces the value with the new value. |
|
| 492 |
|
<!-- ========== Info from phpDoc block ========= --> |
| 493 |
NOTE: this is a way of templating themes. |
<p class="short-description">This function updates a css property value for a specific class/id</p> |
| 494 |
you create the original css w/ a value |
|
| 495 |
of something like _DARK_COLOR_ |
<div class="method-signature"> |
| 496 |
and use this function to replace all occurrences |
<span class="method-result">void</span> |
| 497 |
with #dbdbdb |
<span class="method-name"> |
| 498 |
<DL> |
update_properties |
| 499 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
| 500 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$properties</span>) |
| 501 |
<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">$property</SPAN></SPAN> - the property that the search lives in</DD> |
</div> |
| 502 |
|
|
| 503 |
<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">$search</SPAN></SPAN> - the original value to find</DD> |
<ul class="parameters"> |
| 504 |
|
<li> |
| 505 |
<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 new value</DD> |
<span class="var-type">string</span> |
| 506 |
|
<span class="var-name">$name</span><span class="var-description">: - the class/id name</span> </li> |
| 507 |
|
<li> |
| 508 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-type">string</span> |
| 509 |
|
<span class="var-name">$extends</span><span class="var-description">: - the list of extends ie #foo div, a { } where "div, a" are the extends</span> </li> |
| 510 |
</DL> |
<li> |
| 511 |
|
<span class="var-type">array</span> |
| 512 |
</DIV> |
<span class="var-name">$properties</span><span class="var-description">: - the array of array(property => value ) pairs.</span> </li> |
| 513 |
<BR> |
</ul> |
| 514 |
|
|
| 515 |
<DIV CLASS="function"> |
|
| 516 |
<A NAME='update_properties'><!-- --></A> |
</div> |
| 517 |
<SPAN CLASS="font12bold">update_properties</SPAN> |
<a name="methodupdate_property" id="update_property"><!-- --></a> |
| 518 |
<BR> |
<div class="evenrow"> |
| 519 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
| 520 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="method-header"> |
| 521 |
<span class="font10bold" style="color: #0000FF">update_properties ( $name, $extends, $properties )</SPAN> |
<span class="method-title">update_property</span> (line <span class="line-number">205</span>) |
| 522 |
<BR> |
</div> |
| 523 |
|
|
| 524 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
| 525 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<p class="short-description">This function updates a css property value for a specific class/id</p> |
| 526 |
<!-- ========== Info from phpDoc block ========= --> |
|
| 527 |
This function updates a css property value |
<div class="method-signature"> |
| 528 |
for a specific class/id |
<span class="method-result">void</span> |
| 529 |
<BR> |
<span class="method-name"> |
| 530 |
|
update_property |
| 531 |
<DL> |
</span> |
| 532 |
<DT class="font10bold">Function Parameters:</DT> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) |
| 533 |
|
</div> |
| 534 |
<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 class/id name</DD> |
|
| 535 |
|
<ul class="parameters"> |
| 536 |
<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">$extends</SPAN></SPAN> - the list of extends |
<li> |
| 537 |
ie #foo div, a { } |
<span class="var-type">string</span> |
| 538 |
where "div, a" are the extends</DD> |
<span class="var-name">$name</span><span class="var-description">: - the class/id name</span> </li> |
| 539 |
|
<li> |
| 540 |
<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">$properties</SPAN></SPAN> - the array of array(property => value ) pairs.</DD> |
<span class="var-type">string</span> |
| 541 |
|
<span class="var-name">$extends</span><span class="var-description">: - the list of extends ie #foo div, a { } where "div, a" are the extends</span> </li> |
| 542 |
|
<li> |
| 543 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-type">string</span> |
| 544 |
|
<span class="var-name">$property</span><span class="var-description">: - the property to adjust</span> </li> |
| 545 |
</DL> |
<li> |
| 546 |
|
<span class="var-type">string</span> |
| 547 |
</DIV> |
<span class="var-name">$value</span><span class="var-description">: - the value for the property</span> </li> |
| 548 |
<BR> |
</ul> |
| 549 |
|
|
| 550 |
<DIV CLASS="function"> |
|
| 551 |
<A NAME='update_property'><!-- --></A> |
</div> |
| 552 |
<SPAN CLASS="font12bold">update_property</SPAN> |
<a name="methoduser_setup" id="user_setup"><!-- --></a> |
| 553 |
<BR> |
<div class="oddrow"> |
| 554 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
| 555 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<div class="method-header"> |
| 556 |
<span class="font10bold" style="color: #0000FF">update_property ( $name, $extends, $property, $value )</SPAN> |
<span class="method-title">user_setup</span> (line <span class="line-number">136</span>) |
| 557 |
<BR> |
</div> |
| 558 |
|
|
| 559 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
| 560 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<p class="short-description">Call the child class' setup function</p> |
| 561 |
<!-- ========== Info from phpDoc block ========= --> |
<p class="description"><p>to build the actual css classes and their attributes</p></p> |
| 562 |
This function updates a css property value |
|
| 563 |
for a specific class/id |
<div class="method-signature"> |
| 564 |
<BR> |
<span class="method-result">void</span> |
| 565 |
|
<span class="method-name"> |
| 566 |
<DL> |
user_setup |
| 567 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
| 568 |
|
() |
| 569 |
<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 class/id name</DD> |
</div> |
| 570 |
|
|
| 571 |
<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">$extends</SPAN></SPAN> - the list of extends |
|
| 572 |
ie #foo div, a { } |
|
| 573 |
where "div, a" are the extends</DD> |
<hr class="separator" /> |
| 574 |
|
<div class="notes">Redefined in descendants as:</div> |
| 575 |
<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">$property</SPAN></SPAN> - the property to adjust</DD> |
<ul class="redefinitions"> |
| 576 |
|
<li> |
| 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">$value</SPAN></SPAN> - the value for the property</DD> |
<a href="../phpHtmlLib/ActiveTabCSS.html#methoduser_setup">ActiveTabCSS::user_setup()</a> |
| 578 |
|
</li> |
| 579 |
|
<li> |
| 580 |
<DT class="font10bold">Function Info:</DT> |
<a href="../phpHtmlLib/ButtonPanelCSS.html#methoduser_setup">ButtonPanelCSS::user_setup()</a> |
| 581 |
|
</li> |
| 582 |
</DL> |
<li> |
| 583 |
|
<a href="../phpHtmlLib/FooterNavCSS.html#methoduser_setup">FooterNavCSS::user_setup()</a> |
| 584 |
</DIV> |
</li> |
| 585 |
<BR> |
<li> |
| 586 |
|
<a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html#methoduser_setup">ImageThumbnailWidgetCSS::user_setup()</a> |
| 587 |
<DIV CLASS="function"> |
</li> |
| 588 |
<A NAME='user_setup'><!-- --></A> |
<li> |
| 589 |
<SPAN CLASS="font12bold">user_setup</SPAN> |
<a href="../phpHtmlLib/InfoTableCSS.html#methoduser_setup">InfoTableCSS::user_setup()</a> |
| 590 |
<BR> |
</li> |
| 591 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<li> |
| 592 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<a href="../phpHtmlLib/NavTableCSS.html#methoduser_setup">NavTableCSS::user_setup()</a> |
| 593 |
<span class="font10bold" style="color: #0000FF">user_setup ( )</SPAN> |
</li> |
| 594 |
<BR> |
<li> |
| 595 |
Overridden in child class(es) as: <a href="../phpHtmlLib/FooterNavCSS.html#user_setup">FooterNavCSS::user_setup()</a>, <a href="../phpHtmlLib/ActiveTabCSS.html#user_setup">ActiveTabCSS::user_setup()</a>, <a href="../phpHtmlLib/InfoTableCSS.html#user_setup">InfoTableCSS::user_setup()</a>, <a href="../phpHtmlLib/NavTableCSS.html#user_setup">NavTableCSS::user_setup()</a>, <a href="../phpHtmlLib/TextNavCSS.html#user_setup">TextNavCSS::user_setup()</a>, <a href="../phpHtmlLib/TextCSSNavCSS.html#user_setup">TextCSSNavCSS::user_setup()</a>, <a href="../phpHtmlLib/VerticalCSSNavTableCSS.html#user_setup">VerticalCSSNavTableCSS::user_setup()</a>, <a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html#user_setup">ImageThumbnailWidgetCSS::user_setup()</a>, <a href="../phpHtmlLib/DefaultGUIDataListCSS.html#user_setup">DefaultGUIDataListCSS::user_setup()</a><br> |
<a href="../phpHtmlLib/RoundTitleTableCSS.html#methoduser_setup">RoundTitleTableCSS::user_setup()</a> |
| 596 |
<BR> |
</li> |
| 597 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li> |
| 598 |
<!-- ========== Info from phpDoc block ========= --> |
<a href="../phpHtmlLib/TabListCSS.html#methoduser_setup">TabListCSS::user_setup()</a> |
| 599 |
Call the child class' setup function |
</li> |
| 600 |
<BR> |
<li> |
| 601 |
to build the actual css classes and their |
<a href="../phpHtmlLib/TextCSSNavCSS.html#methoduser_setup">TextCSSNavCSS::user_setup()</a> |
| 602 |
attributes |
</li> |
| 603 |
<DL> |
<li> |
| 604 |
<DT class="font10bold">Function Parameters:</DT> |
<a href="../phpHtmlLib/TextNavCSS.html#methoduser_setup">TextNavCSS::user_setup()</a> |
| 605 |
|
</li> |
| 606 |
|
<li> |
| 607 |
<DT class="font10bold">Function Info:</DT> |
<a href="../phpHtmlLib/VerticalCSSNavTableCSS.html#methoduser_setup">VerticalCSSNavTableCSS::user_setup()</a> |
| 608 |
|
</li> |
| 609 |
</DL> |
<li> |
| 610 |
|
<a href="../phpHtmlLib/DefaultGUIDataListCSS.html#methoduser_setup">DefaultGUIDataListCSS::user_setup()</a> |
| 611 |
</DIV> |
</li> |
| 612 |
<BR> |
</ul> |
| 613 |
|
</div> |
| 614 |
<DIV CLASS="function"> |
<a name="method_build_name" id="_build_name"><!-- --></a> |
| 615 |
<A NAME='_build_name'><!-- --></A> |
<div class="evenrow"> |
| 616 |
<SPAN CLASS="font12bold">_build_name</SPAN> |
|
| 617 |
<BR> |
<div class="method-header"> |
| 618 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-title">_build_name</span> (line <span class="line-number">154</span>) |
| 619 |
<span class="font10bold" style="color: #FF0000">the</SPAN> |
</div> |
| 620 |
<span class="font10bold" style="color: #0000FF">_build_name ( $class )</SPAN> |
|
| 621 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
| 622 |
|
<p class="short-description">This function is used to construct the css name declaration string.</p> |
| 623 |
<BR> |
<p class="description"><p>ie #foo div,span {</p></p> |
| 624 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<ul class="tags"> |
| 625 |
<!-- ========== Info from phpDoc block ========= --> |
<li><span class="field">return:</span> css name declaration</li> |
| 626 |
This function is used to construct the css name |
</ul> |
| 627 |
declaration string. |
|
| 628 |
<BR> |
<div class="method-signature"> |
| 629 |
ie #foo div,span { |
<span class="method-result">the</span> |
| 630 |
<DL> |
<span class="method-name"> |
| 631 |
<DT class="font10bold">Function Parameters:</DT> |
_build_name |
| 632 |
|
</span> |
| 633 |
<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">$class</SPAN></SPAN> the name-extends string</DD> |
(<span class="var-type">string</span> <span class="var-name">$class</span>) |
| 634 |
|
</div> |
| 635 |
|
|
| 636 |
<DT class="font10bold">Function Info:</DT> |
<ul class="parameters"> |
| 637 |
|
<li> |
| 638 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - css name declaration</DD> |
<span class="var-type">string</span> |
| 639 |
|
<span class="var-name">$class</span><span class="var-description">: the name-extends string</span> </li> |
| 640 |
</DL> |
</ul> |
| 641 |
|
|
| 642 |
</DIV> |
|
| 643 |
<BR> |
</div> |
| 644 |
|
<a name="method_build_properties" id="_build_properties"><!-- --></a> |
| 645 |
<DIV CLASS="function"> |
<div class="oddrow"> |
| 646 |
<A NAME='_build_properties'><!-- --></A> |
|
| 647 |
<SPAN CLASS="font12bold">_build_properties</SPAN> |
<div class="method-header"> |
| 648 |
<BR> |
<span class="method-title">_build_properties</span> (line <span class="line-number">169</span>) |
| 649 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
| 650 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
| 651 |
<span class="font10bold" style="color: #0000FF">_build_properties ( $properties, $indent_str )</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
| 652 |
<BR> |
<p class="short-description">This function is used to construct the property: value strings for the class</p> |
| 653 |
|
|
| 654 |
<BR> |
<div class="method-signature"> |
| 655 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-result">string</span> |
| 656 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"> |
| 657 |
This function is used to construct the |
_build_properties |
| 658 |
property: value strings for the class |
</span> |
| 659 |
<BR> |
(<span class="var-type">array</span> <span class="var-name">$properties</span>, <span class="var-type">array</span> <span class="var-name">$indent_str</span>) |
| 660 |
|
</div> |
| 661 |
<DL> |
|
| 662 |
<DT class="font10bold">Function Parameters:</DT> |
<ul class="parameters"> |
| 663 |
|
<li> |
| 664 |
<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">$properties</SPAN></SPAN> - the properties</DD> |
<span class="var-type">array</span> |
| 665 |
|
<span class="var-name">$properties</span><span class="var-description">: - the properties</span> </li> |
| 666 |
<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">$indent_str</SPAN></SPAN> - the indent string.</DD> |
<li> |
| 667 |
|
<span class="var-type">array</span> |
| 668 |
|
<span class="var-name">$indent_str</span><span class="var-description">: - the indent string.</span> </li> |
| 669 |
<DT class="font10bold">Function Info:</DT> |
</ul> |
| 670 |
|
|
| 671 |
</DL> |
|
| 672 |
|
</div> |
| 673 |
</DIV> |
<a name="method_replace_value" id="_replace_value"><!-- --></a> |
| 674 |
<BR> |
<div class="evenrow"> |
| 675 |
|
|
| 676 |
<DIV CLASS="function"> |
<div class="method-header"> |
| 677 |
<A NAME='_replace_value'><!-- --></A> |
<span class="method-title">_replace_value</span> (line <span class="line-number">258</span>) |
| 678 |
<SPAN CLASS="font12bold">_replace_value</SPAN> |
</div> |
| 679 |
<BR> |
|
| 680 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
| 681 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<p class="short-description">This function does the main work for update_all_values</p> |
| 682 |
<span class="font10bold" style="color: #0000FF">_replace_value ( &$item, $key, $blah )</SPAN> |
|
| 683 |
<BR> |
<div class="method-signature"> |
| 684 |
|
<span class="method-result">void</span> |
| 685 |
<BR> |
<span class="method-name"> |
| 686 |
<SPAN CLASS="font10bold">Description : </SPAN> |
_replace_value |
| 687 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
| 688 |
This function does the main work for update_all_values |
(<span class="var-type">mixed</span> <span class="var-name">&$item</span>, <span class="var-type">mixed</span> <span class="var-name">$key</span>, <span class="var-type">mixed</span> <span class="var-name">$blah</span>) |
| 689 |
<BR> |
</div> |
| 690 |
|
|
| 691 |
<DL> |
|
| 692 |
<DT class="font10bold">Function Parameters:</DT> |
|
| 693 |
|
</div> |
| 694 |
|
|
| 695 |
<DT class="font10bold">Function Info:</DT> |
</div> |
| 696 |
|
</div> |
| 697 |
</DL> |
|
| 698 |
|
|
| 699 |
</DIV> |
<p class="notes" id="credit"> |
| 700 |
<BR> |
Documentation generated on Thu, 1 Apr 2004 09:38:08 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 701 |
|
</p> |
| 702 |
|
</div></body> |
| 703 |
<hr> |
</html> |
|
</HTML> |
|