Class Horde_Form_Type_image

Description

Horde_Form_Type Class

Located in /Form/Form.php (line 1752)

Horde_Form_Type
   |
   --Horde_Form_Type_image
Variable Summary
 array $_img
 integer $_max_filesize
 string $_random
 boolean $_show_keeporig
 boolean $_show_upload
 boolean $_uploaded
Method Summary
 void about ()
 array getImage ( $vars,  $var)
 void getInfo ( &$vars,  &$var,  &$info)
 void getRandomId ()
 void getUploadedFileType ( $field)
 void init ([ $show_upload = true], [ $show_keeporig = false], [ $max_filesize = null])
 void isValid ( &$var,  &$vars,  $value,  &$message)
 void loadImageData ( &$image, array $image)
 void onSubmit ( &$var,  &$vars)
 void _getUpload ( &$vars,  &$var)
Variables
array $_img (line 1787)

Hash containing the previously uploaded image info.

integer $_max_filesize = null (line 1780)

Limit the file size?

string $_random (line 1794)

A random id that identifies the image information in the session data.

boolean $_show_keeporig = false (line 1773)

Show the option to upload also original non-modified image?

boolean $_show_upload = true (line 1766)

Show the upload button?

boolean $_uploaded = null (line 1759)

Has a file been uploaded on this form submit?

Methods
about (line 2083)

Return info about field type.

void about ()
getImage (line 2030)

Returns the current image information.

  • return: The current image hash.
array getImage ( $vars,  $var)
  • $vars
  • $var
getInfo (line 1862)
void getInfo ( &$vars,  &$var,  &$info)
  • &$vars
  • &$var
  • &$info

Redefinition of:
Horde_Form_Type::getInfo()
getRandomId (line 2072)
void getRandomId ()
getUploadedFileType (line 1978)
void getUploadedFileType ( $field)
  • $field
init (line 1796)
void init ([ $show_upload = true], [ $show_keeporig = false], [ $max_filesize = null])
  • $show_upload
  • $show_keeporig
  • $max_filesize

Redefinition of:
Horde_Form_Type::init()
isValid (line 1819)
void isValid ( &$var,  &$vars,  $value,  &$message)
  • &$var
  • &$vars
  • $value
  • &$message

Redefinition of:
Horde_Form_Type::isValid()
loadImageData (line 2054)

Loads any existing image data into the image field. Requires that the array $image passed to it contains the structure: $image['load']['file'] - the filename of the image; $image['load']['data'] - the raw image data.

void loadImageData ( &$image, array $image)
  • array $image: The image array.
  • &$image
onSubmit (line 1803)
void onSubmit ( &$var,  &$vars)
  • &$var
  • &$vars

Redefinition of:
Horde_Form_Type::onSubmit()
_getUpload (line 1909)

Gets the upload and sets up the upload data array. Either fetches an upload done with this submit or retries stored upload info.

void _getUpload ( &$vars,  &$var)
  • &$vars
  • &$var

Inherited Methods

Inherited From Horde_Form_Type

 Horde_Form_Type::Horde_Form_Type()
 Horde_Form_Type::getInfo()
 Horde_Form_Type::getProperty()
 Horde_Form_Type::getTypeName()
 Horde_Form_Type::getValues()
 Horde_Form_Type::init()
 Horde_Form_Type::isValid()
 Horde_Form_Type::onSubmit()
 Horde_Form_Type::setProperty()
 Horde_Form_Type::__get()
 Horde_Form_Type::__set()

Documentation generated on Sun, 30 Jan 2011 05:17:30 +0000 by phpDocumentor 1.4.3