Class: HTML_QuickForm_file

Source Location: /main/inc/lib/pear/HTML/QuickForm/file.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_input
         |
         --HTML_QuickForm_file

HTML class for a file type element

Author(s):

Adam Daniel <adaniel1@eesus.jnj.com>
Bertrand Mansion <bmansion@mamasam.com>

Version:

Inherited Variables

Class: HTML_QuickForm_element

HTML_QuickForm_element::$_flagFrozen
HTML_QuickForm_element::$_label
HTML_QuickForm_element::$_persistantFreeze
HTML_QuickForm_element::$_type

Class: HTML_Common

HTML_Common::$_attributes
HTML_Common::$_comment
HTML_Common::$_lineEnd
HTML_Common::$_tab
HTML_Common::$_tabOffset

Inherited Methods

Class: HTML_QuickForm_input

HTML_QuickForm_input::HTML_QuickForm_input(): Class constructor
HTML_QuickForm_input::exportValue(): We don't need values from button-type elements (except submit) and files
HTML_QuickForm_input::getName(): Returns the element name
HTML_QuickForm_input::getValue(): Returns the value of the form element
HTML_QuickForm_input::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_input::setName(): Sets the input field name
HTML_QuickForm_input::setType(): Sets the element type
HTML_QuickForm_input::setValue(): Sets the value of the form element
HTML_QuickForm_input::toHtml(): Returns the input field in HTML

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element(): Class constructor
HTML_QuickForm_element::accept(): Accepts a renderer
HTML_QuickForm_element::apiVersion(): Returns the current API version
HTML_QuickForm_element::exportValue(): Returns a 'safe' element's value
HTML_QuickForm_element::freeze(): Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel(): Returns display text for the element
HTML_QuickForm_element::getName(): Returns the element name
HTML_QuickForm_element::getType(): Returns element type
HTML_QuickForm_element::getValue(): Returns the value of the form element
HTML_QuickForm_element::isFrozen(): Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel(): Sets display text for the element
HTML_QuickForm_element::setName(): Sets the input field name
HTML_QuickForm_element::setPersistantFreeze(): Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue(): Sets the value of the form element
HTML_QuickForm_element::unfreeze(): Unfreezes the element so that it becomes editable
HTML_QuickForm_element::_findValue(): Tries to find the element value from the values array
HTML_QuickForm_element::_generateId(): Automatically generates and assigns an 'id' attribute for the element.
HTML_QuickForm_element::_getPersistantData(): Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
HTML_QuickForm_element::_prepareValue(): Used by exportValue() to prepare the value for returning

Class: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::display(): Displays the HTML to the screen
HTML_Common::getAttribute(): Returns the value of the given attribute
HTML_Common::getAttributes(): Returns the assoc array (default) or string of attributes
HTML_Common::getComment(): Returns the HTML comment
HTML_Common::getTabOffset(): Returns the tabOffset
HTML_Common::removeAttribute(): Removes an attribute
HTML_Common::setAttributes(): Sets the HTML attributes
HTML_Common::setComment(): Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd(): Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab(): Sets the string used to indent HTML
HTML_Common::setTabOffset(): Sets the tab offset
HTML_Common::toHtml(): Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes(): Updates the passed attributes without changing the other existing attributes
HTML_Common::_getAttrKey(): Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString(): Returns an HTML formatted attribute string
HTML_Common::_getLineEnd(): Returns the lineEnd
HTML_Common::_getTab(): Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs(): Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes(): Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr(): Removes the given attribute from the given array
HTML_Common::_updateAttrArray(): Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 41]
HTML class for a file type element

Tags:

author:	Adam Daniel <adaniel1@eesus.jnj.com>
author:	Bertrand Mansion <bmansion@mamasam.com>
version:	1.0
since:	PHP4.04pl1
access:	public

[ Top ]

Class Variables

$_value = null

[line 49]

Uploaded file data, from $_FILES

Type:

array

[ Top ]

Class Methods

constructor HTML_QuickForm_file [line 64]

HTML_QuickForm_file HTML_QuickForm_file(
[string
$elementName = null], [string
$elementLabel = null], [mixed
$attributes = null])

Class constructor

Tags:

since:	1.0
access:	public

Parameters:

string	$elementName	Input field name attribute
string	$elementLabel	Input field label
mixed	$attributes	(optional)Either a typical HTML attribute string or an associative array

[ Top ]

method freeze [line 109]

bool freeze(
)

Freeze the element so that only its value is returned

Tags:

access:

public

Overrides HTML_QuickForm_element::freeze() (Freeze the element so that only its value is returned)

[ Top ]

method getSize [line 95]

int getSize(
)

Returns size of file element

Tags:

since:	1.0
access:	public

[ Top ]

method getValue [line 145]

array getValue(
)

Returns information about the uploaded file

Tags:

since:	3.0
access:	public

Overrides HTML_QuickForm_input::getValue() (Returns the value of the form element)

[ Top ]

method isUploadedFile [line 215]

bool isUploadedFile(
)

Checks if the element contains an uploaded file

Tags:

return:	true if file has been uploaded, false otherwise
access:	public

[ Top ]

method moveUploadedFile [line 197]

bool moveUploadedFile(
string
$dest, [string
$fileName = ''])

Moves an uploaded file into the destination

Tags:

return:	Whether the file was moved successfully
access:	public

Parameters:

string	$dest	Destination directory path
string	$fileName	New file name

[ Top ]

method onQuickFormEvent [line 163]

bool onQuickFormEvent(
string
$event, mixed
$arg, object calling
&$caller)

Called by HTML_QuickForm whenever form event is made on this element

Tags:

since:	1.0
access:	public

Overrides HTML_QuickForm_input::onQuickFormEvent() (Called by HTML_QuickForm whenever form event is made on this element)

Parameters:

string	$event	Name of event
mixed	$arg	event arguments
object calling	&$caller	object

[ Top ]

method setSize [line 80]

void setSize(
int
$size)

Sets size of file element

Tags:

since:	1.0
access:	public

Parameters:

int

$size

Size of file element

[ Top ]

method setValue [line 130]

void setValue(
mixed
$value)

Sets value for file element.

Actually this does nothing. The function is defined here to override HTML_Quickform_input's behaviour of setting the 'value' attribute. As no sane user-agent uses <input type="file">'s value for anything (because of security implications) we implement file's value as a read-only property with a special meaning.

Tags:

since:	3.0
access:	public

Overrides HTML_QuickForm_input::setValue() (Sets the value of the form element)

Parameters:

mixed

$value

Value for file element

[ Top ]

method _findValue [line 316]

mixed _findValue(
)

Tries to find the element value from the values array

Needs to be redefined here as $_FILES is populated differently from other arrays when element name is of the form foo[bar]

Tags:

access:

private

Overrides HTML_QuickForm_element::_findValue() (Tries to find the element value from the values array)

[ Top ]

method _ruleCheckFileName [line 296]

bool _ruleCheckFileName(
array
$elementValue, string
$regex)

Checks if the given element contains an uploaded file of the filename regex

Tags:

return:	true if name matches regex, false otherwise
access:	private

Parameters:

array	$elementValue	Uploaded file info (from $_FILES)
string	$regex	Regular expression

[ Top ]

method _ruleCheckMaxFileSize [line 251]

bool _ruleCheckMaxFileSize(
array
$elementValue, int
$maxSize)

Checks that the file does not exceed the max file size

Tags:

return:	true if filesize is lower than maxsize, false otherwise
access:	private

Parameters:

array	$elementValue	Uploaded file info (from $_FILES)
int	$maxSize	Max file size

[ Top ]

method _ruleCheckMimeType [line 274]

bool _ruleCheckMimeType(
array
$elementValue, mixed
$mimeType)

Checks if the given element contains an uploaded file of the right mime type

Tags:

return:	true if mimetype is correct, false otherwise
access:	private

Parameters:

array	$elementValue	Uploaded file info (from $_FILES)
mixed	$mimeType	Mime Type (can be an array of allowed types)

[ Top ]

method _ruleIsUploadedFile [line 230]

bool _ruleIsUploadedFile(
array
$elementValue)

Checks if the given element contains an uploaded file

Tags:

return:	true if file has been uploaded, false otherwise
access:	private

Parameters:

array

$elementValue

Uploaded file info (from $_FILES)

[ Top ]

Documentation generated on Thu, 12 Jun 2008 13:28:27 -0500 by phpDocumentor 1.4.1