PublicFileManager Class Reference
[File]

Wrapper class for uploading files to a site/journal's public directory. More...

Inheritance diagram for PublicFileManager:

List of all members.

Public Member Functions
	copyJournalFile ($journalId, $sourceFile, $destFileName)
	getJournalFilesPath ($journalId)
	getSiteFilesPath ()
	removeJournalFile ($journalId, $fileName)
	removeSiteFile ($fileName)
	uploadJournalFile ($journalId, $fileName, $destFileName)
	uploadSiteFile ($fileName, $destFileName)
	writeJournalFile ($journalId, $destFileName, &$contents)

---

Detailed Description

Wrapper class for uploading files to a site/journal's public directory.

Definition at line 20 of file PublicFileManager.inc.php.

---

Member Function Documentation

PublicFileManager.copyJournalFile	(	$	journalId,
		$	sourceFile,
		$	destFileName
	)

Copy a file to a journals's public directory.

Parameters:

	$journalId	int
	$sourceFile	string the source of the file to copy
	$destFileName	string the destination file name

Returns:

boolean

Definition at line 87 of file PublicFileManager.inc.php.

References FileManager.copyFile(), and getJournalFilesPath().

PublicFileManager.getJournalFilesPath

(

$

journalId

)

Get the path to a journal's public files directory.

Parameters:

$journalId

int

Returns:

string

Definition at line 54 of file PublicFileManager.inc.php.

References Config.getVar().

Referenced by copyJournalFile(), removeJournalFile(), TemplateManager.TemplateManager(), uploadJournalFile(), and writeJournalFile().

PublicFileManager.getSiteFilesPath

(

)

Get the path to the site public files directory.

Returns:

string

Definition at line 26 of file PublicFileManager.inc.php.

References Config.getVar().

Referenced by removeSiteFile(), TemplateManager.TemplateManager(), and uploadSiteFile().

PublicFileManager.removeJournalFile	(	$	journalId,
		$	fileName
	)

Delete a file from a journal's public directory.

Parameters:

	$journalId	int
	$fileName	string the target file name

Returns:

boolean

Definition at line 97 of file PublicFileManager.inc.php.

References FileManager.deleteFile(), and getJournalFilesPath().

PublicFileManager.removeSiteFile

(

$

fileName

)

Delete a file from the site's public directory.

Parameters:

$fileName

string the target file name

Returns:

boolean

Definition at line 45 of file PublicFileManager.inc.php.

References FileManager.deleteFile(), and getSiteFilesPath().

PublicFileManager.uploadJournalFile	(	$	journalId,
		$	fileName,
		$	destFileName
	)

Upload a file to a journals's public directory.

Parameters:

	$journalId	int
	$fileName	string the name of the file in the upload form
	$destFileName	string the destination file name

Returns:

boolean

Definition at line 65 of file PublicFileManager.inc.php.

References getJournalFilesPath(), and FileManager.uploadFile().

PublicFileManager.uploadSiteFile	(	$	fileName,
		$	destFileName
	)

Upload a file to the site's public directory.

Parameters:

	$fileName	string the name of the file in the upload form
	$destFileName	string the destination file name

Returns:

boolean

Definition at line 36 of file PublicFileManager.inc.php.

References getSiteFilesPath(), and FileManager.uploadFile().

PublicFileManager.writeJournalFile	(	$	journalId,
		$	destFileName,
		&$	contents
	)

Write a file to a journals's public directory.

Parameters:

	$journalId	int
	$destFileName	string the destination file name
	$contents	string the contents to write to the file

Returns:

boolean

Definition at line 76 of file PublicFileManager.inc.php.

References getJournalFilesPath(), and FileManager.writeFile().

---

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

• classes/file/PublicFileManager.inc.php