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

Member Function Documentation

_getRandomString()

_getRandomString

(

$salt = ''

)

Generate random string.

Parameters

string

$salt

Salt for generating token.

Returns

string

fetch()

fetch

(

)

Fetch necessary information from $_FILES by $mName

Reimplemented in XCube_FormImageFile.

getBodyName()

getBodyName

(

)

Get file body name.

Returns

string

getContentType()

getContentType

(

)

Return content type

Returns

string

getExtension()

getExtension

(

)

Return extension from file name.

Returns

string

getFileName()

getFileName

(

)

Return file name.

Returns

string

getFileSize()

getFileSize

(

)

Return file size.

Returns

int

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

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()

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()

setBodyName()

setBodyName

(

$bodyname

)

Set file body name. The extension is never changed.

Parameters

string

$bodyname

setContentType()

setContentType

(

$contenttype

)

Set content type

Parameters

string

$contenttype

setExtension()

setExtension

(

$ext

)

Set extension.

Parameters

$ext

Returns

string

setFileName()

setFileName

(

$filename

)

Set file name

Parameters

string

$filename

setFileSize()

setFileSize

(

$filesize

)

Set file size

Parameters

int

$filesize

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.

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.

---

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

• C:/Ampps/www/legacy250/html/core/XCube_FormFile.class.php