TemporaryFileManager Class Reference
[File]

Class defining operations for temporary file management. More...

Inheritance diagram for TemporaryFileManager:

List of all members.

Public Member Functions
	articleToTemporaryFile ($articleFile, $userId)
	deleteFile ($fileId, $userId)
	downloadFile ($fileId, $userId, $inline=false)
&	getFile ($fileId, $userId)
	handleUpload ($fileName, $userId)
	parseFileExtension ($fileName)
	readFile ($fileId, $userId, $output=false)
	TemporaryFileManager ()
	viewFile ($fileId)

---

Detailed Description

Class defining operations for temporary file management.

See also:

TemporaryFileDAO

Definition at line 21 of file TemporaryFileManager.inc.php.

---

Member Function Documentation

TemporaryFileManager.articleToTemporaryFile	(	$	articleFile,
		$	userId
	)

Create a new temporary file from an article file.

Parameters:

	$articleFile	object
	$userId	int

Returns:

object The new TemporaryFile or false on failure

Definition at line 162 of file TemporaryFileManager.inc.php.

References FileManager.fileExists(), Core.getCurrentDate(), DAORegistry.getDAO(), FileManager.mkdirtree(), and parseFileExtension().

TemporaryFileManager.deleteFile	(	$	fileId,
		$	userId
	)

Delete a file by ID.

Parameters:

$fileId

int

Definition at line 66 of file TemporaryFileManager.inc.php.

References DAORegistry.getDAO(), and getFile().

TemporaryFileManager.downloadFile	(	$	fileId,
		$	userId,
		$	inline = false
	)

Download a file.

Parameters:

	$fileId	int the file id of the file to download
	$inline	print file as inline instead of attachment, optional

Returns:

boolean

Reimplemented from FileManager.

Definition at line 81 of file TemporaryFileManager.inc.php.

References getFile().

Referenced by viewFile().

& TemporaryFileManager.getFile	(	$	fileId,
		$	userId
	)

Retrieve file information by file ID.

Returns:

TemporaryFile

Definition at line 40 of file TemporaryFileManager.inc.php.

References DAORegistry.getDAO().

Referenced by deleteFile(), NativeImportExportPlugin.display(), downloadFile(), and readFile().

TemporaryFileManager.handleUpload	(	$	fileName,
		$	userId
	)

Upload the file and add it to the database.

Parameters:

	$fileName	string index into the $_FILES array
	$userId	int

Returns:

object The new TemporaryFile or false on failure

Definition at line 124 of file TemporaryFileManager.inc.php.

References FileManager.fileExists(), Core.getCurrentDate(), DAORegistry.getDAO(), FileManager.getUploadedFileName(), FileManager.mkdirtree(), parseFileExtension(), FileManager.truncateFileName(), and FileManager.uploadFile().

TemporaryFileManager.parseFileExtension

(

$

fileName

)

Parse the file extension from a filename/path.

Parameters:

$fileName

string

Returns:

string

Reimplemented from FileManager.

Definition at line 104 of file TemporaryFileManager.inc.php.

Referenced by articleToTemporaryFile(), and handleUpload().

TemporaryFileManager.readFile	(	$	fileId,
		$	userId,
		$	output = false
	)

Read a file's contents.

Parameters:

$output

boolean output the file's contents instead of returning a string

Returns:

boolean

Definition at line 51 of file TemporaryFileManager.inc.php.

References getFile().

TemporaryFileManager.TemporaryFileManager

(

)

Constructor. Create a manager for handling temporary file uploads.

Definition at line 30 of file TemporaryFileManager.inc.php.

References Config.getVar().

TemporaryFileManager.viewFile

(

$

fileId

)

View a file inline (variant of downloadFile).

See also:

TemporaryFileManager.downloadFile

Definition at line 95 of file TemporaryFileManager.inc.php.

References downloadFile().

---

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

• classes/file/TemporaryFileManager.inc.php