Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
LibraryFile Class Reference
Inheritance diagram for LibraryFile:
DataObject

Public Member Functions

 getContextId ()
 
 getDateModified ()
 
 getDateUploaded ()
 
 getDocumentType ()
 
 getFilePath ()
 
 getFileSize ()
 
 getFileType ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getNiceFileSize ()
 
 getOriginalFileName ()
 
 getServerFileName ()
 
 getSubmissionId ()
 
 getType ()
 
 LibraryFile ()
 
 setContextId ($contextId)
 
 setDateModified ($dateModified)
 
 setDateUploaded ($dateUploaded)
 
 setFileSize ($fileSize)
 
 setFileType ($fileType)
 
 setName ($name, $locale)
 
 setOriginalFileName ($originalFileName)
 
 setServerFileName ($fileName)
 
 setSubmissionId ($submissionId)
 
 setType ($type)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Library file class.

See Also
LibraryFileDAO

Definition at line 25 of file LibraryFile.inc.php.

Member Function Documentation

LibraryFile::getContextId ( )

Get ID of context.

Returns
int

Definition at line 50 of file LibraryFile.inc.php.

References DataObject\getData().

Referenced by getFilePath().

LibraryFile::getDateModified ( )

Get modified date of file.

Returns
date

Definition at line 188 of file LibraryFile.inc.php.

References DataObject\getData().

LibraryFile::getDateUploaded ( )

Get uploaded date of file.

Returns
date

Definition at line 172 of file LibraryFile.inc.php.

References DataObject\getData().

LibraryFile::getDocumentType ( )

Get the file's document type (enumerated types)

Returns
string

Definition at line 230 of file LibraryFile.inc.php.

References getFileType().

LibraryFile::getFilePath ( )

Return absolute path to the file on the host filesystem.

Returns
string

Definition at line 37 of file LibraryFile.inc.php.

References getContextId(), getServerFileName(), and Config\getVar().

LibraryFile::getFileSize ( )

Get file size of file.

Returns
int

Definition at line 204 of file LibraryFile.inc.php.

References DataObject\getData().

LibraryFile::getFileType ( )

Get file type of the file. @ return string

Definition at line 140 of file LibraryFile.inc.php.

References DataObject\getData().

Referenced by getDocumentType().

LibraryFile::getLocalizedName ( )

Get the localized name of the file

Returns
string

Definition at line 132 of file LibraryFile.inc.php.

References DataObject\getLocalizedData().

LibraryFile::getName (   $locale)

Get the name of the file

Parameters
$localestring
Returns
string

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

References DataObject\getData().

LibraryFile::getNiceFileSize ( )

Get nice file size of file.

Returns
string

Definition at line 221 of file LibraryFile.inc.php.

References DataObject\getData().

LibraryFile::getOriginalFileName ( )

Get original file name of the file.

Parameters
returnstring

Definition at line 98 of file LibraryFile.inc.php.

References DataObject\getData().

LibraryFile::getServerFileName ( )

Get server-side file name of the file.

Parameters
returnstring

Definition at line 82 of file LibraryFile.inc.php.

References DataObject\getData().

Referenced by getFilePath().

LibraryFile::getSubmissionId ( )

Get ID of submission.

Returns
int

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

References DataObject\getData().

LibraryFile::getType ( )

Get type of the file. @ return string

Definition at line 156 of file LibraryFile.inc.php.

References DataObject\getData().

LibraryFile::LibraryFile ( )

Constructor.

Definition at line 29 of file LibraryFile.inc.php.

LibraryFile::setContextId (   $contextId)

Set ID of context.

Parameters
$contextIdint

Definition at line 58 of file LibraryFile.inc.php.

References DataObject\setData().

LibraryFile::setDateModified (   $dateModified)

Set modified date of file.

Parameters
$dateModifieddate

Definition at line 196 of file LibraryFile.inc.php.

LibraryFile::setDateUploaded (   $dateUploaded)

Set uploaded date of file.

Parameters
$dateUploadeddate

Definition at line 180 of file LibraryFile.inc.php.

LibraryFile::setFileSize (   $fileSize)

Set file size of file.

Parameters
$fileSizeint

Definition at line 213 of file LibraryFile.inc.php.

LibraryFile::setFileType (   $fileType)

Set file type of the file.

Parameters
$fileTypestring

Definition at line 148 of file LibraryFile.inc.php.

References DataObject\setData().

LibraryFile::setName (   $name,
  $locale 
)

Set the name of the file

Parameters
$namestring
$localestring

Definition at line 115 of file LibraryFile.inc.php.

References DataObject\setData().

LibraryFile::setOriginalFileName (   $originalFileName)

Set original file name of the file.

Parameters
$originalFileNamestring

Definition at line 106 of file LibraryFile.inc.php.

References DataObject\setData().

LibraryFile::setServerFileName (   $fileName)

Set server-side file name of the file.

Parameters
$fileNamestring

Definition at line 90 of file LibraryFile.inc.php.

References DataObject\setData().

LibraryFile::setSubmissionId (   $submissionId)

Set ID of submission.

Parameters
$submissionint

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

References DataObject\setData().

LibraryFile::setType (   $type)

Set type of the file.

Parameters
$typestring

Definition at line 164 of file LibraryFile.inc.php.

References DataObject\setData().


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