\SeedDMS_Core_DocumentFile

Class to represent a file attached to a document

Beside the regular document content arbitrary files can be attached to a document. This is a similar concept as attaching files to emails. The owner of the attached file and the document may not be the same. Use {@link SeedDMS_Core_Document::addDocumentFile()} to attach a file.

Summary

Methods
Properties
Constants
SeedDMS_Core_DocumentFile()
getID()
getDocument()
getUserID()
getComment()
getDate()
getDir()
getFileType()
getMimeType()
getOriginalFileName()
getName()
getUser()
getPath()
No public properties found
No constants found
No protected methods found
$_id
$_document
$_userID
$_comment
$_date
$_dir
$_fileType
$_mimeType
$_orgFileName
$_name
N/A
No private methods found
No private properties found
N/A

Properties

$_id

$_id : integer

Type

integer — internal id of document file

$_document

$_document : object

Type

object — reference to document this file belongs to

$_userID

$_userID : integer

Type

integer — id of user who is the owner of this link

$_comment

$_comment : string

Type

string — comment for the attached file

$_date

$_date : string

Type

string — date when the file was attached

$_dir

$_dir : string

Type

string — directory where the file is stored. This is the document id with a proceding '/'. FIXME: looks like this isn't used anymore. The file path is constructed by getPath()

$_fileType

$_fileType : string

Type

string — extension of the original file name with a leading '.'

$_mimeType

$_mimeType : string

Type

string — mime type of the file

$_orgFileName

$_orgFileName : string

Type

string — name of the file that was originally uploaded

$_name

$_name : string

Type

string — name of the file as given by the user

Methods

SeedDMS_Core_DocumentFile()

SeedDMS_Core_DocumentFile( $id,  $document,  $userID,  $comment,  $date,  $dir,  $fileType,  $mimeType,  $orgFileName,  $name)

Parameters

$id
$document
$userID
$comment
$date
$dir
$fileType
$mimeType
$orgFileName
$name

getID()

getID()

getDocument()

getDocument()

getUserID()

getUserID()

getComment()

getComment()

getDate()

getDate()

getDir()

getDir()

getFileType()

getFileType()

getMimeType()

getMimeType()

getOriginalFileName()

getOriginalFileName()

getName()

getName()

getUser()

getUser()

getPath()

getPath()