XCube_FormFile Class Reference

Inherited by XCube_FormImageFile.

Inheritance diagram for XCube_FormFile:

[legend]
List of all members.

Public Member Functions

 fetch ()
 getContentType ()
 getFileName ()
 getFileSize ()
 getExtension ()
 setExtension ($ext)
 setContentType ($contenttype)
 setFileName ($filename)
 setFileSize ($filesize)
 setBodyName ($bodyname)
 getBodyName ()
 setRandomToBodyName ($prefix, $salt=XOOPS_SALT)
 setRandomToFilename ($prefix, $salt=XOOPS_SALT)
 _getRandomString ($salt=XOOPS_SALT)
 Generate random string.
 saveAs ($file)
 saveAsRandBody ($dir, $prefix='', $salt=XOOPS_SALT)
 saveAsRand ($dir, $prefix='', $salt=XOOPS_SALT)

Detailed Description

WARNING: This class is simple wrapper class for proccessing the file uploaded. However, we have to examine the position of this class. We aims to simple file tree. This class is only helper. We think that Cube system shouldn't offer misc helper.

We put this class in root/class for the progress of this project. But, we will move this to other directory in the future.


Member Function Documentation

XCube_FormFile::fetch (  ) 

Fetch necessary information from $_FILES by $mName

Reimplemented in XCube_FormImageFile.

XCube_FormFile::getContentType (  ) 

Return content type

Returns:
string

XCube_FormFile::getFileName (  ) 

Return file name.

Returns:
string

XCube_FormFile::getFileSize (  ) 

Return file size.

Returns:
int

XCube_FormFile::getExtension (  ) 

Return extension from file name.

Returns:
string

XCube_FormFile::setExtension ( ext  ) 

Set extension.

Returns:
string

XCube_FormFile::setContentType ( contenttype  ) 

Set content type

Parameters:
$contenttype string

XCube_FormFile::setFileName ( filename  ) 

Set file name

Parameters:
$filename string

XCube_FormFile::setFileSize ( filesize  ) 

Set file size

Parameters:
$filesize int

XCube_FormFile::setBodyName ( bodyname  ) 

Set file body name. The extension is never changed.

Parameters:
$bodyname string

XCube_FormFile::getBodyName (  ) 

Get file body name.

Returns:
string

XCube_FormFile::setRandomToBodyName ( prefix,
salt = XOOPS_SALT 
)

Set random string to file body name. The extension is never changed.

Parameters:
$prefix string Prefix for random string.
$salt string Salt for generating token.

XCube_FormFile::setRandomToFilename ( prefix,
salt = XOOPS_SALT 
)

Set random string to file body name. The extension is changed.

Parameters:
$prefix string Prefix for random string.
$salt string Salt for generating token.

XCube_FormFile::_getRandomString ( salt = XOOPS_SALT  ) 

Generate random string.

Parameters:
$salt string Salt for generating token.
Returns:
string

XCube_FormFile::saveAs ( file  ) 

Name this, and store it. If the name is specified as complete file name, store it as the same name. If the name is specified as directory name, store it as the own name to the directory specified.

Parameters:
$file Directory path or file path.
Returns:
bool

XCube_FormFile::saveAsRandBody ( dir,
prefix = '',
salt = XOOPS_SALT 
)

Set random string to file body name, and store it. The extension is never changed.

See also:
saveAs()

setRandomToBodyName()

Parameters:
$dir Directory for store.
$prefix string Prefix for random string.
$salt string Salt for generating token.
Returns:
bool

XCube_FormFile::saveAsRand ( dir,
prefix = '',
salt = XOOPS_SALT 
)

Set random string to file name, and store it. The extension is never changed.

See also:
saveAs()

setRandomToFileName()

Parameters:
$dir Directory for store.
$prefix string Prefix for random string.
$salt string Salt for generating token.
Returns:
bool


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:22 2006 for XOOPS Cube Legacy by  doxygen 1.5.1