XCube_FormFile Class Reference

Inheritance diagram for XCube_FormFile:

Public Member Functions
	__construct ( $name=null, $key=null)
	fetch ()
	hasUploadFile ()
	getContentType ()
	getFileData ()
	getFileName ()
	getFileSize ()
	getExtension ()
	setExtension ( $ext)
	setContentType ( $contenttype)
	setFileName ( $filename)
	setFileSize ( $filesize)
	setBodyName ( $bodyname)
	getBodyName ()
	setRandomToBodyName ( $prefix, $salt='')
	setRandomToFilename ( $prefix, $salt='')
	_getRandomString ( $salt='')
	Generate random string.
	saveAs ( $file)
	saveAsRandBody ( $dir, $prefix='', $salt='')
	saveAsRand ( $dir, $prefix='', $salt='')

Data Fields
	$mName
	$mKey
	$mContentType
	$mFileName
	$mFileSize = 0
	$_mTmpFileName
	$mUploadFileFlag = false

Detailed Description

Definition at line 25 of file XCube_FormFile.class.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$name = null,
			$key = null )

Definition at line 39 of file XCube_FormFile.class.php.

Member Function Documentation

_getRandomString()

_getRandomString

(

$salt = ''

)

Generate random string.

Parameters

string

$salt

Salt for generating token.

Returns

string

Definition at line 203 of file XCube_FormFile.class.php.

fetch()

fetch

(

)

Fetch necessary information from $_FILES by $mName

Reimplemented in XCube_FormImageFile.

Definition at line 47 of file XCube_FormFile.class.php.

getBodyName()

getBodyName

(

)

Get file body name.

Returns

string

Definition at line 167 of file XCube_FormFile.class.php.

getContentType()

getContentType

(

)

Return content type

Returns

string

Definition at line 75 of file XCube_FormFile.class.php.

getExtension()

getExtension

(

)

Return extension from file name.

Returns

string

Definition at line 103 of file XCube_FormFile.class.php.

getFileData()

getFileData

(

)

Definition at line 79 of file XCube_FormFile.class.php.

getFileName()

getFileName

(

)

Return file name.

Returns

string

Definition at line 87 of file XCube_FormFile.class.php.

getFileSize()

getFileSize

(

)

Return file size.

Returns

int

Definition at line 95 of file XCube_FormFile.class.php.

hasUploadFile()

hasUploadFile

(

)

Definition at line 67 of file XCube_FormFile.class.php.

saveAs()

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

Directory

$file

path or file path.

Returns

bool

Definition at line 222 of file XCube_FormFile.class.php.

saveAsRand()

saveAsRand	(		$dir,
			$prefix = '',
			$salt = '' )

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

Parameters

Directory	$dir	for store.
string	$prefix	Prefix for random string.
string	$salt	Salt for generating token.

Returns

bool

See also

saveAs()

setRandomToFileName()

Definition at line 269 of file XCube_FormFile.class.php.

saveAsRandBody()

saveAsRandBody	(		$dir,
			$prefix = '',
			$salt = '' )

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

Parameters

Directory	$dir	for store.
string	$prefix	Prefix for random string.
string	$salt	Salt for generating token.

Returns

bool

See also

saveAs()

setRandomToBodyName()

Definition at line 252 of file XCube_FormFile.class.php.

setBodyName()

setBodyName

(

$bodyname

)

Set file body name. The extension is never changed.

Parameters

string

$bodyname

Definition at line 159 of file XCube_FormFile.class.php.

setContentType()

setContentType

(

$contenttype

)

Set content type

Parameters

string

$contenttype

Definition at line 132 of file XCube_FormFile.class.php.

setExtension()

setExtension

(

$ext

)

Set extension.

Parameters

$ext

Returns

string

Definition at line 120 of file XCube_FormFile.class.php.

setFileName()

setFileName

(

$filename

)

Set file name

Parameters

string

$filename

Definition at line 141 of file XCube_FormFile.class.php.

setFileSize()

setFileSize

(

$filesize

)

Set file size

Parameters

int

$filesize

Definition at line 150 of file XCube_FormFile.class.php.

setRandomToBodyName()

setRandomToBodyName	(		$prefix,
			$salt = '' )

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

Parameters

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

Definition at line 181 of file XCube_FormFile.class.php.

setRandomToFilename()

setRandomToFilename	(		$prefix,
			$salt = '' )

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

Parameters

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

Definition at line 192 of file XCube_FormFile.class.php.

Field Documentation

$_mTmpFileName

$_mTmpFileName

Definition at line 35 of file XCube_FormFile.class.php.

$mContentType

$mContentType

Definition at line 30 of file XCube_FormFile.class.php.

$mFileName

$mFileName

Definition at line 32 of file XCube_FormFile.class.php.

$mFileSize

$mFileSize = 0

Definition at line 33 of file XCube_FormFile.class.php.

$mKey

$mKey

Definition at line 28 of file XCube_FormFile.class.php.

$mName

$mName

Definition at line 26 of file XCube_FormFile.class.php.

$mUploadFileFlag

$mUploadFileFlag = false

Definition at line 37 of file XCube_FormFile.class.php.

---

The documentation for this class was generated from the following file:

• html/core/XCube_FormFile.class.php