[default] element index

All elements
a c d e f g h i j l m p r s t _
_
top
Variable $_allowableTags
HTML tags that will not be stripped
Variable $_allowedExtensions
Allowed file extensions
Variable $_allowWhiteSpace
Whether to allow white space characters; off by default
Variable $_allowWhiteSpace
Whether to allow white space characters; off by default
Variable $_attachmentElements
Email attachment elements, an array of iPhorm_Element_File's
Variable $_autoReply
The autoreply information
Variable $_charset
Charset
Variable $_charset
iPhorm::$_charset in iPhorm.php
Character encoding to use
Variable $_dbname
Mysql database name
Variable $_elementMap
The mapping of elements to upload locations on the server
Variable $_elements
iPhorm::$_elements in iPhorm.php
The elements of the form
Variable $_errors
Error messages
Variable $_fieldMap
A mapping of element names to table field names
Variable $_fileUploadValidator
File upload validator
Variable $_filters
Element filters
Variable $_form
The form
Variable $_form
The form
Variable $_form
iPhorm_Element::$_form in Element.php
The form this element belongs to
Variable $_fromAddress
Email from address, if set will override using the form submitted email
Variable $_host
Mysql host
Variable $_isArray
Is the element in an array?
Variable $_isMultiple
Is the element multiple input e.g. multiple select
Variable $_label
Element label
Variable $_max
Maximum value
Variable $_max
Maximum length. If null, there is no maximum length
Variable $_maximumFileSize
Maximum file size in bytes
Variable $_messages
Variable $_min
Minimum value
Variable $_min
Minimum length
Variable $_name
iPhorm_Element::$_name in Element.php
Element name
Variable $_name
The name of the element to check in the $_FILES array
Variable $_password
Mysql password
Variable $_recipients
The recipients of the email
Variable $_required
Required flag
Variable $_requiredCount
How many files are required for a multiple upload element, 0 = all
Variable $_skipRender
Success handlers should skip this element
Variable $_skipRender
Should the element be skipped by success handlers
Variable $_strict
Whether to check type as well as value
Variable $_subject
The email subject
Variable $_successHandlers
Form success handlers
Variable $_successMessage
The message to display when the form is successfully submitted
Variable $_successRedirect
URL to redirect to on success
Variable $_table
Mysql table name
Variable $_token
The token to check
Variable $_username
Mysql username
Variable $_validators
Element validators
Variable $_value
Element value
Method _dissolveArrayValue
Extract the value by walking the array using given array path.
Method _filterValue
Filter the given value by reference
Method _filterValueRecursive
Recursively filter the given value by reference
Method _formatMessage
Format a message with wrapping HTML <div> with classes. The message should be escaped beforehand for display in the browser, using htmlentities() for example
Method _generateFilename
Generate a filename that does not already exist in the given path
Method _getEmailBodyHtml
Get the email body in HTML. Retrieves the contents of email-html.php in the iPhorm root folder
Method _getEmailBodyPlain
Get the email body in plain text. Retrieves the contents of email-plain.php in the iPhorm root folder
Method _getFileUploadError
Get the error message corresponding to the error code generated by PHP file uploads and this validator
Method _getPlaceholderValue
Get the form value of a single placeholder
Method _loadFilter
Load the filter instance from the given name
Method _loadValidator
Load the validator instance from the given name
Method _prettyName
iPhorm::_prettyName() in iPhorm.php
Get the pretty version of the form element name. Translates the machine name to a more human readable format. E.g.
Method _prettyName
Get the pretty version of the form element name. Translates the machine name to a more human readable format. E.g.
Method _replacePlaceholderValues
Replace all placeholder values in a string with their form value equivalents
Method __construct
Method __construct
Method __construct
Method __construct
Method __construct
Method __construct
Class constructor
Method __construct
Method __construct
Class constructor
Method __construct
Sets validator options
Method __construct
Method __construct
Class constructor
Method __construct
a
top
Method addAttachmentElement
Add an attachment element, the uploaded file will be added as an attachment to the email
Method addElement
iPhorm::addElement() in iPhorm.php
Add a single element to the form
Method addElements
iPhorm::addElements() in iPhorm.php
Add multiple elements to the form
Method addFilter
Add a filter
Method addFilters
Add multiple filters
Method addMessage
Method addRecipient
Add a single recipient
Method addRecipients
Add multiple recipients
Method addSuccessHandler
Add a success handler to the form
Method addValidator
Add a validator
Method addValidators
Add mutliple validators
Method autoload
iPhorm::autoload() in iPhorm.php
Internal autoloader for spl_autoload_register().
Page Alpha.php
Alpha.php in Alpha.php
Page AlphaNumeric.php
AlphaNumeric.php in AlphaNumeric.php
Page Abstract.php
Abstract.php in Abstract.php
Page Abstract.php
Abstract.php in Abstract.php
Page Alpha.php
Alpha.php in Alpha.php
Page AlphaNumeric.php
AlphaNumeric.php in AlphaNumeric.php
c
top
Method check_domain_portion
Checks email section after "@" symbol for validity
Method check_local_portion
Checks email section before "@" symbol for validity
Method check_text_length
Check given text length is between defined bounds
Method clearFilters
Remove all filters
Method clearRecipients
Removes all recipients
Method clearValidators
Remove all validators
Page Captcha.php
Captcha.php in Captcha.php
d
top
Page Digits.php
Digits.php in Digits.php
Page Digits.php
Digits.php in Digits.php
e
top
Method escape
iPhorm::escape() in iPhorm.php
Escapes a value for output to browser. Uses the set character encoding.
Page Element.php
Element.php in Element.php
Page Email.php
Email.php in Email.php
Page Email.php
Email.php in Email.php
f
top
Method filter
Method filter
Strips all HTML tags from the given value.
Method filter
Trims whitespace and other characters from the beginning and end of the given value.
Method filter
Filter everything from the given value except alphabet characters
Method filter
Replaces all non-alphanumeric characters with a dash
Method filter
Filter everything from the given value except alpha-numeric characters
Method filter
Filter everything from the given value except digits
Page File.php
File.php in File.php
Page Filename.php
Filename.php in Filename.php
Page FileStorage.php
FileStorage.php in FileStorage.php
Page FileUpload.php
FileUpload.php in FileUpload.php
g
top
Method getAllowableTags
Get the allowable tags
Method getAllowedExtensions
Get the allowed extensions
Method getAllowedExtensions
Get the allowed extensions
Method getAllowWhiteSpace
Method getAllowWhiteSpace
Method getAttachmentElements
Get all the attachment elements
Method getCharset
iPhorm::getCharset() in iPhorm.php
Get the character encoding
Method getElementMap
Get the element map
Method getElements
iPhorm::getElements() in iPhorm.php
Get all of the form elements
Method getErrors
Get the error messages
Method getErrors
iPhorm::getErrors() in iPhorm.php
Get the elements and any errors they have
Method getFileUploadValidator
Get this elements file upload validator
Method getFilter
Get the filter with the given name
Method getFilters
Get the filters
Method getForm
Get the form
Method getForm
Get the form the element belongs to
Method getFromAddress
Get the from address
Method getFullyQualifiedName
Get the fully qualified name of the element
Method getIsArray
Is the element an array?
Method getIsMultiple
Does this element have multiple values?
Method getLabel
Get the label of the element
Method getMax
Get the maximum length
Method getMax
Get the maximum value
Method getMaximumFileSize
Get the maximum file size in bytes
Method getMaximumFileSize
Get the maximum allowable file size in bytes
Method getMessages
Method getMessages
Method getMin
Get the minimum length
Method getMin
Get the minimum value
Method getName
Get the name of the element
Method getName
Get the name of the element
Method getRawSubject
Get the subject
Method getRecipients
Get the recipients
Method getRequired
Is this element required?
Method getRequired
Get whether the file is required or not
Method getRequiredCount
Get the count for required files for a multiple upload field
Method getRequiredCount
Get the number of required uploads
Method getSkipRender
Should the element be skipped during rendering
Method getStrict
Get the strict flag
Method getSubject
Get the subject with placeholder values replaced
Method getSuccessHandlers
Get all success handlers
Method getSuccessMessage
Get the success message
Method getSuccessRedirect
Get the URL to redirect to on success
Method getToken
Get the token
Method getValidator
Get the validator with the given name
Method getValidators
Get the validators
Method getValue
iPhorm::getValue() in iPhorm.php
Get the values of a single field
Method getValue
Get the filtered value
Method getValues
iPhorm::getValues() in iPhorm.php
Get the values of all fields
Method getValueUnfiltered
Get the unfiltered (raw) value
Page GreaterThan.php
GreaterThan.php in GreaterThan.php
h
top
Method hasErrors
Does the element have errors?
Method hasFilter
Does the element have the given filter?
Method hasFilters
Does this element have filters?
Method hasValidator
Does the element have the given validator?
Method hasValidators
Does the element have any validators?
i
top
Class iPhorm
iPhorm in iPhorm.php
Page Interface.php
Interface.php in Interface.php
Page Interface.php
Interface.php in Interface.php
Page Identical.php
Identical.php in Identical.php
Page Interface.php
Interface.php in Interface.php
Page iPhorm.php
iPhorm.php in iPhorm.php
Class iPhorm_Element
iPhorm_Element in Element.php
Class iPhorm_Element_File
Class iPhorm_Filter_Alpha
iPhorm_Filter_Alpha in Alpha.php
Alpha Filter
Class iPhorm_Filter_AlphaNumeric
iPhorm_Filter_AlphaNumeric in AlphaNumeric.php
Alpha Numeric Filter
Class iPhorm_Filter_Digits
iPhorm_Filter_Digits in Digits.php
Digits Filter
Class iPhorm_Filter_Filename
iPhorm_Filter_Filename in Filename.php
Filename Filter
Class iPhorm_Filter_Interface
iPhorm_Filter_Interface in Interface.php
Filter Interface
Class iPhorm_Filter_StripTags
iPhorm_Filter_StripTags in StripTags.php
Strip Tags Filter
Class iPhorm_Filter_Trim
iPhorm_Filter_Trim in Trim.php
Trim Filter
Class iPhorm_SuccessHandler_Abstract
Class iPhorm_SuccessHandler_Email
Class iPhorm_SuccessHandler_FileStorage
Class iPhorm_SuccessHandler_Interface
Class iPhorm_SuccessHandler_Mysql
Constant IPHORM_UPLOAD_ERR_FILE_SIZE
IPHORM_UPLOAD_ERR_FILE_SIZE in FileUpload.php
Constant IPHORM_UPLOAD_ERR_NOT_UPLOADED
Constant IPHORM_UPLOAD_ERR_TYPE
IPHORM_UPLOAD_ERR_TYPE in FileUpload.php
Class iPhorm_Validator_Abstract
Validator Abstract Class
Class iPhorm_Validator_Alpha
Alpha Validator
Class iPhorm_Validator_AlphaNumeric
iPhorm_Validator_AlphaNumeric in AlphaNumeric.php
Alpha Numeric Validator
Class iPhorm_Validator_Captcha
Captcha Validator
Class iPhorm_Validator_Digits
Digits Validator
Class iPhorm_Validator_Email
Validator Abstract Class
Class iPhorm_Validator_FileUpload
iPhorm_Validator_FileUpload in FileUpload.php
FileUpload Validator
Class iPhorm_Validator_GreaterThan
iPhorm_Validator_GreaterThan in GreaterThan.php
GreaterThan Validator
Class iPhorm_Validator_Identical
Identical Validator
Class iPhorm_Validator_Interface
Validator Interface
Class iPhorm_Validator_LessThan
LessThan Validator
Class iPhorm_Validator_Required
Required Validator
Class iPhorm_Validator_StringLength
iPhorm_Validator_StringLength in StringLength.php
String Length Validator
Method isValid
Returns true if the given value contains only alpha-numeric characters.
Method isValid
Returns true if and only if $value is less than max option
Method isValid
Compares the given value with the captcha value saved in session. Also sets the error message.
Method isValid
Returns true if and only if the string length of $value is at least the min option and no greater than the max option (when the max option is not null).
Method isValid
Checks whether the given value is not empty. Also sets the error message if value is empty.
Method isValid
Returns true if the given value contains only alphabet characters.
Method isValid
Returns true if the given value contains only digits.
Method isValid
Method isValid
Returns true if and only if $value is greater than min option
Method isValid
Returns true if the given value is equal to the set value Return false otherwise.
Method isValid
Returns true if and only if the uploaded file is free of errors
Method isValid
Is the uploaded file valid?
Method isValid
Is the given value valid?
Method isValid
Check email address validity
Method isValid
iPhorm::isValid() in iPhorm.php
Is the form valid?
j
top
Method jsonEncode
iPhorm::jsonEncode() in iPhorm.php
Encode PHP data in JSON
l
top
Page LessThan.php
LessThan.php in LessThan.php
m
top
Page Mysql.php
Mysql.php in Mysql.php
p
top
Method process
iPhorm::process() in iPhorm.php
Process the form. Checks the validity of the form.
r
top
Page Required.php
Required.php in Required.php
Method registerAutoload
Configure autoloading of iPhorm classes
Method removeFilter
Remove a filter with the given name
Method removeValidator
Remove a validator with the given name
Method run
Insert the submitted form into the specified Mysql database.
Method run
Run the handler. Move the elements specified in the element map to their set paths.
Method run
Sends the email to the set recipients
Method run
s
top
Page StripTags.php
StripTags.php in StripTags.php
Page StringLength.php
StringLength.php in StringLength.php
Method setAllowableTags
Set the allowable tags
Method setAllowedExtensions
Set the allowed extensions
Method setAllowedExtensions
Set the allowed extensions, an array of lowercase extensions e.g. array('jpg', 'jpeg', 'gif'). An empty array means all file extensions are allowed
Method setAllowWhiteSpace
Method setAllowWhiteSpace
Method setAutoReply
Sets the autoreply information to send an autoreply to the form user
Method setCharset
iPhorm::setCharset() in iPhorm.php
Set the character encoding
Method setConfig
Sets the database configuration settings
Method setElementMap
Set the element map
Method setFieldMap
Set the field map, which maps a form element name to a database table field name.
Method setFilters
Set the filters, overrides previously added filters
Method setForm
Set the form
Method setForm
Set the form the element belongs to
Method setForm
Set the form
Method setFromAddress
Set the from address
Method setIsArray
Set the flag to indicate that the element is an array.
Method setIsMultiple
Set the flag that the element can have multiple values.
Method setLabel
Set the label of the element
Method setMax
Sets the maximum value
Method setMax
Set the maximum length
Method setMaximumFileSize
Set the maximum file size in bytes
Method setMaximumFileSize
Set the maximum allowable file size in bytes
Method setMin
Sets the minimum value
Method setMin
Set the minimum length
Method setName
Set the name of the element
Method setName
Set the name of the element to validate in $_FILES
Method setRecipients
Set the recipients of the enquiry
Method setRequired
Sets whether the element is required or not
Method setRequired
Set if the element is required
Method setRequired
Set whether the file is required or not
Method setRequiredCount
Set the number of required uploads for a multiple upload element
Method setRequiredCount
Set the count for required files for a multiple upload field
Method setSkipRender
Set whether or not the value should be rendered by success handlers
Method setStrict
Set the strict flag
Method setSubject
Set the subject
Method setSuccessMessage
Set the success message show after the form is successfully submitted
Method setSuccessRedirect
Set the URL to redirect to on success
Method setToken
Set the token
Method setValidators
Set the validators, overrides previously added validators
Method setValue
Set the value
t
top
Page Trim.php
Trim.php in Trim.php
a c d e f g h i j l m p r s t _