Class: HTML_QuickForm_file

Source Location: /HTML_QuickForm-3.2.14/QuickForm/file.php

Class Overview

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

HTML class for a file upload field

Author(s):

Alexey Borzov <avb at php.net>
Adam Daniel <adaniel1 at eesus.jnj.com>
Bertrand Mansion <bmansion at mamasam.com>

Version:

Release: 3.2.14

Inherited Variables

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

Class Details

[line 50]
HTML class for a file upload field

Author: Alexey Borzov <avb@php.net>
Author: Adam Daniel <adaniel1@eesus.jnj.com>
Author: Bertrand Mansion <bmansion@mamasam.com>
Version: Release: 3.2.14
Since: 1.0

[ Top ]

Method Detail

HTML_QuickForm_file (Constructor) [line 73]

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

Class constructor

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 ]

freeze [line 118]

bool freeze(
)

Freeze the element so that only its value is returned

Access: public

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

[ Top ]

getSize [line 104]

int getSize(
)

Returns size of file element

Since: 1.0
Access: public

[ Top ]

getValue [line 154]

array getValue(
)

Returns information about the uploaded file

Since: 3.0
Access: public

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

[ Top ]

isUploadedFile [line 224]

bool isUploadedFile(
)

Checks if the element contains an uploaded file

Return: true if file has been uploaded, false otherwise
Access: public

[ Top ]

moveUploadedFile [line 206]

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

Moves an uploaded file into the destination

Return: Whether the file was moved successfully
Access: public

Parameters:

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

[ Top ]

onQuickFormEvent [line 172]

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

Called by HTML_QuickForm whenever form event is made on this element

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 ]

setSize [line 89]

void setSize(
int
$size)

Sets size of file element

Since: 1.0
Access: public

Parameters:

int $size — Size of file element

[ Top ]

setValue [line 139]

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.

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 ]