Docs For Class WFileUploadField

Description

This adds an input type='text' field to a Wizard.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WFileUploadField.class.php,v 1.5 2007/09/19 14:04:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: Jul 21, 2005

Located in /polyphony/main/library/Wizard/Components/WFileUploadField.class.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WFileUploadField

Variable Summary

mixed $_accept

mixed $_changed

mixed $_errString

mixed $_filename

mixed $_hdfile

mixed $_mimetype

mixed $_size

mixed $_startingDisplayFilename

mixed $_startingDisplaySize

mixed $_style

Method Summary

mixed getAllValues ()

string getMarkup (string $fieldName)

void setAcceptedMimetypes (array $types)

void setFile (string $path, [optional $filename = null])

void setStartingDisplay (mixed $filename, mixed $size, string $text)

void setStyle (string $style)

void setValue (array $values)

boolean update (string $fieldName)

Variables

mixed $_accept = array () (line 39)

mixed $_changed = false (line 34)

mixed $_errString = null (line 37)

mixed $_filename = null (line 31)

mixed $_hdfile = null (line 32)

mixed $_mimetype = null (line 35)

mixed $_size = null (line 33)

mixed $_startingDisplayFilename (line 41)

mixed $_startingDisplaySize (line 42)

mixed $_style = null (line 30)

Inherited Variables

Inherited from WizardComponent

WizardComponent::$_enabled
WizardComponent::$_enabledSticky
WizardComponent::$_parent

Methods

getAllValues (line 189)

For file upload, returns an array:

name => the original name of the file size => the size in bytes of the file type => the mimetype of the file (if the browser supplied it) tmp_name => the location on the hard drive of the file

access: public

mixed getAllValues ()

Redefinition of:

WizardComponent::getAllValues(): Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.

getMarkup (line 206)

Returns a block of XHTML-valid code that contains markup for this specific component.

access: public

string getMarkup (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefinition of:

WizardComponent::getMarkup(): Returns a block of XHTML-valid code that contains markup for this specific component.

setAcceptedMimetypes (line 60)

Sets the accepted mimetypes (passed to the browser).

access: public

void setAcceptedMimetypes (array $types)

array $types

setFile (line 72)

Tells this field to use the passed file on the filesystem as a starting value. If $filename is passed, it is used as the display filename instead of the basename of the path.

access: public

void setFile (string $path, [optional $filename = null])

string $path
optional $filename: string $filename

setStartingDisplay (line 84)

Sets the values of the field to display until the user enters the field.

access: public

void setStartingDisplay (mixed $filename, mixed $size, string $text)

string $text

setStyle (line 50)

Sets the CSS style of this field.

access: public

void setStyle (string $style)

string $style

setValue (line 97)

Sets the values of this field. This is needed when the field is part of a repeatable collection.

access: public

void setValue (array $values)

array $values

update (line 128)

Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

return: - TRUE if everything is OK
access: public

boolean update (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefinition of:

WizardComponent::update(): Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

Inherited Methods

Inherited From WizardComponent

WizardComponent::getAllValues()
WizardComponent::getMarkup()
WizardComponent::getWizard()
WizardComponent::isEnabled()
WizardComponent::setEnabled()
WizardComponent::setParent()
WizardComponent::update()
WizardComponent::validate()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()