Skip to content
Browse files

Initial commit of source and documentation to google code repo.

git-svn-id: http://php-phorms.googlecode.com/svn/trunk@2 7ca7cd46-97e6-11de-bc73-0172961ec0a2
  • Loading branch information...
1 parent a8eddd3 commit 7727b314e6b9cf538f1937c88fd52045da311512 @jsober jsober committed
Sorry, we could not display the entire diff because it was too big.
View
3 build_doc.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+phpdoc -pp -d src -t doc -o HTML:frames:phphtmllib
View
11 changelog
@@ -0,0 +1,11 @@
+1.02
+ * fixed bug in Phorm where default data may sometimes be overwritten incorrectly
+ * fixed bug in HiddenField where parent class was instantiated incorrectly
+
+1.01
+ * fixed bug in PhormField::is_valid where false values skipped field-level validation
+ * FileFields and ImageFields now pass either null or a File/Image instance to user-defined validators
+ * added file_drop.php to examples
+
+1.0
+ * initial release
View
486 doc/Fields/BooleanField.html
@@ -0,0 +1,486 @@
+<?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 BooleanField</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 BooleanField</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <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">BooleanField</p>
+<p class="description"><p>A field representing a boolean choice using a checkbox field.</p></p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">848</span>)
+ </p>
+
+
+ <pre><a href="../Fields/PhormField.html">PhormField</a>
+ |
+ --BooleanField</pre>
+
+ </div>
+</div>
+
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div class="var-title">
+ <span class="var-type">mixed</span>
+ <a href="#$checked" title="details" class="var-name">$checked</a>
+ </div>
+ </div>
+ </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> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">
+ <span class="method-result">BooleanField</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">boolean</span>
+ <a href="#get_value" title="details" class="method-name">get_value</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result"><a href="../Widgets/CheckboxWidget.html">CheckboxWidget</a></span>
+ <a href="#get_widget" title="details" class="method-name">get_widget</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">boolean</span>
+ <a href="#import_value" title="details" class="method-name">import_value</a>
+ (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#prepare_value" title="details" class="method-name">prepare_value</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">1</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">null</span>
+ <a href="#set_value" title="details" class="method-name">set_value</a>
+ (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">null</span>
+ <a href="#validate" title="details" class="method-name">validate</a>
+ (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
+<a name="var$checked" id="$checked"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">mixed</span>
+ <span class="var-name">$checked</span>
+ (line <span class="line-number">853</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">True when the field is checked (true).</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> private</li>
+ </ul>
+
+
+
+
+
+</div>
+ <h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!-- --></A>
+ <p>Inherited from <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$attributes">PhormField::$attributes</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$errors">PhormField::$errors</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$help_text">PhormField::$help_text</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$imported">PhormField::$imported</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$label">PhormField::$label</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$multi_field">PhormField::$multi_field</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$valid">PhormField::$valid</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$validators">PhormField::$validators</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$value">PhormField::$value</a></span><br>
+ </span>
+ </blockquote>
+
+ </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-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor __construct</span> (line <span class="line-number">861</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">BooleanField</span>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$label</span><span class="var-description">: the field's text label</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$validators</span><span class="var-description">: a list of callbacks to validate the field data</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$attributes</span><span class="var-description">: a list of key/value pairs representing HTML attributes</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></dt>
+ </dl>
+
+ </div>
+<a name="methodget_value" id="get_value"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">get_value</span> (line <span class="line-number">884</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns true if the field is checked.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">boolean</span>
+ <span class="method-name">
+ get_value
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></dt>
+ <dd>Returns the &quot;cleaned&quot; value of the field.</dd>
+ </dl>
+
+ </div>
+<a name="methodget_widget" id="get_widget"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">get_widget</span> (line <span class="line-number">894</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns a new CheckboxWidget.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a href="../Widgets/CheckboxWidget.html">CheckboxWidget</a></span>
+ <span class="method-name">
+ get_widget
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></dt>
+ <dd>Defined in derived classes; must return an instance of PhormWidget.</dd>
+ </dl>
+
+ </div>
+<a name="methodimport_value" id="import_value"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">import_value</span> (line <span class="line-number">915</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns true if the field was checked in the user-submitted data, false otherwise.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">boolean</span>
+ <span class="method-name">
+ import_value
+ </span>
+ (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">$value</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></dt>
+ <dd>Returns the field's &quot;imported&quot; value, if any processing is required. For example, this function may be used to convert a date/time field's string into a unix timestamp or a numeric string into an integer or float.</dd>
+ </dl>
+
+ </div>
+<a name="methodprepare_value" id="prepare_value"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">prepare_value</span> (line <span class="line-number">926</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the value.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ prepare_value
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">1</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">1</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></dt>
+ <dd>Pre-processes a value for validation, handling magic quotes if used.</dd>
+ </dl>
+
+ </div>
+<a name="methodset_value" id="set_value"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">set_value</span> (line <span class="line-number">874</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the value of the field.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">null</span>
+ <span class="method-name">
+ set_value
+ </span>
+ (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">boolean</span>
+ <span class="var-name">$value</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></dt>
+ <dd>Sets the value of the field.</dd>
+ </dl>
+
+ </div>
+<a name="methodvalidate" id="validate"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">validate</span> (line <span class="line-number">904</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns null.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">null</span>
+ <span class="method-name">
+ validate
+ </span>
+ (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">$value</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></dt>
+ <dd>Raises a ValidationError if $value is invalid.</dd>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methoderrors">PhormField::errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_attribute">PhormField::get_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_errors">PhormField::get_errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhelp_text">PhormField::help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhtml">PhormField::html()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodis_valid">PhormField::is_valid()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodlabel">PhormField::label()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_attribute">PhormField::set_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_help_text">PhormField::set_help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__toString">PhormField::__toString()</a></span><br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Mon, 20 Apr 2009 08:29:20 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ </p>
+ </div></body>
+</html>
View
303 doc/Fields/DateTimeField.html
@@ -0,0 +1,303 @@
+<?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 DateTimeField</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 DateTimeField</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-vars">Vars</a>
+ | <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">DateTimeField</p>
+<p class="description"><p>A text field that accepts a variety of date/time formats (those accepted by PHP's built-in strtotime.) Note that due to the reliance on strtotime, this class has a serious memory leak in PHP 5.2.8 (I am unsure if it is present as well in 5.2.9+.)</p></p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">1070</span>)
+ </p>
+
+
+ <pre><a href="../Fields/PhormField.html">PhormField</a>
+ |
+ --<a href="../Fields/TextField.html">TextField</a>
+ |
+ --DateTimeField</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> |
+ <a href="#sec-vars">Vars</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">
+ <span class="method-result">DateTimeField</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">int</span>
+ <a href="#import_value" title="details" class="method-name">import_value</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">null</span>
+ <a href="#validate" title="details" class="method-name">validate</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
+ <h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!-- --></A>
+ <p>Inherited from <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/TextField.html#var$max_length">TextField::$max_length</a></span><br>
+ </span>
+ </blockquote>
+ <p>Inherited from <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$attributes">PhormField::$attributes</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$errors">PhormField::$errors</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$help_text">PhormField::$help_text</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$imported">PhormField::$imported</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$label">PhormField::$label</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$multi_field">PhormField::$multi_field</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$valid">PhormField::$valid</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$validators">PhormField::$validators</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$value">PhormField::$value</a></span><br>
+ </span>
+ </blockquote>
+
+ </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-vars">Vars</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="method__construct" id="__construct"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor __construct</span> (line <span class="line-number">1078</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">DateTimeField</span>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$label</span><span class="var-description">: the field's text label</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$validators</span><span class="var-description">: a list of callbacks to validate the field data</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$attributes</span><span class="var-description">: a list of key/value pairs representing HTML attributes</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/TextField.html#method__construct">TextField::__construct()</a></dt>
+ </dl>
+
+ </div>
+<a name="methodimport_value" id="import_value"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">import_value</span> (line <span class="line-number">1104</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Imports the value and returns a unix timestamp (the number of seconds</p>
+<p class="description"><p>since the epoch.)</p></p>
+ <ul class="tags">
+ <li><span class="field">return:</span> the date/time as a unix timestamp</li>
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">int</span>
+ <span class="method-name">
+ import_value
+ </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> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/TextField.html#methodimport_value">TextField::import_value()</a></dt>
+ <dd>Imports the value by decoding HTML entities.</dd>
+ </dl>
+
+ </div>
+<a name="methodvalidate" id="validate"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">validate</span> (line <span class="line-number">1090</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Validates that the value is parsable as a date/time value.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">throws:</span> ValidationError</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">null</span>
+ <span class="method-name">
+ validate
+ </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> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></dt>
+ <dd>Validates that the value is less than $this-&gt;max_length;</dd>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../Fields/TextField.html#method__construct">TextField::__construct()</a></span><br>
+ <span class="method-name"><a href="../Fields/TextField.html#methodget_widget">TextField::get_widget()</a></span><br>
+ <span class="method-name"><a href="../Fields/TextField.html#methodimport_value">TextField::import_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></span><br>
+ </blockquote>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methoderrors">PhormField::errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_attribute">PhormField::get_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_errors">PhormField::get_errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhelp_text">PhormField::help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhtml">PhormField::html()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodis_valid">PhormField::is_valid()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodlabel">PhormField::label()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_attribute">PhormField::set_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_help_text">PhormField::set_help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__toString">PhormField::__toString()</a></span><br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Mon, 20 Apr 2009 08:29:20 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ </p>
+ </div></body>
+</html>
View
367 doc/Fields/DecimalField.html
@@ -0,0 +1,367 @@
+<?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 DecimalField</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 DecimalField</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <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">DecimalField</p>
+<p class="description"><p>A field that accepts only decimals of a specified precision.</p></p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">785</span>)
+ </p>
+
+
+ <pre><a href="../Fields/PhormField.html">PhormField</a>
+ |
+ --DecimalField</pre>
+
+ </div>
+</div>
+
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div class="var-title">
+ <span class="var-type">mixed</span>
+ <a href="#$precision" title="details" class="var-name">$precision</a>
+ </div>
+ </div>
+ </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> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">
+ <span class="method-result">DecimalField</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$precision</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result"><a href="../Widgets/CharWidget.html">CharWidget</a></span>
+ <a href="#get_widget" title="details" class="method-name">get_widget</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">float</span>
+ <a href="#import_value" title="details" class="method-name">import_value</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">null</span>
+ <a href="#validate" title="details" class="method-name">validate</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
+<a name="var$precision" id="$precision"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">mixed</span>
+ <span class="var-name">$precision</span>
+ (line <span class="line-number">790</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">The maximum precision of the field's value.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> private</li>
+ </ul>
+
+
+
+
+
+</div>
+ <h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!-- --></A>
+ <p>Inherited from <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$attributes">PhormField::$attributes</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$errors">PhormField::$errors</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$help_text">PhormField::$help_text</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$imported">PhormField::$imported</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$label">PhormField::$label</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$multi_field">PhormField::$multi_field</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$valid">PhormField::$valid</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$validators">PhormField::$validators</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$value">PhormField::$value</a></span><br>
+ </span>
+ </blockquote>
+
+ </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-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor __construct</span> (line <span class="line-number">799</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">DecimalField</span>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$precision</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$label</span><span class="var-description">: the field's text label</span> </li>
+ <li>
+ <span class="var-type">int</span>
+ <span class="var-name">$precision</span><span class="var-description">: the maximum number of decimals permitted</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$validators</span><span class="var-description">: a list of callbacks to validate the field data</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$attributes</span><span class="var-description">: a list of key/value pairs representing HTML attributes</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></dt>
+ </dl>
+
+ </div>
+<a name="methodget_widget" id="get_widget"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">get_widget</span> (line <span class="line-number">811</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns a new CharWidget.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a href="../Widgets/CharWidget.html">CharWidget</a></span>
+ <span class="method-name">
+ get_widget
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></dt>
+ <dd>Defined in derived classes; must return an instance of PhormWidget.</dd>
+ </dl>
+
+ </div>
+<a name="methodimport_value" id="import_value"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">import_value</span> (line <span class="line-number">835</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the parsed float, rounded to $this-&gt;precision digits.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> the parsed value</li>
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">float</span>
+ <span class="method-name">
+ import_value
+ </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> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></dt>
+ <dd>Returns the field's &quot;imported&quot; value, if any processing is required. For example, this function may be used to convert a date/time field's string into a unix timestamp or a numeric string into an integer or float.</dd>
+ </dl>
+
+ </div>
+<a name="methodvalidate" id="validate"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">validate</span> (line <span class="line-number">823</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Validates that the value is parsable as a float.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">throws:</span> ValidationError</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">null</span>
+ <span class="method-name">
+ validate
+ </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</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></dt>
+ <dd>Raises a ValidationError if $value is invalid.</dd>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methoderrors">PhormField::errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_attribute">PhormField::get_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_errors">PhormField::get_errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhelp_text">PhormField::help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhtml">PhormField::html()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodis_valid">PhormField::is_valid()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodlabel">PhormField::label()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_attribute">PhormField::set_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_help_text">PhormField::set_help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__toString">PhormField::__toString()</a></span><br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Mon, 20 Apr 2009 08:29:21 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ </p>
+ </div></body>
+</html>
View
368 doc/Fields/DropDownField.html
@@ -0,0 +1,368 @@
+<?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 DropDownField</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 DropDownField</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <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">DropDownField</p>
+<p class="description"><p>A field that presents a list of options as a drop-down.</p></p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">939</span>)
+ </p>
+
+
+ <pre><a href="../Fields/PhormField.html">PhormField</a>
+ |
+ --DropDownField</pre>
+
+ </div>
+</div>
+
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div class="var-title">
+ <span class="var-type">mixed</span>
+ <a href="#$choices" title="details" class="var-name">$choices</a>
+ </div>
+ </div>
+ </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> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">
+ <span class="method-result">DropDownField</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$choices</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result"><a href="../Widgets/SelectWidget.html">SelectWidget</a></span>
+ <a href="#get_widget" title="details" class="method-name">get_widget</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">string</span>
+ <a href="#import_value" title="details" class="method-name">import_value</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">null</span>
+ <a href="#validate" title="details" class="method-name">validate</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
+<a name="var$choices" id="$choices"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type">mixed</span>
+ <span class="var-name">$choices</span>
+ (line <span class="line-number">944</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">An array storing the drop-down's choices.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> private</li>
+ </ul>
+
+
+
+
+
+</div>
+ <h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!-- --></A>
+ <p>Inherited from <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$attributes">PhormField::$attributes</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$errors">PhormField::$errors</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$help_text">PhormField::$help_text</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$imported">PhormField::$imported</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$label">PhormField::$label</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$multi_field">PhormField::$multi_field</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$valid">PhormField::$valid</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$validators">PhormField::$validators</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$value">PhormField::$value</a></span><br>
+ </span>
+ </blockquote>
+
+ </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-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor __construct</span> (line <span class="line-number">953</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">DropDownField</span>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$choices</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$label</span><span class="var-description">: the field's text label</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$choices</span><span class="var-description">: a list of choices as actual_value=&gt;display_value</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$validators</span><span class="var-description">: a list of callbacks to validate the field data</span> </li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$attributes</span><span class="var-description">: a list of key/value pairs representing HTML attributes</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></dt>
+ </dl>
+
+ </div>
+<a name="methodget_widget" id="get_widget"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">get_widget</span> (line <span class="line-number">964</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns a new SelectWidget.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a href="../Widgets/SelectWidget.html">SelectWidget</a></span>
+ <span class="method-name">
+ get_widget
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></dt>
+ <dd>Defined in derived classes; must return an instance of PhormWidget.</dd>
+ </dl>
+
+ </div>
+<a name="methodimport_value" id="import_value"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">import_value</span> (line <span class="line-number">990</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Imports the value by decoding any HTML entities. Returns the &quot;actual&quot; value of the option selected.</p>
+ <ul class="tags">
+ <li><span class="field">return:</span> the decoded string</li>
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ import_value
+ </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> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></dt>
+ <dd>Returns the field's &quot;imported&quot; value, if any processing is required. For example, this function may be used to convert a date/time field's string into a unix timestamp or a numeric string into an integer or float.</dd>
+ </dl>
+
+ </div>
+<a name="methodvalidate" id="validate"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">validate</span> (line <span class="line-number">977</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Validates that $value is present in $this-&gt;choices.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">see:</span> <a href="../Fields/DropDownField.html#var$choices">DropDownField::$choices</a></li>
+ <li><span class="field">throws:</span> ValidationError</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">null</span>
+ <span class="method-name">
+ validate
+ </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> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></dt>
+ <dd>Raises a ValidationError if $value is invalid.</dd>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methoderrors">PhormField::errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_attribute">PhormField::get_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_errors">PhormField::get_errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhelp_text">PhormField::help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhtml">PhormField::html()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodis_valid">PhormField::is_valid()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodlabel">PhormField::label()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_attribute">PhormField::set_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_help_text">PhormField::set_help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__toString">PhormField::__toString()</a></span><br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Mon, 20 Apr 2009 08:29:21 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ </p>
+ </div></body>
+</html>
View
213 doc/Fields/EmailField.html
@@ -0,0 +1,213 @@
+<?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 EmailField</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 EmailField</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-vars">Vars</a>
+ | <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">EmailField</p>
+<p class="description"><p>A text field that only accepts a valid email address.</p></p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">1043</span>)
+ </p>
+
+
+ <pre><a href="../Fields/PhormField.html">PhormField</a>
+ |
+ --<a href="../Fields/TextField.html">TextField</a>
+ |
+ --EmailField</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> |
+ <a href="#sec-vars">Vars</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">
+ <span class="method-result">null</span>
+ <a href="#validate" title="details" class="method-name">validate</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
+ <h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!-- --></A>
+ <p>Inherited from <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/TextField.html#var$max_length">TextField::$max_length</a></span><br>
+ </span>
+ </blockquote>
+ <p>Inherited from <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$attributes">PhormField::$attributes</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$errors">PhormField::$errors</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$help_text">PhormField::$help_text</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$imported">PhormField::$imported</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$label">PhormField::$label</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$multi_field">PhormField::$multi_field</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$valid">PhormField::$valid</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$validators">PhormField::$validators</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../Fields/PhormField.html#var$value">PhormField::$value</a></span><br>
+ </span>
+ </blockquote>
+
+ </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-vars">Vars</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="methodvalidate" id="validate"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">validate</span> (line <span class="line-number">1052</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Validates that the value is a valid email address.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">throws:</span> ValidationError</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">null</span>
+ <span class="method-name">
+ validate
+ </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> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></dt>
+ <dd>Validates that the value is less than $this-&gt;max_length;</dd>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../Fields/TextField.html#method__construct">TextField::__construct()</a></span><br>
+ <span class="method-name"><a href="../Fields/TextField.html#methodget_widget">TextField::get_widget()</a></span><br>
+ <span class="method-name"><a href="../Fields/TextField.html#methodimport_value">TextField::import_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></span><br>
+ </blockquote>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methoderrors">PhormField::errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_attribute">PhormField::get_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_errors">PhormField::get_errors()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhelp_text">PhormField::help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodhtml">PhormField::html()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodis_valid">PhormField::is_valid()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodlabel">PhormField::label()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_attribute">PhormField::set_attribute()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_help_text">PhormField::set_help_text()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></span><br>
+ <span class="method-name"><a href="../Fields/PhormField.html#method__toString">PhormField::__toString()</a></span><br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Mon, 20 Apr 2009 08:29:21 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ </p>
+ </div></body>
+</html>
View
619 doc/Fields/FileField.html
@@ -0,0 +1,619 @@
+<?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 FileField</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 FileField</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-descendents">Descendents</a>
+ | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <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">FileField</p>
+<p class="description"><p>A field representing a file upload input.</p></p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Jeff Ober</li>
+ <li><span class="field">see:</span> <a href="../default/File.html">File</a></li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">303</span>)
+ </p>
+
+
+ <pre><a href="../Fields/PhormField.html">PhormField</a>
+ |
+ --FileField</pre>
+
+ </div>
+</div>
+
+ <a name="sec-descendents"></a>
+ <div class="info-box">
+ <div class="info-box-title">Direct descendents</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Descendents</span>
+ | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <table cellpadding="2" cellspacing="0" class="class-table">
+ <tr>
+ <th class="class-table-header">Class</th>
+ <th class="class-table-header">Description</th>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a href="../Fields/ImageField.html">ImageField</a></td>
+ <td>
+ ImageField
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-descendents">Descendents</a> |
+ <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div class="var-title">
+ <span class="var-type">mixed</span>
+ <a href="#$max_size" title="details" class="var-name">$max_size</a>
+ </div>
+ <div class="var-title">
+ <span class="var-type">mixed</span>
+ <a href="#$types" title="details" class="var-name">$types</a>
+ </div>
+ </div>
+ </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> |
+ <a href="#sec-descendents">Descendents</a> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">
+ <span class="method-result">FileField</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mime_types</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$max_size</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">string</span>