PHP Class IssueFileManager, ojs

Inheritance: extends FileManager

Public Properties

Property	Type	Description
$_filesDir		the path to location of the files
$_issueId		the associated issue ID

Method	Description
__construct ( $issueId )	Constructor.
contentTypeToAbbrev ( $contentType ) : string	Return abbreviation based on issue content type (used for naming files).
contentTypeToPath ( $contentType ) : string	Return directory path based on issue content type (used for naming files).
deleteFile ( $fileId ) : boolean	Delete an issue file by ID.
deleteIssueTree ( )	Delete the entire tree of files belonging to an issue.
downloadFile ( $fileId, $inline = false ) : boolean	Download a file.
fromTemporaryFile ( $temporaryFile, $contentType = ISSUE_FILE_PUBLIC ) : IssueFile	Create an issue galley based on a temporary file.
getFilesDir ( ) : string	Get the issue files directory.
getIssueId ( ) : integer	Get the issue ID.
setFilesDir ( $filesDir )	Set the issue files directory.
setIssueId ( $issueId )	Set the issue ID.

Create a manager for handling issue files.

public __construct ( $issueId )
$issueId		int

Return abbreviation based on issue content type (used for naming files).

public contentTypeToAbbrev ( $contentType ) : string
$contentType		int
return	string

Return directory path based on issue content type (used for naming files).

public contentTypeToPath ( $contentType ) : string
$contentType		int
return	string

Delete an issue file by ID.

public deleteFile ( $fileId ) : boolean
$fileId		int
return	boolean	if successful

Delete the entire tree of files belonging to an issue.

public deleteIssueTree ( )

Download a file.

public downloadFile ( $fileId, $inline = false ) : boolean
$fileId		int the file id of the file to download
$inline		print file as inline instead of attachment, optional
return	boolean

Create an issue galley based on a temporary file.

public fromTemporaryFile ( $temporaryFile, $contentType = ISSUE_FILE_PUBLIC ) : IssueFile
$temporaryFile		TemporaryFile
$contentType		int Issue file content type
return	IssueFile	the resulting issue file

Get the issue files directory.

public getFilesDir ( ) : string
return	string

Get the issue ID.

public getIssueId ( ) : integer
return	integer

Set the issue files directory.

public setFilesDir ( $filesDir )
$filesDir		string

Set the issue ID.

public setIssueId ( $issueId )
$issueId		int

the path to location of the files

public $_filesDir

the associated issue ID

public $_issueId