joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
pickles/docs/PICKLES/Form.html

970 lines
No EOL
51 KiB
HTML
Raw Blame History

<?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 Class Form</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="class-name">Class Form</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Form Class</p>
<p class="description"><p>This class contains methods for easily generating form elements. There is a heavy focus on select boxes as they have the most overhead for a developer.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Form.php.html">/classes/Form.php</a> (line <span class="field">24</span>)
</p>
<pre>Object
|
--Form</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">object instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Form'</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#checkbox" title="details" class="method-name">checkbox</a>
(<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">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#dateSelect" title="details" class="method-name">dateSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'date'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$start_year</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$end_year</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#dobSelect" title="details" class="method-name">dobSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'dob'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#hidden" title="details" class="method-name">hidden</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#hiddenInput" title="details" class="method-name">hiddenInput</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#input" title="details" class="method-name">input</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#options" title="details" class="method-name">options</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#password" title="details" class="method-name">password</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#passwordInput" title="details" class="method-name">passwordInput</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#phoneInput" title="details" class="method-name">phoneInput</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'phone'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#polarSelect" title="details" class="method-name">polarSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'decision'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#radio" title="details" class="method-name">radio</a>
(<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">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#security" title="details" class="method-name">security</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#securityInput" title="details" class="method-name">securityInput</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#select" title="details" class="method-name">select</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$options</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#stateSelect" title="details" class="method-name">stateSelect</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'state'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#submit" title="details" class="method-name">submit</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#submitInput" title="details" class="method-name">submitInput</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#textarea" title="details" class="method-name">textarea</a>
(<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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">37</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Instance</p>
<p class="description"><p>Gets an instance of the Form class</p></p>
<ul class="tags">
<li><span class="field">return:</span> of the class</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">object instance</span>
<span class="method-name">
getInstance
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Form'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: name of the class to get an instance of</span> </li>
</ul>
</div>
<a name="methodcheckbox" id="checkbox"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">checkbox</span> (line <span class="line-number">236</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checkbox</p>
<p class="description"><p>Generates a checkbox input with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
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">$value</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$checked</span><span class="var-description">: optional whether the checkbox is checked</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methoddateSelect" id="dateSelect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">dateSelect</span> (line <span class="line-number">492</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Date Select</p>
<p class="description"><p>Generates 3 select boxes (month, day, year)</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the select boxes</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
dateSelect
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'date'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$start_year</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$end_year</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">: optional name (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$selected</span><span class="var-description">: optional selected option</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$start_year</span><span class="var-description">: optional first year to display</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$end_year</span><span class="var-description">: optional last year to display</span> </li>
</ul>
</div>
<a name="methoddobSelect" id="dobSelect"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">dobSelect</span> (line <span class="line-number">568</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Date of Birth Select</p>
<p class="description"><p>Generates 3 select boxes (month, day, year)</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the select boxes</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
dobSelect
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'dob'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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">: optional name (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$selected</span><span class="var-description">: optional selected option</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodhidden" id="hidden"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">hidden</span> (line <span class="line-number">87</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hidden</p>
<p class="description"><p>Shorthand method to generate a hidden input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodhiddenInput" id="hiddenInput"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">hiddenInput</span> (line <span class="line-number">105</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hidden Input</p>
<p class="description"><p>Shorthand method to generate a hidden input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use hidden() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
hiddenInput
</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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodinput" id="input"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">input</span> (line <span class="line-number">58</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Input</p>
<p class="description"><p>Generates an input with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
input
</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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$type</span><span class="var-description">: optional type of input</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$checked</span><span class="var-description">: optional whether the input is checked</span> </li>
</ul>
</div>
<a name="methodoptions" id="options"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">options</span> (line <span class="line-number">333</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Options</p>
<p class="description"><p>Generates the option elements from the passed array</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the options</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
options
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$options</span><span class="var-description">: key/values for the options</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$selected</span><span class="var-description">: optional default option</span> </li>
</ul>
</div>
<a name="methodpassword" id="password"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">password</span> (line <span class="line-number">124</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Password</p>
<p class="description"><p>Shorthand method to generate a password input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
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">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodpasswordInput" id="passwordInput"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">passwordInput</span> (line <span class="line-number">142</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Password Input</p>
<p class="description"><p>Shorthand method to generate a password input.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use password() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
passwordInput
</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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodphoneInput" id="phoneInput"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">phoneInput</span> (line <span class="line-number">608</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Phone Input</p>
<p class="description"><p>Generates 3 inputs for a phone number from the passed values.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
phoneInput
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'phone'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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">: optional name (and ID) for the input elements</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional existing value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodpolarSelect" id="polarSelect"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">polarSelect</span> (line <span class="line-number">588</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Polar Select</p>
<p class="description"><p>Generates a polar (yes / no) select box.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
polarSelect
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'decision'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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">: optional name (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$selected</span><span class="var-description">: optional selected option</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodradio" id="radio"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">radio</span> (line <span class="line-number">261</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Radio Button</p>
<p class="description"><p>Generates a radio input with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
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">$value</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checked</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$checked</span><span class="var-description">: optional whether the checkbox is checked</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodsecurity" id="security"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">security</span> (line <span class="line-number">197</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Security</p>
<p class="description"><p>Generates a hidden input with an SHA1 hash as the value. The name of the field is cannot be changed as this method was only intended for use with forms that are submitted via AJAX to provide better security.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
security
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: value to hash</span> </li>
</ul>
</div>
<a name="methodsecurityInput" id="securityInput"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">securityInput</span> (line <span class="line-number">215</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Security Input</p>
<p class="description"><p>Generates a hidden input with an SHA1 hash as the value. The name of the field is cannot be changed as this method was only intended for use with forms that are submitted via AJAX to provide better security.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use security() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
securityInput
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: value to hash</span> </li>
</ul>
</div>
<a name="methodselect" id="select"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">select</span> (line <span class="line-number">311</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Select</p>
<p class="description"><p>Generates a select box with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the select box</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
select
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$options</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the select element</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$options</span><span class="var-description">: key/values for the option elements</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$selected</span><span class="var-description">: optional selected option</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodstateSelect" id="stateSelect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">stateSelect</span> (line <span class="line-number">403</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">State Select</p>
<p class="description"><p>Generates a select box with the United States, Puerto Rico and miliary options</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the select box</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
stateSelect
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'state'</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">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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">: optional name (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$selected</span><span class="var-description">: optional selected option</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodsubmit" id="submit"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">submit</span> (line <span class="line-number">161</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Submit</p>
<p class="description"><p>Shorthand method to generate a submit input (button).</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
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">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the input element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodsubmitInput" id="submitInput"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">submitInput</span> (line <span class="line-number">179</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Submit Input</p>
<p class="description"><p>Shorthand method to generate a submit input (button).</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">deprecated:</span> Use submit() instead</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
submitInput
</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">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</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 (and ID) for the input element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
</ul>
</div>
<a name="methodtextarea" id="textarea"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">textarea</span> (line <span class="line-number">286</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Textarea</p>
<p class="description"><p>Generates a textarea with the passed data.</p></p>
<ul class="tags">
<li><span class="field">return:</span> HTML for the input</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
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">$value</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$classes</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$additional</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name (and ID) for the select element</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: optional preset value</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$classes</span><span class="var-description">: optional class names</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$additional</span><span class="var-description">: optional additional parameters</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$type</span><span class="var-description">: optional type of input</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Oct 2012 14:02:18 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>
Reference in a new issue View git blame Copy permalink