[Fields] element index

Package indexes

All elements
a b c d e f g h i l m o p r s t u v _
_
top
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__toString
Serializes the field to HTML.
a
top
$attributes
Associative array of key/value pairs representing HTML attributes of the field.
b
top
BooleanField
BooleanField in fields.php
BooleanField
c
top
$checked
True when the field is checked (true).
$choices
Stores the field options as actual_value=>display_value.
$choices
An array storing the drop-down's choices.
d
top
DateTimeField
DateTimeField in fields.php
DateTimeField
DecimalField
DecimalField in fields.php
DecimalField
DropDownField
DropDownField in fields.php
DropDownField
e
top
$errors
PhormField::$errors in fields.php
Array storing errors generated during field validation.
EmailField
EmailField in fields.php
EmailField
errors
PhormField::errors() in fields.php
Returns the field's errors as an unordered list with the class "phorm_error".
f
top
$format
ScanField::$format in fields.php
The sscanf() format.
fields.php
fields.php in fields.php
FileField
FileField in fields.php
FileField
file_upload_error
Returns an error message for a file upload error code.
file_was_uploaded
Returns true if the file was uploaded without an error.
g
top
get_attribute
Returns the value of an HTML attribute or null if not set.
get_errors
Returns a list of errors generated during validation. If the field is not yet validated, returns null.
get_file
Returns a new Image.
get_file
FileField::get_file() in fields.php
Returns a new File instance for this field's data.
get_file_data
Returns an array of file upload data.
get_value
Returns true if the field is checked.
get_value
Returns the "cleaned" value of the field.
get_widget
Returns a PasswordWidget.
get_widget
Defined in derived classes; must return an instance of PhormWidget.
get_widget
Returns a new OptionGroupWidget.
get_widget
Returns a new CharWidget.
get_widget
Returns a new CharWidget.
get_widget
Returns a new CharWidget.
get_widget
Returns a new CheckboxWidget.
get_widget
Returns a new SelectWidget.
get_widget
Returns a FileWidget.
get_widget
Returns a new TextWidget.
get_widget
Returns a new HiddenWidget.
get_widget
Returns a new MultiSelectWidget.
h
top
$hash_function
The hash function to encode the user-submitted value.
$help_text
Help text for the field. This is printed out with the field HTML.
help_text
Returns an HTML string containing the field's help text.
help_text
Does not print out the help text.
HiddenField
HiddenField in fields.php
HiddenField
html
PhormField::html() in fields.php
Returns the field's tag as HTML.
i
top
$imported
PhormField::$imported in fields.php
Storage of the "cleaned" field value.
ImageField
ImageField in fields.php
ImageField
import_value
Returns a hash-encoded value.
import_value
Returns the field's "imported" 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.
import_value
Returns the captured values that were parsed inside validate().
import_value
Imports the value by decoding HTML entities.
import_value
Returns the parsed matches that were captured in validate().
import_value
Imports the value as an array of the actual values (from $this->choices.)
import_value
Imports the value by decoding HTML entities.
import_value
Returns the parsed float, rounded to $this->precision digits.
import_value
Imports the value and returns a unix timestamp (the number of seconds
import_value
Imports the value by decoding any HTML entities. Returns the "actual" value of the option selected.
import_value
On a successful upload, returns a new File instance.
import_value
Parses the value as an integer.
import_value
Returns true if the field was checked in the user-submitted data, false otherwise.
IntegerField
IntegerField in fields.php
IntegerField
is_valid
On the first call, calls each validator on the field value, and returns
l
top
$label
PhormField::$label in fields.php
The field's text label.
label
HiddenField::label() in fields.php
Does not print out a label.
label
PhormField::label() in fields.php
Returns the HTML field label.
LargeTextField
LargeTextField in fields.php
LargeTextField
m
top
$matched
ScanField::$matched in fields.php
Storage for the matched values to prevent calling sscanf twice.
$matches
RegexField::$matches in fields.php
Storage for matches during validation so that the expression needn't run twice.
$max_digits
Stores the max number of digits permitted.
$max_length
Stores the maximum value length in characters.
$max_size
FileField::$max_size in fields.php
Stores the maximum size boundary in bytes.
$message
RegexField::$message in fields.php
The error message thrown when unmatched.
$message
ScanField::$message in fields.php
The error message on match failure.
$multi_field
If true, this field uses multiple field widgets.
$multi_field
Specifies that this field's name attribute must be post-fixed by [].
MultipleChoiceField
MultipleChoiceField in fields.php
MultipleChoiceField
o
top
OptionsField
OptionsField in fields.php
OptionsField
p
top
$precision
The maximum precision of the field's value.
PasswordField
PasswordField in fields.php
PasswordField
PhormField
PhormField in fields.php
PhormField
prepare_value
Prepares the value by inserting http:// to the beginning if missing.
prepare_value
Pre-processes a value for validation, handling magic quotes if used.
prepare_value
Returns the file's $_FILES data array or false if the file was not uploaded.
prepare_value
Returns the value.
r
top
$regex
RegexField::$regex in fields.php
The (pcre) regular expression.
RegexField
RegexField in fields.php
RegexField
s
top
ScanField
ScanField in fields.php
ScanField
set_attribute
Sets an HTML attribute of the field.
set_help_text
Assigns help text to the field.
set_value
Sets the value of the field.
set_value
Sets the value of the field.
t
top
$types
FileField::$types in fields.php
Stores the valid types for this field.
TextField
TextField in fields.php
TextField
u
top
URLField
URLField in fields.php
URLField
v
top
$valid
PhormField::$valid in fields.php
Stores the result of field validation to prevents double-validation.
$validators
Array of callbacks used to validate field data. May be either a string denoting a function or an array of array(instance, string method) to use a class instance method.
$value
PhormField::$value in fields.php
Store's the field's value. Set during validation.
validate
Raises a ValidationError if $value is invalid.
validate
ScanField::validate() in fields.php
Validates that the value matches the sscanf format.
validate
URLField::validate() in fields.php
Validates the the value is a valid URL (mostly).
validate
TextField::validate() in fields.php
Validates that the value is less than $this->max_length;
validate
Validates that the value matches the regular expression.
validate
Validates that each of the selected choice exists in $this->choices.
validate
Validates that $value is present in $this->choices.
validate
Validates that the value is parsable as a float.
validate
Validates that the value is parsable as a date/time value.
validate
Returns null.
validate
Validates that the value is a valid email address.
validate
Returns null.
validate
Validates that the value is parsable as an integer and that it is fewer than $this->max_digits digits.
validate
FileField::validate() in fields.php
Throws a ValidationError if the file upload resulted in an error, if the file was not a valid type, or if the file exceded the maximum size.
ValidationError
ValidationError in fields.php
ValidationError
a b c d e f g h i l m o p r s t u v _