FileUpload Class Reference

This class is used to manage file upload using ajax. More...

Public Member Functions
	__construct ($options=null, $fk_element=null, $element=null)
	Constructor. More...
	get ()
	Output data. More...
	post ()
	Output data. More...
	delete ()
	Delete uploaded file. More...

Protected Member Functions
	getFullUrl ()
	Return full URL. More...
	setFileDeleteUrl ($file)
	Set delete url. More...
	getFileObject ($file_name)
	getFileObject More...
	getFileObjects ()
	getFileObjects More...
	createScaledImage ($file_name, $options)
	Create thumbs of a file uploaded. More...
	validate ($uploaded_file, $file, $error, $index)
	Enter description here ... More...
	upcountNameCallback ($matches)
	Enter description here ... More...
	upcountName ($name)
	Enter description here ... More...
	trimFileName ($name, $type, $index)
	trimFileName More...
	handleFileUpload ($uploaded_file, $name, $size, $type, $error, $index)
	handleFileUpload More...

Detailed Description

This class is used to manage file upload using ajax.

Definition at line 31 of file fileupload.class.php.

Constructor & Destructor Documentation

FileUpload::__construct	(		$options = null,
			$fk_element = null,
			$element = null
	)

Constructor.

Parameters

array	$options	Options array
int	$fk_element	fk_element
string	$element	element

Definition at line 44 of file fileupload.class.php.

References $_SERVER, dol_include_once(), dol_sanitizeFileName(), and get_exdir().

Member Function Documentation

FileUpload::createScaledImage (   $file_name,   $options  )

protected

Create thumbs of a file uploaded.

Only the "mini" thumb is generated.

Parameters

string	$file_name	Filename
string	$options	is array('max_width', 'max_height')

Returns

boolean

Definition at line 273 of file fileupload.class.php.

References dol_mkdir(), and vignette().

FileUpload::delete

(

)

Delete uploaded file.

Returns

void

Definition at line 550 of file fileupload.class.php.

FileUpload::get

(

)

Output data.

Returns

void

Definition at line 474 of file fileupload.class.php.

FileUpload::getFileObject (   $file_name )

protected

getFileObject

Parameters

string

$file_name

Filename

Returns

stdClass|null

Definition at line 234 of file fileupload.class.php.

References dol_mimetype(), and setFileDeleteUrl().

FileUpload::getFileObjects ( )

protected

getFileObjects

Returns

void

Definition at line 261 of file fileupload.class.php.

FileUpload::getFullUrl ( )

protected

Return full URL.

Returns

string URL

Definition at line 200 of file fileupload.class.php.

References $_SERVER.

FileUpload::handleFileUpload (   $uploaded_file,   $name,   $size,   $type,   $error,   $index  )

protected

handleFileUpload

Parameters

string	$uploaded_file	Uploade file
string	$name	Name
int	$size	Size
string	$type	Type
string	$error	Error
string	$index	Index

Returns

stdClass

Definition at line 422 of file fileupload.class.php.

References dol_mimetype(), dol_mkdir(), and dol_move_uploaded_file().

FileUpload::post

(

)

Output data.

Returns

void

Definition at line 493 of file fileupload.class.php.

References $_SERVER.

FileUpload::setFileDeleteUrl (   $file )

protected

Set delete url.

Parameters

string

$file

Filename

Returns

void

Definition at line 218 of file fileupload.class.php.

Referenced by getFileObject().

FileUpload::trimFileName (   $name,   $type,   $index  )

protected

trimFileName

Parameters

string	$name	Filename
string	$type	???
string	$index	???

Returns

string

Definition at line 390 of file fileupload.class.php.

FileUpload::upcountName (   $name )

protected

Enter description here ...

Parameters

string

$name

???

Returns

string ???

Definition at line 377 of file fileupload.class.php.

FileUpload::upcountNameCallback (   $matches )

protected

Enter description here ...

Parameters

int

$matches

???

Returns

string ???

Definition at line 364 of file fileupload.class.php.

FileUpload::validate (   $uploaded_file,   $file,   $error,   $index  )

protected

Enter description here ...

Parameters

string	$uploaded_file	Uploade file
string	$file	File
string	$error	Error
string	$index	Index

Returns

boolean True if OK, False if KO

Definition at line 305 of file fileupload.class.php.

References $_SERVER.

---

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

• htdocs/core/class/fileupload.class.php