PublicFileManager Class Reference

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

List of all members.

Public Member Functions
	copyPressFile ($pressId, $sourceFile, $destFileName)
	getPressFilesPath ($pressId)
	PublicFileManager ()
	removePressFile ($pressId, $fileName)
	uploadPressFile ($pressId, $fileName, $destFileName)
	writePressFile ($pressId, $destFileName, &$contents)

---

Detailed Description

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

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

---

Member Function Documentation

PublicFileManager.copyPressFile	(	$	pressId,
		$	sourceFile,
		$	destFileName
	)

Copy a file to a press' public directory.

Parameters:

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

Returns:

boolean

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

References getPressFilesPath().

PublicFileManager.getPressFilesPath

(

$

pressId

)

Get the path to a press' public files directory.

Parameters:

$pressId

int

Returns:

string

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

Referenced by copyPressFile(), removePressFile(), uploadPressFile(), and writePressFile().

PublicFileManager.PublicFileManager

(

)

Constructor

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

PublicFileManager.removePressFile	(	$	pressId,
		$	fileName
	)

Delete a file from a press' public directory.

Parameters:

	$pressId	int
	$fileName	string the target file name

Returns:

boolean

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

References getPressFilesPath().

PublicFileManager.uploadPressFile	(	$	pressId,
		$	fileName,
		$	destFileName
	)

Upload a file to a press' public directory.

Parameters:

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

Returns:

boolean

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

References getPressFilesPath().

PublicFileManager.writePressFile	(	$	pressId,
		$	destFileName,
		&$	contents
	)

Write a file to a press' public directory.

Parameters:

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

Returns:

boolean

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

References getPressFilesPath().

---

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

• classes/file/PublicFileManager.inc.php