aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Evans <grknight@gentoo.org>2018-01-29 16:04:13 -0500
committerBrian Evans <grknight@gentoo.org>2018-01-29 16:05:35 -0500
commit3c56284f7fe1926f6bf6ebd97ec72805d94df1e4 (patch)
tree805a3fb4cfb14519c0bebc3f1863f4759e916a82 /docs/mirror/lib/_php_lib_forms_php.html
downloadbouncer-3c56284f7fe1926f6bf6ebd97ec72805d94df1e4.tar.gz
bouncer-3c56284f7fe1926f6bf6ebd97ec72805d94df1e4.tar.bz2
bouncer-3c56284f7fe1926f6bf6ebd97ec72805d94df1e4.zip
Import existing bouncer.g.o into gitv1.0-20181208-IMPORT
Diffstat (limited to 'docs/mirror/lib/_php_lib_forms_php.html')
-rw-r--r--docs/mirror/lib/_php_lib_forms_php.html942
1 files changed, 942 insertions, 0 deletions
diff --git a/docs/mirror/lib/_php_lib_forms_php.html b/docs/mirror/lib/_php_lib_forms_php.html
new file mode 100644
index 0000000..aadc7f2
--- /dev/null
+++ b/docs/mirror/lib/_php_lib_forms_php.html
@@ -0,0 +1,942 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs for page forms.php</title>
+ <link rel="stylesheet" href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="file-name">/php/lib/forms.php</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span class="disabled">Description</span> |
+ <a href="#sec-functions">Functions</a>
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Form functions for handling form input, output, and markup.</p>
+
+ </div>
+</div>
+
+
+
+
+
+ <a name="sec-functions"></a>
+ <div class="info-box">
+ <div class="info-box-title">Functions</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Functions</span>
+ </div>
+ <div class="info-box-body">
+ <a name="functionarray_days" id="functionarray_days"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">array_days</span> (line <span class="line-number">76</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get calendar days in array format.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> days from 1-&gt;[28-31] (zero-filled)</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ array_days
+ </span>
+ ([<span class="var-type">int</span>&nbsp;<span class="var-name">$month</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">''</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$month</span><span class="var-description">: numeric representation of month (optional) default is empty, accepted range value is 1-12 inclusive, this affects the total number of days in given month</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$year</span><span class="var-description">: the year (optional) default is empty, this affects the total number of days in given month</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionarray_hours" id="functionarray_hours"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">array_hours</span> (line <span class="line-number">159</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get calendar hours in array format.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> hours (zero-filled)</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ array_hours
+ </span>
+ ()
+ </div>
+
+
+
+</div>
+<a name="functionarray_minutes" id="functionarray_minutes"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">array_minutes</span> (line <span class="line-number">187</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get array of minutes.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> minutes (zero-filled)</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ array_minutes
+ </span>
+ ([<span class="var-type">int</span>&nbsp;<span class="var-name">$interval</span> = <span class="var-default">15</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$interval</span><span class="var-description">: interval between minutes (optional) default is 15</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionarray_months" id="functionarray_months"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">array_months</span> (line <span class="line-number">105</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get calendar months in array format.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> months from 01-12 (zero-filled)</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ array_months
+ </span>
+ ()
+ </div>
+
+
+
+</div>
+<a name="functionarray_states" id="functionarray_states"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">array_states</span> (line <span class="line-number">203</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get array of states.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> states (abbr=&gt;fullname)</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ array_states
+ </span>
+ ()
+ </div>
+
+
+
+</div>
+<a name="functionarray_years" id="functionarray_years"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">array_years</span> (line <span class="line-number">130</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get calendar years in array format.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> years</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ array_years
+ </span>
+ ([<span class="var-type">int</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">5</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">''</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$num</span><span class="var-description">: number of years to display (optional) default is 5, negative numbers change direction of array</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$year</span><span class="var-description">: starting year (optional) default is this year</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionclean_in" id="functionclean_in"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">clean_in</span> (line <span class="line-number">41</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Cleans a string or an array of strings for DB input.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> slashes added, if necessary</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ clean_in
+ </span>
+ (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$single_quotes</span> = <span class="var-default">FALSE</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$decode</span> = <span class="var-default">FALSE</span>], <span class="var-type">bool</span>&nbsp;<span class="var-name">$single_quote</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">mixed</span>
+ <span class="var-name">$str</span><span class="var-description">: dirty</span> </li>
+ <li>
+ <span class="var-type">bool</span>
+ <span class="var-name">$single_quote</span><span class="var-description">: add single quotes around the string, optional</span> </li>
+ <li>
+ <span class="var-type">bool</span>
+ <span class="var-name">$decode</span><span class="var-description">: run html_entity_decode(), optional</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionclean_out" id="functionclean_out"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">clean_out</span> (line <span class="line-number">14</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Cleans a string or an array of strings for HTML presentation.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> cleaned for HTML</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ clean_out
+ </span>
+ (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$slashes</span> = <span class="var-default">FALSE</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">mixed</span>
+ <span class="var-name">$str</span><span class="var-description">: dirty</span> </li>
+ <li>
+ <span class="var-type">bool</span>
+ <span class="var-name">$slashes</span><span class="var-description">: default to false, this parameter indicate if stripslashes is desired, usually use for magic qoutes</span> </li>
+ </ul>
+
+
+</div>
+<a name="functiondb_get_to_options" id="functiondb_get_to_options"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">db_get_to_options</span> (line <span class="line-number">650</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Take a db_get result and return an array of options.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> array of options ($val=&gt;$text)</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ db_get_to_options
+ </span>
+ (<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$val_col</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name_col</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$data</span><span class="var-description">: db_get result</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$val_col</span><span class="var-description">: column containing the value for each option</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name_col</span><span class="var-description">: column containing the text</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_array_fix_dates" id="functionform_array_fix_dates"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_array_fix_dates</span> (line <span class="line-number">532</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Fix dates for form display, or proper db entry</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> null, or the original array modified to have separated date values for the forms</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ form_array_fix_dates
+ </span>
+ (<span class="var-type">array</span>&nbsp;<span class="var-name">$dates</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$datetimes</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$way</span> = <span class="var-default">1</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$orig</span> = <span class="var-default">''</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$dates</span><span class="var-description">: array of date field names</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$datetimes</span><span class="var-description">: array of datetime field names</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$way</span><span class="var-description">: 1 is done after a post, 2 is done when selecting for forms</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$orig</span><span class="var-description">: for way 2, the array we need to add the separated date values to (usually $posts)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_array_get_date" id="functionform_array_get_date"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">form_array_get_date</span> (line <span class="line-number">587</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get put a date back together after a POST.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> repaired date, as an array that corresponds to the form</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ form_array_get_date
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$key</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$field</span><span class="var-description">: name of post index of date field</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$key</span><span class="var-description">: index of form array that the field value belongs to</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_array_get_datetime" id="functionform_array_get_datetime"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_array_get_datetime</span> (line <span class="line-number">603</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Get put a datetime back together after a POST.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> repaired datetime, as an array that corresponds to the form</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">array</span>
+ <span class="method-name">
+ form_array_get_datetime
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$key</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$field</span><span class="var-description">: name of post index of datetime field</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$key</span><span class="var-description">: index of form array that the field value belongs to</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_checkbox" id="functionform_checkbox"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">form_checkbox</span> (line <span class="line-number">359</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a checkbox input.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_checkbox
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$id</span><span class="var-description">: id of field, must be unique per page</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: value</span> </li>
+ <li>
+ <span class="var-type">bool</span>
+ <span class="var-name">$checked</span><span class="var-description">: checked?</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_end" id="functionform_end"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_end</span> (line <span class="line-number">289</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes the ending form tag.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_end
+ </span>
+ ()
+ </div>
+
+
+
+</div>
+<a name="functionform_hidden" id="functionform_hidden"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">form_hidden</span> (line <span class="line-number">454</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a hidden field.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_hidden
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: value</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_label" id="functionform_label"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_label</span> (line <span class="line-number">301</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a form input label.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_label
+ </span>
+ ([<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$for</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$text</span><span class="var-description">: label text</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$for</span><span class="var-description">: id of corresponding field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: class css class of label</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_password" id="functionform_password"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">form_password</span> (line <span class="line-number">340</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a password input.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_password
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</span> = <span class="var-default">'30'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">'100'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$css</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$id</span><span class="var-description">: id of field, must be unique per page</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$css</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$size</span><span class="var-description">: size of field (optional) default is 30</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$maxlength</span><span class="var-description">: maxlength of field (optional)</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_radio" id="functionform_radio"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_radio</span> (line <span class="line-number">391</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a radio input.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_radio
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$id</span><span class="var-description">: id of field, must be unique per page</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: value</span> </li>
+ <li>
+ <span class="var-type">bool</span>
+ <span class="var-name">$checked</span><span class="var-description">: checked?</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_reset" id="functionform_reset"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">form_reset</span> (line <span class="line-number">439</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a reset input.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_reset
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">'Reset'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: value (button text)</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_select" id="functionform_select"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_select</span> (line <span class="line-number">477</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a select list with options.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_select
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$id</span><span class="var-description">: id of field, must be unique per page</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$options</span><span class="var-description">: possible options, usually pulled from db, or array_* funcs</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$selected</span><span class="var-description">: <p>if the value matches, it is selected</p><p>Multiple selects based on sets come out of a database as val,val,val so the explode was intended to create the instance of an array based on the string regardless of whether or not it has val,val,val.</p></span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_start" id="functionform_start"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">form_start</span> (line <span class="line-number">276</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes the beginning form tag.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_start
+ </span>
+ ([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'form'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">'post'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: form name</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: class name</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$method</span><span class="var-description">: method (post or get)</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$action</span><span class="var-description">: action</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_submit" id="functionform_submit"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_submit</span> (line <span class="line-number">422</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a submit input.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_submit
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">'Submit'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$id</span><span class="var-description">: the id attribute</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: value (button text)</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_text" id="functionform_text"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">form_text</span> (line <span class="line-number">321</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a text input.</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_text
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$size</span> = <span class="var-default">'30'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">'100'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$css</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$id</span><span class="var-description">: id of field, must be unique per page</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$css</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: value</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$size</span><span class="var-description">: size of field</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$maxlength</span><span class="var-description">: maxlength of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters (optional)</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionform_textarea" id="functionform_textarea"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">form_textarea</span> (line <span class="line-number">513</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Writes a textarea</p>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ form_textarea
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$rows</span> = <span class="var-default">'6'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$cols</span> = <span class="var-default">'50'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: name of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$id</span><span class="var-description">: id of field, must be unique per page</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$class</span><span class="var-description">: css class</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$rows</span><span class="var-description">: number of rows (height)</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$cols</span><span class="var-description">: number of cols (width)</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: value of field</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$extra</span><span class="var-description">: any extra parameters</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionis_email_address" id="functionis_email_address"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">is_email_address</span> (line <span class="line-number">618</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Validates email addresses</p>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ is_email_address
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$email</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionis_phone_number" id="functionis_phone_number"><!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="method-title">is_phone_number</span> (line <span class="line-number">628</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Validates phone number</p>
+
+ <div class="method-signature">
+ <span class="method-result">bool</span>
+ <span class="method-name">
+ is_phone_number
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$phone</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$phone</span> </li>
+ </ul>
+
+
+</div>
+<a name="functionurl_out" id="functionurl_out"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="method-title">url_out</span> (line <span class="line-number">638</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns http:// and the string if the string does not begin with http://</p>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ url_out
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$url</span> </li>
+ </ul>
+
+
+</div>
+ </div>
+ </div>
+
+ <p class="notes" id="credit">
+ Documentation generated on Mon, 8 Nov 2004 13:43:04 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
+ </p>
+ </div></body>
+</html> \ No newline at end of file