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:22:57 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs for page form_utils.inc</TITLE> |
<title>Docs for page form_utils.inc</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="file-name">Program_Root/tag_utils/form_utils.inc</h2> |
13 |
<TR> |
|
14 |
<TD class="font10"> |
<a name="sec-description"></a> |
15 |
Links: |
<div class="info-box"> |
16 |
<A HREF="#classes_summary" class="links" title="Classes created in this file">Classes</A> |
<div class="info-box-title">Description</div> |
17 |
<A HREF="#includes_summary" class="links" title="Include Statements Summary">Includes</A> |
<div class="nav-bar"> |
18 |
<A HREF="#global_summary" class="links" title="Global Variable Summary">Globals</A> |
<span class="disabled">Description</span> | |
19 |
<A HREF="#constant_summary" class="links" title="Constant Summary">Constants</A> |
<a href="#sec-functions">Functions</a> |
20 |
<A HREF="#function_summary" class="links" title="Function Summary">Functions</A> |
</div> |
21 |
<A HREF="#includes_detail" class="links" title="Include Statements Detail">Includes Detail</A> |
<div class="info-box-body"> |
22 |
<A HREF="#global_detail" class="links" title="Global Variable Detail">Globals Detail</A> |
<!-- ========== Info from phpDoc block ========= --> |
23 |
<A HREF="#constant_detail" class="links" title="Constant Detail">Constants Detail</A> |
<p class="short-description">This file contains various helper functions for building forms and form elements.</p> |
24 |
<A HREF="#function_detail" class="links" title="Function Detail">Functions Detail</A> |
<p class="description"><p>$Id$</p></p> |
25 |
</TD> |
<ul class="tags"> |
26 |
</TR> |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
27 |
</TABLE> |
</ul> |
28 |
<BR> |
|
29 |
<h2>File: Program_Root/tag_utils/form_utils.inc</h2> |
</div> |
30 |
This file contains various helper functions for building forms and form elements. |
</div> |
31 |
<br /> |
|
32 |
<p>$Id$</p> |
|
33 |
<UL> |
|
34 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
|
35 |
</UL> |
|
36 |
<!-- =========== Used Classes =========== --> |
<a name="sec-functions"></a> |
37 |
<A NAME='classes_summary'><!-- --></A> |
<div class="info-box"> |
38 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
<div class="info-box-title">Functions</div> |
39 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<div class="nav-bar"> |
40 |
<TD> |
<a href="#sec-description">Description</a> | |
41 |
<span class="font12bold">Classes defined in this file</span> |
<span class="disabled">Functions</span> |
42 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
43 |
</TD> |
<div class="info-box-body"> |
44 |
</TR> |
<a name="functionform_active_checkbox" id="functionform_active_checkbox"><!-- --></a> |
45 |
</TABLE> |
<div class="evenrow"> |
46 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
47 |
<THEAD> |
<div> |
48 |
<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR> |
<span class="method-title">form_active_checkbox</span> (line <span class="line-number">327</span>) |
49 |
</THEAD> |
</div> |
50 |
<TBODY> |
|
51 |
</TBODY> |
<!-- ========== Info from phpDoc block ========= --> |
52 |
</TABLE> |
<p class="short-description">build/render an input tag of type CHECKBOX with onClick javaScript selection</p> |
53 |
<br> |
<ul class="tags"> |
54 |
<!-- =========== Includes SUMMARY =========== --> |
<li><span class="field">return:</span> <p>a container object</p></li> |
55 |
<A NAME='includes_summary'><!-- --></A> |
<li><span class="field">author:</span> <p>Suren Markossian</p></li> |
56 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
</ul> |
57 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
58 |
<TD> |
<div class="method-signature"> |
59 |
<span CLASS="font12bold">Include Statements Summary</span> |
<span class="method-result">object returns</span> |
60 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="method-name"> |
61 |
</TD> |
form_active_checkbox |
62 |
</TR> |
</span> |
63 |
</TABLE> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$text</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span> <span class="var-name">$onClick</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span> <span class="var-name">$disabled</span> = <span class="var-default">FALSE</span>]) |
64 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</div> |
65 |
<THEAD> |
|
66 |
<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> |
<ul class="parameters"> |
67 |
</THEAD> |
<li> |
68 |
<TBODY> |
<span class="var-type">string</span> |
69 |
</TBODY> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
70 |
</TABLE> |
<li> |
71 |
<br> |
<span class="var-type">string</span> |
72 |
<br> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
73 |
<!-- =========== GLOBAL VARIABLE SUMMARY =========== --> |
<li> |
74 |
<A NAME='global_summary'><!-- --></A> |
<span class="var-type">string</span> |
75 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
<span class="var-name">$text</span><span class="var-description">: <p>- text label for the checkbox</p></span> </li> |
76 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<li> |
77 |
<TD> |
<span class="var-type">string</span> |
78 |
<span CLASS="font12bold">Global Variable Summary</span> |
<span class="var-name">$class</span><span class="var-description">: <p>class - CSS class of the text</p></span> </li> |
79 |
<A HREF="#top" CLASS="links">^TOP</A> |
</ul> |
80 |
</TD> |
|
81 |
</TR> |
|
82 |
</TABLE> |
</div> |
83 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<a name="functionform_active_radio" id="functionform_active_radio"><!-- --></a> |
84 |
<THEAD> |
<div class="oddrow"> |
85 |
<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> |
|
86 |
</THEAD> |
<div> |
87 |
<TBODY> |
<span class="method-title">form_active_radio</span> (line <span class="line-number">234</span>) |
88 |
</TBODY> |
</div> |
89 |
</TABLE> |
|
90 |
<br> |
<!-- ========== Info from phpDoc block ========= --> |
91 |
<br> |
<p class="short-description">build/render an set of radio buttons with onClick javaScript selection</p> |
92 |
<!-- =========== CONSTANT SUMMARY =========== --> |
<ul class="tags"> |
93 |
<A NAME='constant_summary'><!-- --></A> |
<li><span class="field">return:</span> <p>a container object</p></li> |
94 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
<li><span class="field">author:</span> <p>Suren Markossian</p></li> |
95 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</ul> |
96 |
<TD> |
|
97 |
<span class="font12bold">Constant Summary</span> |
<div class="method-signature"> |
98 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="method-result">object returns</span> |
99 |
</TD> |
<span class="method-name"> |
100 |
</TR> |
form_active_radio |
101 |
</TABLE> |
</span> |
102 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">array</span> <span class="var-name">$list</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">bool</span> <span class="var-name">$line_break</span> = <span class="var-default">TRUE</span>], [<span class="var-type">array</span> <span class="var-name">$attribs</span> = <span class="var-default">FALSE</span>]) |
103 |
<THEAD> |
</div> |
104 |
<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> |
|
105 |
</THEAD> |
<ul class="parameters"> |
106 |
<TBODY> |
<li> |
107 |
</TBODY> |
<span class="var-type">string</span> |
108 |
</TABLE> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
109 |
<br> |
<li> |
110 |
<br> |
<span class="var-type">array</span> |
111 |
<!-- =========== FUNCTION SUMMARY =========== --> |
<span class="var-name">$list</span><span class="var-description">: <p>- an array of text label = value pairs</p></span> </li> |
112 |
<A NAME='function_summary'><!-- --></A> |
<li> |
113 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
<span class="var-type">string</span> |
114 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<span class="var-name">$value</span><span class="var-description">: <p>- the default value (the one that will be checked)</p></span> </li> |
115 |
<TD> |
<li> |
116 |
<span class="font12bold">Function Summary</span> |
<span class="var-type">bool</span> |
117 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="var-name">$line_break</span><span class="var-description">: <p>- specify whether to put a line break after each radio button</p></span> </li> |
118 |
</TD> |
<li> |
119 |
</TR> |
<span class="var-type">array</span> |
120 |
|
<span class="var-name">$attribs</span><span class="var-description">: <p>- specify addionnal attribs for each value</p></span> </li> |
121 |
<!-- =========== Summary =========== --> |
</ul> |
122 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
123 |
<TD> |
|
124 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_active_checkbox">object form_active_checkbox ( $name, [$text = NULL], [$value = NULL], [$class = NULL], [$onClick = NULL], [$disabled = FALSE] )</A></B></CODE> |
</div> |
125 |
<BR> |
<a name="functionform_button" id="functionform_button"><!-- --></a> |
126 |
<blockquote> build/render an input tag of type CHECKBOX with onClick javaScript selection </blockquote> |
<div class="evenrow"> |
127 |
</TD> |
|
128 |
</TR> |
<div> |
129 |
<!-- =========== Summary =========== --> |
<span class="method-title">form_button</span> (line <span class="line-number">143</span>) |
130 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
131 |
<TD> |
|
132 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_active_radio">object form_active_radio ( $name, $list, $value, [$line_break = TRUE], [$attribs = FALSE] )</A></B></CODE> |
<!-- ========== Info from phpDoc block ========= --> |
133 |
<BR> |
<p class="short-description">build/render an input tag of type button</p> |
134 |
<blockquote> build/render an set of radio buttons with onClick javaScript selection </blockquote> |
<ul class="tags"> |
135 |
</TD> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
136 |
</TR> |
</ul> |
137 |
<!-- =========== Summary =========== --> |
|
138 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="method-signature"> |
139 |
<TD> |
<span class="method-result">mixed</span> |
140 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_button">mixed form_button ( $name, [$value = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
<span class="method-name"> |
141 |
<BR> |
form_button |
142 |
<blockquote> build/render an input tag of type button </blockquote> |
</span> |
143 |
</TD> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
144 |
</TR> |
</div> |
145 |
<!-- =========== Summary =========== --> |
|
146 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<ul class="parameters"> |
147 |
<TD> |
<li> |
148 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_checkbox">mixed form_checkbox ( $name, [$value = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
<span class="var-type">string</span> |
149 |
<BR> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
150 |
<blockquote> build/render an input tag of type CHECKBOX </blockquote> |
<li> |
151 |
</TD> |
<span class="var-type">string</span> |
152 |
</TR> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
153 |
<!-- =========== Summary =========== --> |
<li> |
154 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">array</span> |
155 |
<TD> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
156 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_close">string form_close ( [$indent_level = 0] )</A></B></CODE> |
<li> |
157 |
<BR> |
<span class="var-type">boolean</span> |
158 |
<blockquote> render a form close tag </blockquote> |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
159 |
</TD> |
</ul> |
160 |
</TR> |
|
161 |
<!-- =========== Summary =========== --> |
|
162 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
163 |
<TD> |
<a name="functionform_checkbox" id="functionform_checkbox"><!-- --></a> |
164 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_file">mixed form_file ( $name, [$value = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
<div class="oddrow"> |
165 |
<BR> |
|
166 |
<blockquote> build/render an html tag of file </blockquote> |
<div> |
167 |
</TD> |
<span class="method-title">form_checkbox</span> (line <span class="line-number">304</span>) |
168 |
</TR> |
</div> |
169 |
<!-- =========== Summary =========== --> |
|
170 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<!-- ========== Info from phpDoc block ========= --> |
171 |
<TD> |
<p class="short-description">build/render an input tag of type CHECKBOX</p> |
172 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_hidden">mixed form_hidden ( $name, [$value = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
<ul class="tags"> |
173 |
<BR> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
174 |
<blockquote> build/render an input tag of type hidden </blockquote> |
</ul> |
175 |
</TD> |
|
176 |
</TR> |
<div class="method-signature"> |
177 |
<!-- =========== Summary =========== --> |
<span class="method-result">mixed</span> |
178 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-name"> |
179 |
<TD> |
form_checkbox |
180 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_image">mixed form_image ( $name, [$value = NULL], $src, [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
</span> |
181 |
<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> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
182 |
<blockquote> build/render an input tag of type image </blockquote> |
</div> |
183 |
</TD> |
|
184 |
</TR> |
<ul class="parameters"> |
185 |
<!-- =========== Summary =========== --> |
<li> |
186 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">string</span> |
187 |
<TD> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
188 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_open">string form_open ( $name, $action, [$method = "GET"], [$attributes = array()], [$indent_level = 0] )</A></B></CODE> |
<li> |
189 |
<BR> |
<span class="var-type">string</span> |
190 |
<blockquote> render an form open tag only. </blockquote> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
191 |
</TD> |
<li> |
192 |
</TR> |
<span class="var-type">array</span> |
193 |
<!-- =========== Summary =========== --> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
194 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<li> |
195 |
<TD> |
<span class="var-type">boolean</span> |
196 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_password">mixed form_password ( $name, [$value = NULL], [$size = NULL], [$maxlength = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
197 |
<BR> |
</ul> |
198 |
<blockquote> build/render an input tag of type password </blockquote> |
|
199 |
</TD> |
|
200 |
</TR> |
</div> |
201 |
<!-- =========== Summary =========== --> |
<a name="functionform_close" id="functionform_close"><!-- --></a> |
202 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="evenrow"> |
203 |
<TD> |
|
204 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_radio">mixed form_radio ( $name, [$value = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
<div> |
205 |
<BR> |
<span class="method-title">form_close</span> (line <span class="line-number">60</span>) |
206 |
<blockquote> build/render an input tag of type radio </blockquote> |
</div> |
207 |
</TD> |
|
208 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
209 |
<!-- =========== Summary =========== --> |
<p class="short-description">render a form close tag</p> |
210 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<ul class="tags"> |
211 |
<TD> |
<li><span class="field">return:</span> <p>- the </form> tag.</p></li> |
212 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_select">a form_select ( $name, [$options = array()], [$selected = ""], [$multiple_flag = FALSE], [$attribs = false] )</A></B></CODE> |
</ul> |
213 |
<BR> |
|
214 |
<blockquote> Build a select tag with all of its option tags </blockquote> |
<div class="method-signature"> |
215 |
</TD> |
<span class="method-result">string</span> |
216 |
</TR> |
<span class="method-name"> |
217 |
<!-- =========== Summary =========== --> |
form_close |
218 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</span> |
219 |
<TD> |
(<span class="var-type">mixed</span> <span class="var-name">$indent_level</span>) |
220 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_submit">mixed form_submit ( $name, [$value = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
</div> |
221 |
<BR> |
|
222 |
<blockquote> build/render an input tag of type submit </blockquote> |
|
223 |
</TD> |
|
224 |
</TR> |
</div> |
225 |
<!-- =========== Summary =========== --> |
<a name="functionform_file" id="functionform_file"><!-- --></a> |
226 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="oddrow"> |
227 |
<TD> |
|
228 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_text">mixed form_text ( $name, [$value = NULL], [$size = NULL], [$maxlength = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
<div> |
229 |
<BR> |
<span class="method-title">form_file</span> (line <span class="line-number">386</span>) |
230 |
<blockquote> build/render an input tag of type text </blockquote> |
</div> |
231 |
</TD> |
|
232 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
233 |
<!-- =========== Summary =========== --> |
<p class="short-description">build/render an html tag of file</p> |
234 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<ul class="tags"> |
235 |
<TD> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
236 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionform_textarea"><a href="../phpHtmlLib/TEXTAREAtag.html">TEXTAREAtag</a> form_textarea ( $name, [$value = NULL], [$attributes = array()], [$render_flag = FALSE] )</A></B></CODE> |
</ul> |
237 |
<BR> |
|
238 |
<blockquote> build a textarea tag with name and attributes. </blockquote> |
<div class="method-signature"> |
239 |
</TD> |
<span class="method-result">mixed</span> |
240 |
</TR> |
<span class="method-name"> |
241 |
<!-- =========== Summary =========== --> |
form_file |
242 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</span> |
243 |
<TD> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
244 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_form_utils_inc.html#functionhtml_form">string html_form ( $name, $action, [$method = "GET"], [$attributes = array()] )</A></B></CODE> |
</div> |
245 |
<BR> |
|
246 |
<blockquote> render an form open tag only. </blockquote> |
<ul class="parameters"> |
247 |
</TD> |
<li> |
248 |
</TR> |
<span class="var-type">string</span> |
249 |
</TABLE> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
250 |
<br> |
<li> |
251 |
<!-- ============ Includes DETAIL =========== --> |
<span class="var-type">string</span> |
252 |
|
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
253 |
<A NAME='includes_detail'></A> |
<li> |
254 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<span class="var-type">array</span> |
255 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
256 |
<TD> |
<li> |
257 |
<span CLASS="font12bold">Include Statements Detail</span> |
<span class="var-type">boolean</span> |
258 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
259 |
</TD> |
</ul> |
260 |
</TR> |
|
261 |
</TABLE> |
|
262 |
|
</div> |
263 |
<br> |
<a name="functionform_hidden" id="functionform_hidden"><!-- --></a> |
264 |
<!-- ============ GLOBALS DETAIL =========== --> |
<div class="evenrow"> |
265 |
|
|
266 |
<A NAME='global_detail'></A> |
<div> |
267 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
<span class="method-title">form_hidden</span> (line <span class="line-number">283</span>) |
268 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</div> |
269 |
<TD> |
|
270 |
<span CLASS="font12bold">Global Variable Detail</span> |
<!-- ========== Info from phpDoc block ========= --> |
271 |
<A HREF="#top" CLASS="links">^TOP</A> |
<p class="short-description">build/render an input tag of type hidden</p> |
272 |
</TD> |
<ul class="tags"> |
273 |
</TR> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
274 |
</TABLE> |
</ul> |
275 |
|
|
276 |
<br> |
<div class="method-signature"> |
277 |
<!-- ============ CONSTANT DETAIL =========== --> |
<span class="method-result">mixed</span> |
278 |
|
<span class="method-name"> |
279 |
<A NAME='constant_detail'></A> |
form_hidden |
280 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
</span> |
281 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
282 |
<TD> |
</div> |
283 |
<span CLASS="font12bold">Constant Detail</span> |
|
284 |
<A HREF="#top" CLASS="links">^TOP</A> |
<ul class="parameters"> |
285 |
</TD> |
<li> |
286 |
</TR> |
<span class="var-type">string</span> |
287 |
</TABLE> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
288 |
|
<li> |
289 |
<br> |
<span class="var-type">string</span> |
290 |
<!-- ============ FUNCTION DETAIL =========== --> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
291 |
|
<li> |
292 |
<A NAME='function_detail'></A> |
<span class="var-type">array</span> |
293 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
294 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<li> |
295 |
<TD> |
<span class="var-type">boolean</span> |
296 |
<span class="font12bold">Function Detail</span> |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
297 |
<A HREF="#top" CLASS="links">^TOP</A> |
</ul> |
298 |
</TD> |
|
299 |
</TR> |
|
300 |
</TABLE> |
</div> |
301 |
<BR> |
<a name="functionform_image" id="functionform_image"><!-- --></a> |
302 |
|
<div class="oddrow"> |
303 |
<DIV CLASS="function"> |
|
304 |
<A NAME="functionform_active_checkbox"><!-- --></A> |
<div> |
305 |
<SPAN CLASS="font12bold">form_active_checkbox</SPAN> (line <span class="linenumber">327</span>) |
<span class="method-title">form_image</span> (line <span class="line-number">187</span>) |
306 |
<BR> |
</div> |
307 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
308 |
<span class="font10bold" style="color: #FF0000">object</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
309 |
<span class="font10bold" style="color: #0000FF">form_active_checkbox( |
<p class="short-description">build/render an input tag of type image</p> |
310 |
string $name, [string $text = NULL], [string $value = NULL], [string $class = NULL], [mixed $onClick = NULL], [mixed $disabled = FALSE])</SPAN> |
<ul class="tags"> |
311 |
<BR> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
312 |
<BR> |
</ul> |
313 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
314 |
build/render an input tag of type CHECKBOX with onClick javaScript selection |
<div class="method-signature"> |
315 |
<br /> |
<span class="method-result">mixed</span> |
316 |
|
<span class="method-name"> |
317 |
<DL> |
form_image |
318 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
319 |
<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 name of the input tag.</DD> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$src</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
320 |
<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 of the tag</DD> |
</div> |
321 |
<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">$text</SPAN></SPAN> - text label for the checkbox</DD> |
|
322 |
<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> class - CSS class of the text</DD> |
<ul class="parameters"> |
323 |
|
<li> |
324 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-type">string</span> |
325 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - returns a container object</DD> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
326 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>author</b> - Suren Markossian</DD> |
<li> |
327 |
</DL> |
<span class="var-type">string</span> |
328 |
</DIV> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
329 |
<BR> |
<li> |
330 |
|
<span class="var-type">string</span> |
331 |
<DIV CLASS="function"> |
<span class="var-name">$src</span><span class="var-description">: <p>- the image src</p></span> </li> |
332 |
<A NAME="functionform_active_radio"><!-- --></A> |
<li> |
333 |
<SPAN CLASS="font12bold">form_active_radio</SPAN> (line <span class="linenumber">234</span>) |
<span class="var-type">array</span> |
334 |
<BR> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
335 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<li> |
336 |
<span class="font10bold" style="color: #FF0000">object</SPAN> |
<span class="var-type">boolean</span> |
337 |
<span class="font10bold" style="color: #0000FF">form_active_radio( |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
338 |
string $name, array $list, string $value, [bool $line_break = TRUE], [array $attribs = FALSE])</SPAN> |
</ul> |
339 |
<BR> |
|
340 |
<BR> |
|
341 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
342 |
build/render an set of radio buttons with onClick javaScript selection |
<a name="functionform_open" id="functionform_open"><!-- --></a> |
343 |
<br /> |
<div class="evenrow"> |
344 |
|
|
345 |
<DL> |
<div> |
346 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-title">form_open</span> (line <span class="line-number">49</span>) |
347 |
<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 name of the input tag.</DD> |
</div> |
348 |
<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">$list</SPAN></SPAN> - an array of text label = value pairs</DD> |
|
349 |
<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 default value (the one that will be checked)</DD> |
<!-- ========== Info from phpDoc block ========= --> |
350 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">bool</SPAN> <span style="color: #0000FF;font-weight:bold">$line_break</SPAN></SPAN> - specify whether to put a line break after each radio button</DD> |
<p class="short-description">render an form open tag only.</p> |
351 |
<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">$attribs</SPAN></SPAN> - specify addionnal attribs for each value</DD> |
<p class="description"><p>This is usefull for forms that are inside a table. you would render the form tag first, then the table with the form fields.</p></p> |
352 |
|
<ul class="tags"> |
353 |
<DT class="font10bold">Function Info:</DT> |
<li><span class="field">return:</span> <p>returns the raw form tag.</p></li> |
354 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - returns a container object</DD> |
</ul> |
355 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>author</b> - Suren Markossian</DD> |
|
356 |
</DL> |
<div class="method-signature"> |
357 |
</DIV> |
<span class="method-result">string</span> |
358 |
<BR> |
<span class="method-name"> |
359 |
|
form_open |
360 |
<DIV CLASS="function"> |
</span> |
361 |
<A NAME="functionform_button"><!-- --></A> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$action</span>, [<span class="var-type">string</span> <span class="var-name">$method</span> = <span class="var-default">"GET"</span>], [<span class="var-type">string</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">$indent_level</span>) |
362 |
<SPAN CLASS="font12bold">form_button</SPAN> (line <span class="linenumber">143</span>) |
</div> |
363 |
<BR> |
|
364 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<ul class="parameters"> |
365 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
<li> |
366 |
<span class="font10bold" style="color: #0000FF">form_button( |
<span class="var-type">string</span> |
367 |
string $name, [string $value = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
<span class="var-name">$name</span><span class="var-description">: <p>- name attribute of the form tag.</p></span> </li> |
368 |
<BR> |
<li> |
369 |
<BR> |
<span class="var-type">string</span> |
370 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-name">$action</span><span class="var-description">: <p>- the form action.</p></span> </li> |
371 |
build/render an input tag of type button |
<li> |
372 |
<br /> |
<span class="var-type">string</span> |
373 |
|
<span class="var-name">$method</span><span class="var-description">: <p>- form method</p></span> </li> |
374 |
<DL> |
<li> |
375 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="var-type">string</span> |
376 |
<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 name of the input tag.</DD> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' attributes for the form tag.</p></span> </li> |
377 |
<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 of the tag</DD> |
</ul> |
378 |
<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> - any extra name='value' pair attributes</DD> |
|
379 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
|
380 |
|
</div> |
381 |
<DT class="font10bold">Function Info:</DT> |
<a name="functionform_password" id="functionform_password"><!-- --></a> |
382 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<div class="oddrow"> |
383 |
</DL> |
|
384 |
</DIV> |
<div> |
385 |
<BR> |
<span class="method-title">form_password</span> (line <span class="line-number">113</span>) |
386 |
|
</div> |
387 |
<DIV CLASS="function"> |
|
388 |
<A NAME="functionform_checkbox"><!-- --></A> |
<!-- ========== Info from phpDoc block ========= --> |
389 |
<SPAN CLASS="font12bold">form_checkbox</SPAN> (line <span class="linenumber">304</span>) |
<p class="short-description">build/render an input tag of type password</p> |
390 |
<BR> |
<ul class="tags"> |
391 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
392 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
</ul> |
393 |
<span class="font10bold" style="color: #0000FF">form_checkbox( |
|
394 |
string $name, [string $value = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
<div class="method-signature"> |
395 |
<BR> |
<span class="method-result">mixed</span> |
396 |
<BR> |
<span class="method-name"> |
397 |
<SPAN CLASS="font10bold">Description : </SPAN> |
form_password |
398 |
build/render an input tag of type CHECKBOX |
</span> |
399 |
<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> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$size</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$maxlength</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
400 |
|
</div> |
401 |
<DL> |
|
402 |
<DT class="font10bold">Function Parameters:</DT> |
<ul class="parameters"> |
403 |
<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 name of the input tag.</DD> |
<li> |
404 |
<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 of the tag</DD> |
<span class="var-type">string</span> |
405 |
<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> - any extra name='value' pair attributes</DD> |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
406 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
<li> |
407 |
|
<span class="var-type">string</span> |
408 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
409 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<li> |
410 |
</DL> |
<span class="var-type">int</span> |
411 |
</DIV> |
<span class="var-name">$size</span><span class="var-description">: <p>- the size in characters of the text tag</p></span> </li> |
412 |
<BR> |
<li> |
413 |
|
<span class="var-type">int</span> |
414 |
<DIV CLASS="function"> |
<span class="var-name">$maxlength</span><span class="var-description">: <p>- the maximum @ of characters for the field</p></span> </li> |
415 |
<A NAME="functionform_close"><!-- --></A> |
<li> |
416 |
<SPAN CLASS="font12bold">form_close</SPAN> (line <span class="linenumber">60</span>) |
<span class="var-type">array</span> |
417 |
<BR> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
418 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<li> |
419 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<span class="var-type">boolean</span> |
420 |
<span class="font10bold" style="color: #0000FF">form_close( |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
421 |
mixed $indent_level)</SPAN> |
</ul> |
422 |
<BR> |
|
423 |
<BR> |
|
424 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
425 |
render a form close tag |
<a name="functionform_radio" id="functionform_radio"><!-- --></a> |
426 |
<br /> |
<div class="evenrow"> |
427 |
|
|
428 |
<DL> |
<div> |
429 |
|
<span class="method-title">form_radio</span> (line <span class="line-number">210</span>) |
430 |
<DT class="font10bold">Function Info:</DT> |
</div> |
431 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the </form> tag.</DD> |
|
432 |
</DL> |
<!-- ========== Info from phpDoc block ========= --> |
433 |
</DIV> |
<p class="short-description">build/render an input tag of type radio</p> |
434 |
<BR> |
<ul class="tags"> |
435 |
|
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
436 |
<DIV CLASS="function"> |
</ul> |
437 |
<A NAME="functionform_file"><!-- --></A> |
|
438 |
<SPAN CLASS="font12bold">form_file</SPAN> (line <span class="linenumber">386</span>) |
<div class="method-signature"> |
439 |
<BR> |
<span class="method-result">mixed</span> |
440 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<span class="method-name"> |
441 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
form_radio |
442 |
<span class="font10bold" style="color: #0000FF">form_file( |
</span> |
443 |
string $name, [string $value = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
444 |
<BR> |
</div> |
445 |
<BR> |
|
446 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<ul class="parameters"> |
447 |
build/render an html tag of file |
<li> |
448 |
<br /> |
<span class="var-type">string</span> |
449 |
|
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
450 |
<DL> |
<li> |
451 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="var-type">string</span> |
452 |
<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 name of the input tag.</DD> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
453 |
<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 of the tag</DD> |
<li> |
454 |
<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> - any extra name='value' pair attributes</DD> |
<span class="var-type">array</span> |
455 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
456 |
|
<li> |
457 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-type">boolean</span> |
458 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
459 |
</DL> |
</ul> |
460 |
</DIV> |
|
461 |
<BR> |
|
462 |
|
</div> |
463 |
<DIV CLASS="function"> |
<a name="functionform_select" id="functionform_select"><!-- --></a> |
464 |
<A NAME="functionform_hidden"><!-- --></A> |
<div class="oddrow"> |
465 |
<SPAN CLASS="font12bold">form_hidden</SPAN> (line <span class="linenumber">283</span>) |
|
466 |
<BR> |
<div> |
467 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<span class="method-title">form_select</span> (line <span class="line-number">449</span>) |
468 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
</div> |
469 |
<span class="font10bold" style="color: #0000FF">form_hidden( |
|
470 |
string $name, [string $value = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
471 |
<BR> |
<p class="short-description">Build a select tag with all of its option tags</p> |
472 |
<BR> |
<ul class="tags"> |
473 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<li><span class="field">return:</span> <p>SELECTtag object.</p></li> |
474 |
build/render an input tag of type hidden |
<li><span class="field">author:</span> <p>Walt A. Boring IV</p></li> |
475 |
<br /> |
</ul> |
476 |
|
|
477 |
<DL> |
<div class="method-signature"> |
478 |
<DT class="font10bold">Function Parameters:</DT> |
<span class="method-result">a</span> |
479 |
<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 name of the input tag.</DD> |
<span class="method-name"> |
480 |
<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 of the tag</DD> |
form_select |
481 |
<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> - any extra name='value' pair attributes</DD> |
</span> |
482 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">array</span> <span class="var-name">$options</span> = <span class="var-default">array()</span>], [<span class="var-type">mixed</span> <span class="var-name">$selected</span> = <span class="var-default">""</span>], [<span class="var-type">boolean</span> <span class="var-name">$multiple_flag</span> = <span class="var-default">FALSE</span>], [<span class="var-type">array</span> <span class="var-name">$attribs</span> = <span class="var-default">false</span>]) |
483 |
|
</div> |
484 |
<DT class="font10bold">Function Info:</DT> |
|
485 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<ul class="parameters"> |
486 |
</DL> |
<li> |
487 |
</DIV> |
<span class="var-type">string</span> |
488 |
<BR> |
<span class="var-name">$name</span><span class="var-description">: <p>- name of the select.</p></span> </li> |
489 |
|
<li> |
490 |
<DIV CLASS="function"> |
<span class="var-type">array</span> |
491 |
<A NAME="functionform_image"><!-- --></A> |
<span class="var-name">$options</span><span class="var-description">: <p>- an array of name value pairs for the options. the format is array( "LABEL" => VALUE ); each <option value="VALUE"> LABEL </option> ie array( "test" => "foo") would give an option of <option value="foo"> test </option></p></span> </li> |
492 |
<SPAN CLASS="font12bold">form_image</SPAN> (line <span class="linenumber">187</span>) |
<li> |
493 |
<BR> |
<span class="var-type">mixed</span> |
494 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<span class="var-name">$selected</span><span class="var-description">: <p>- This can be either a string or an array. If its a string then, it will be the selected option value <option value="foo" SELECTED>foo</option> If it is an array, then all of the option values will be marked as SELECTED. This only makes sense to do if the multiple_flag is true.</p></span> </li> |
495 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
<li> |
496 |
<span class="font10bold" style="color: #0000FF">form_image( |
<span class="var-type">boolean</span> |
497 |
string $name, [string $value = NULL], string $src, [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
<span class="var-name">$multiple_flag</span><span class="var-description">: <p>- is this a multiple selection select box?</p></span> </li> |
498 |
<BR> |
<li> |
499 |
<BR> |
<span class="var-type">array</span> |
500 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-name">$attribs</span><span class="var-description">: <p>- additionnal attributes to the select tag</p></span> </li> |
501 |
build/render an input tag of type image |
</ul> |
502 |
<br /> |
|
503 |
|
|
504 |
<DL> |
</div> |
505 |
<DT class="font10bold">Function Parameters:</DT> |
<a name="functionform_submit" id="functionform_submit"><!-- --></a> |
506 |
<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 name of the input tag.</DD> |
<div class="evenrow"> |
507 |
<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 of the tag</DD> |
|
508 |
<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">$src</SPAN></SPAN> - the image src</DD> |
<div> |
509 |
<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> - any extra name='value' pair attributes</DD> |
<span class="method-title">form_submit</span> (line <span class="line-number">165</span>) |
510 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
</div> |
511 |
|
|
512 |
<DT class="font10bold">Function Info:</DT> |
<!-- ========== Info from phpDoc block ========= --> |
513 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<p class="short-description">build/render an input tag of type submit</p> |
514 |
</DL> |
<ul class="tags"> |
515 |
</DIV> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
516 |
<BR> |
</ul> |
517 |
|
|
518 |
<DIV CLASS="function"> |
<div class="method-signature"> |
519 |
<A NAME="functionform_open"><!-- --></A> |
<span class="method-result">mixed</span> |
520 |
<SPAN CLASS="font12bold">form_open</SPAN> (line <span class="linenumber">49</span>) |
<span class="method-name"> |
521 |
<BR> |
form_submit |
522 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
</span> |
523 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
524 |
<span class="font10bold" style="color: #0000FF">form_open( |
</div> |
525 |
string $name, string $action, [string $method = "GET"], [string $attributes = array()], mixed $indent_level)</SPAN> |
|
526 |
<BR> |
<ul class="parameters"> |
527 |
<BR> |
<li> |
528 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-type">string</span> |
529 |
render an form open tag only. |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
530 |
<br /> |
<li> |
531 |
<p>This is usefull for forms that are inside a table. you would render the form tag first, then the table with the form fields.</p> |
<span class="var-type">string</span> |
532 |
<DL> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
533 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
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> - name attribute of the form tag.</DD> |
<span class="var-type">array</span> |
535 |
<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">$action</SPAN></SPAN> - the form action.</DD> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
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">$method</SPAN></SPAN> - form method</DD> |
<li> |
537 |
<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">$attributes</SPAN></SPAN> - any extra name='value' attributes for the form tag.</DD> |
<span class="var-type">boolean</span> |
538 |
|
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
539 |
<DT class="font10bold">Function Info:</DT> |
</ul> |
540 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - returns the raw form tag.</DD> |
|
541 |
</DL> |
|
542 |
</DIV> |
</div> |
543 |
<BR> |
<a name="functionform_text" id="functionform_text"><!-- --></a> |
544 |
|
<div class="oddrow"> |
545 |
<DIV CLASS="function"> |
|
546 |
<A NAME="functionform_password"><!-- --></A> |
<div> |
547 |
<SPAN CLASS="font12bold">form_password</SPAN> (line <span class="linenumber">113</span>) |
<span class="method-title">form_text</span> (line <span class="line-number">80</span>) |
548 |
<BR> |
</div> |
549 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
550 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
551 |
<span class="font10bold" style="color: #0000FF">form_password( |
<p class="short-description">build/render an input tag of type text</p> |
552 |
string $name, [string $value = NULL], [int $size = NULL], [int $maxlength = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
<ul class="tags"> |
553 |
<BR> |
<li><span class="field">return:</span> <p>either returns an input object (default) or raw html.</p></li> |
554 |
<BR> |
</ul> |
555 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
556 |
build/render an input tag of type password |
<div class="method-signature"> |
557 |
<br /> |
<span class="method-result">mixed</span> |
558 |
|
<span class="method-name"> |
559 |
<DL> |
form_text |
560 |
<DT class="font10bold">Function Parameters:</DT> |
</span> |
561 |
<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 name of the input tag.</DD> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$size</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$maxlength</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
562 |
<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 of the tag</DD> |
</div> |
563 |
<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">$size</SPAN></SPAN> - the size in characters of the text tag</DD> |
|
564 |
<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">$maxlength</SPAN></SPAN> - the maximum @ of characters for the field</DD> |
<ul class="parameters"> |
565 |
<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> - any extra name='value' pair attributes</DD> |
<li> |
566 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
<span class="var-type">string</span> |
567 |
|
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the input tag.</p></span> </li> |
568 |
<DT class="font10bold">Function Info:</DT> |
<li> |
569 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<span class="var-type">string</span> |
570 |
</DL> |
<span class="var-name">$value</span><span class="var-description">: <p>- the value of the tag</p></span> </li> |
571 |
</DIV> |
<li> |
572 |
<BR> |
<span class="var-type">int</span> |
573 |
|
<span class="var-name">$size</span><span class="var-description">: <p>- the size in characters of the text tag</p></span> </li> |
574 |
<DIV CLASS="function"> |
<li> |
575 |
<A NAME="functionform_radio"><!-- --></A> |
<span class="var-type">int</span> |
576 |
<SPAN CLASS="font12bold">form_radio</SPAN> (line <span class="linenumber">210</span>) |
<span class="var-name">$maxlength</span><span class="var-description">: <p>- the maximum @ of characters for the field</p></span> </li> |
577 |
<BR> |
<li> |
578 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<span class="var-type">array</span> |
579 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
580 |
<span class="font10bold" style="color: #0000FF">form_radio( |
<li> |
581 |
string $name, [string $value = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
<span class="var-type">boolean</span> |
582 |
<BR> |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
583 |
<BR> |
</ul> |
584 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
585 |
build/render an input tag of type radio |
|
586 |
<br /> |
</div> |
587 |
|
<a name="functionform_textarea" id="functionform_textarea"><!-- --></a> |
588 |
<DL> |
<div class="evenrow"> |
589 |
<DT class="font10bold">Function Parameters:</DT> |
|
590 |
<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 name of the input tag.</DD> |
<div> |
591 |
<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 of the tag</DD> |
<span class="method-title">form_textarea</span> (line <span class="line-number">413</span>) |
592 |
<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> - any extra name='value' pair attributes</DD> |
</div> |
593 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
|
594 |
|
<!-- ========== Info from phpDoc block ========= --> |
595 |
<DT class="font10bold">Function Info:</DT> |
<p class="short-description">build a textarea tag with name and attributes.</p> |
596 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<ul class="tags"> |
597 |
</DL> |
<li><span class="field">return:</span> <p>object.</p></li> |
598 |
</DIV> |
<li><span class="field">author:</span> <p>Walt A. Boring</p></li> |
599 |
<BR> |
</ul> |
600 |
|
|
601 |
<DIV CLASS="function"> |
<div class="method-signature"> |
602 |
<A NAME="functionform_select"><!-- --></A> |
<span class="method-result"><a href="../phpHtmlLib/TEXTAREAtag.html">TEXTAREAtag</a></span> |
603 |
<SPAN CLASS="font12bold">form_select</SPAN> (line <span class="linenumber">449</span>) |
<span class="method-name"> |
604 |
<BR> |
form_textarea |
605 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
</span> |
606 |
<span class="font10bold" style="color: #FF0000">a</SPAN> |
(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">string</span> <span class="var-name">$value</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span> <span class="var-name">$render_flag</span> = <span class="var-default">FALSE</span>]) |
607 |
<span class="font10bold" style="color: #0000FF">form_select( |
</div> |
608 |
string $name, [array $options = array()], [mixed $selected = ""], [boolean $multiple_flag = FALSE], [array $attribs = false])</SPAN> |
|
609 |
<BR> |
<ul class="parameters"> |
610 |
<BR> |
<li> |
611 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="var-type">string</span> |
612 |
Build a select tag with all of its option tags |
<span class="var-name">$name</span><span class="var-description">: <p>- the name of the textarea tag.</p></span> </li> |
613 |
<br /> |
<li> |
614 |
|
<span class="var-type">string</span> |
615 |
<DL> |
<span class="var-name">$value</span><span class="var-description">: <p>- data to display in the textarea.</p></span> </li> |
616 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
617 |
<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> - name of the select.</DD> |
<span class="var-type">array</span> |
618 |
<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">$options</SPAN></SPAN> - an array of name value pairs for the options. the format is array( "LABEL" => VALUE ); each <option value="VALUE"> LABEL </option> ie array( "test" => "foo") would give an option of <option value="foo"> test </option></DD> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' pair attributes</p></span> </li> |
619 |
<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">$selected</SPAN></SPAN> - This can be either a string or an array. If its a string then, it will be the selected option value <option value="foo" SELECTED>foo</option> If it is an array, then all of the option values will be marked as SELECTED. This only makes sense to do if the multiple_flag is true.</DD> |
<li> |
620 |
<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">$multiple_flag</SPAN></SPAN> - is this a multiple selection select box?</DD> |
<span class="var-type">boolean</span> |
621 |
<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">$attribs</SPAN></SPAN> - additionnal attributes to the select tag</DD> |
<span class="var-name">$render_flag</span><span class="var-description">: <p>- render an object (FALSE) or raw html (TRUE);</p></span> </li> |
622 |
|
</ul> |
623 |
<DT class="font10bold">Function Info:</DT> |
|
624 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - SELECTtag object.</DD> |
|
625 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>author</b> - Walt A. Boring IV</DD> |
</div> |
626 |
</DL> |
<a name="functionhtml_form" id="functionhtml_form"><!-- --></a> |
627 |
</DIV> |
<div class="oddrow"> |
628 |
<BR> |
|
629 |
|
<div> |
630 |
<DIV CLASS="function"> |
<span class="method-title">html_form</span> (line <span class="line-number">28</span>) |
631 |
<A NAME="functionform_submit"><!-- --></A> |
</div> |
632 |
<SPAN CLASS="font12bold">form_submit</SPAN> (line <span class="linenumber">165</span>) |
|
633 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
634 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
<p class="short-description">render an form open tag only.</p> |
635 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
<p class="description"><p>This is usefull for forms that are inside a table. you would render the form tag first, then the table with the form fields.</p></p> |
636 |
<span class="font10bold" style="color: #0000FF">form_submit( |
<ul class="tags"> |
637 |
string $name, [string $value = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
<li><span class="field">return:</span> <p>returns the raw form tag.</p></li> |
638 |
<BR> |
</ul> |
639 |
<BR> |
|
640 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<div class="method-signature"> |
641 |
build/render an input tag of type submit |
<span class="method-result">string</span> |
642 |
<br /> |
<span class="method-name"> |
643 |
|
html_form |
644 |
<DL> |
</span> |
645 |
<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">$action</span>, [<span class="var-type">string</span> <span class="var-name">$method</span> = <span class="var-default">"GET"</span>], [<span class="var-type">string</span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>]) |
646 |
<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 name of the input tag.</DD> |
</div> |
647 |
<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 of the tag</DD> |
|
648 |
<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> - any extra name='value' pair attributes</DD> |
<ul class="parameters"> |
649 |
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
<li> |
650 |
|
<span class="var-type">string</span> |
651 |
<DT class="font10bold">Function Info:</DT> |
<span class="var-name">$name</span><span class="var-description">: <p>- name attribute of the form tag.</p></span> </li> |
652 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
<li> |
653 |
</DL> |
<span class="var-type">string</span> |
654 |
</DIV> |
<span class="var-name">$action</span><span class="var-description">: <p>- the form action.</p></span> </li> |
655 |
<BR> |
<li> |
656 |
|
<span class="var-type">string</span> |
657 |
<DIV CLASS="function"> |
<span class="var-name">$method</span><span class="var-description">: <p>- form method</p></span> </li> |
658 |
<A NAME="functionform_text"><!-- --></A> |
<li> |
659 |
<SPAN CLASS="font12bold">form_text</SPAN> (line <span class="linenumber">80</span>) |
<span class="var-type">string</span> |
660 |
<BR> |
<span class="var-name">$attributes</span><span class="var-description">: <p>- any extra name='value' attributes for the form tag.</p></span> </li> |
661 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
</ul> |
662 |
<span class="font10bold" style="color: #FF0000">mixed</SPAN> |
|
663 |
<span class="font10bold" style="color: #0000FF">form_text( |
|
664 |
string $name, [string $value = NULL], [int $size = NULL], [int $maxlength = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
</div> |
665 |
<BR> |
</div> |
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
build/render an input tag of type text |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - the name of the input tag.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> - the value of the tag</DD> |
|
|
<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">$size</SPAN></SPAN> - the size in characters of the text tag</DD> |
|
|
<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">$maxlength</SPAN></SPAN> - the maximum @ of characters for the field</DD> |
|
|
<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> - any extra name='value' pair attributes</DD> |
|
|
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - either returns an input object (default) or raw html.</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME="functionform_textarea"><!-- --></A> |
|
|
<SPAN CLASS="font12bold">form_textarea</SPAN> (line <span class="linenumber">413</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TEXTAREAtag.html">TEXTAREAtag</a></SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">form_textarea( |
|
|
string $name, [string $value = NULL], [array $attributes = array()], [boolean $render_flag = FALSE])</SPAN> |
|
|
<BR> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
build a textarea tag with name and attributes. |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - the name of the textarea tag.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> - data to display in the textarea.</DD> |
|
|
<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> - any extra name='value' pair attributes</DD> |
|
|
<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">$render_flag</SPAN></SPAN> - render an object (FALSE) or raw html (TRUE);</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>author</b> - Walt A. Boring</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME="functionhtml_form"><!-- --></A> |
|
|
<SPAN CLASS="font12bold">html_form</SPAN> (line <span class="linenumber">28</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">html_form( |
|
|
string $name, string $action, [string $method = "GET"], [string $attributes = array()])</SPAN> |
|
|
<BR> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
render an form open tag only. |
|
|
<br /> |
|
|
<p>This is usefull for forms that are inside a table. you would render the form tag first, then the table with the form fields.</p> |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - name attribute of the form tag.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$action</SPAN></SPAN> - the form action.</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$method</SPAN></SPAN> - form method</DD> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> - any extra name='value' attributes for the form tag.</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - returns the raw form tag.</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<br> |
|
|
<div id="credit"> |
|
|
<hr> |
|
|
Documention generated on Thu, 20 Feb 2003 16:22:57 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
|
666 |
</div> |
</div> |
|
</body> |
|
|
</html> |
|
|
</HTML> |
|
667 |
|
|
668 |
|
<p class="notes" id="credit"> |
669 |
|
Documention generated on Thu, 31 Jul 2003 18:32:47 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
670 |
|
</p> |
671 |
|
</div></body> |
672 |
|
</html> |