Inheritance diagram for LibraryFile:

Public Member Functions
	getContextId ()

	getDateModified ()

	getDateUploaded ()

	getDocumentType ()

	getFilePath ()

	getFileSize ()

	getFileType ()

	getLocalizedName ()

	getName ($locale)

	getNiceFileSize ()

	getOriginalFileName ()

	getPublicAccess ()

	getServerFileName ()

	getSubmissionId ()

	getType ()

	setContextId ($contextId)

	setDateModified ($dateModified)

	setDateUploaded ($dateUploaded)

	setFileSize ($fileSize)

	setFileType ($fileType)

	setName ($name, $locale)

	setOriginalFileName ($originalFileName)

	setPublicAccess ($publicAccess)

	setServerFileName ($fileName)

	setSubmissionId ($submissionId)

	setType ($type)

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

	getDAO ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getId ()

	getLocaleMetadataFieldNames ()

	getLocalizedData ($key, $preferredLocale=null)

	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)

	unsetData ($key, $locale=null)

	upcastTo ($targetObject)

Additional Inherited Members
Data Fields 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

◆ getContextId()

LibraryFile::getContextId ( )

Get ID of context.

Returns: int

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

References DataObject\getData().

Referenced by getFilePath().

◆ getDateModified()

LibraryFile::getDateModified ( )

Get modified date of file.

Returns: date

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

References DataObject\getData().

◆ getDateUploaded()

LibraryFile::getDateUploaded ( )

Get uploaded date of file.

Returns: date

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

References DataObject\getData().

◆ getDocumentType()

LibraryFile::getDocumentType ( )

Get the file's document type (enumerated types)

Returns: string

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

References getFileType().

◆ getFilePath()

LibraryFile::getFilePath ( )

Return absolute path to the file on the host filesystem.

Returns: string

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

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

◆ getFileSize()

LibraryFile::getFileSize ( )

Get file size of file.

Returns: int

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

References DataObject\getData().

◆ getFileType()

LibraryFile::getFileType ( )

Get file type of the file. @ return string

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

References DataObject\getData().

Referenced by getDocumentType().

◆ getLocalizedName()

LibraryFile::getLocalizedName ( )

Get the localized name of the file

Returns: string

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

References DataObject\getLocalizedData().

◆ getName()

LibraryFile::getName ( $locale )

Get the name of the file

Parameters

$locale string

Returns: string

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

References DataObject\getData().

◆ getNiceFileSize()

LibraryFile::getNiceFileSize ( )

Get nice file size of file.

Returns: string

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

References DataObject\getData().

◆ getOriginalFileName()

LibraryFile::getOriginalFileName ( )

Get original file name of the file.

Parameters

return string

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

References DataObject\getData().

◆ getPublicAccess()

LibraryFile::getPublicAccess ( )

Get public access indication

Returns: boolean

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

References DataObject\getData().

◆ getServerFileName()

LibraryFile::getServerFileName ( )

Get server-side file name of the file.

Parameters

return string

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

References DataObject\getData().

Referenced by getFilePath().

◆ getSubmissionId()

LibraryFile::getSubmissionId ( )

Get ID of submission.

Returns: int

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

References DataObject\getData().

◆ getType()

LibraryFile::getType ( )

Get type of the file. @ return string

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

References DataObject\getData().

◆ setContextId()

LibraryFile::setContextId ( $contextId )

Set ID of context.

Parameters

$contextId int

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

References DataObject\setData().

◆ setDateModified()

LibraryFile::setDateModified ( $dateModified )

Set modified date of file.

Parameters

$dateModified date

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

◆ setDateUploaded()

LibraryFile::setDateUploaded ( $dateUploaded )

Set uploaded date of file.

Parameters

$dateUploaded date

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

◆ setFileSize()

LibraryFile::setFileSize ( $fileSize )

Set file size of file.

Parameters

$fileSize int

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

◆ setFileType()

LibraryFile::setFileType ( $fileType )

Set file type of the file.

Parameters

$fileType string

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

References DataObject\setData().

◆ setName()

LibraryFile::setName	(	$name,
		$locale
	)

Set the name of the file

Parameters

$name	string
$locale	string

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

References DataObject\setData().

◆ setOriginalFileName()

LibraryFile::setOriginalFileName ( $originalFileName )

Set original file name of the file.

Parameters

$originalFileName string

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

References DataObject\setData().

◆ setPublicAccess()

LibraryFile::setPublicAccess ( $publicAccess )

Set public access indication

Parameters

$publicAccess boolean

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

References DataObject\setData().

◆ setServerFileName()

LibraryFile::setServerFileName ( $fileName )

Set server-side file name of the file.

Parameters

$fileName string

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

References DataObject\setData().

◆ setSubmissionId()

LibraryFile::setSubmissionId ( $submissionId )

Set ID of submission.

Parameters

$submission int

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

References DataObject\setData().

◆ setType()

LibraryFile::setType ( $type )

Set type of the file.

Parameters

$type string

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

References DataObject\setData().

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

LibraryFile.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getContextId()

◆ getDateModified()

◆ getDateUploaded()

◆ getDocumentType()

◆ getFilePath()

◆ getFileSize()

◆ getFileType()

◆ getLocalizedName()

◆ getName()

◆ getNiceFileSize()

◆ getOriginalFileName()

◆ getPublicAccess()

◆ getServerFileName()

◆ getSubmissionId()

◆ getType()

◆ setContextId()

◆ setDateModified()

◆ setDateUploaded()

◆ setFileSize()

◆ setFileType()

◆ setName()

◆ setOriginalFileName()

◆ setPublicAccess()

◆ setServerFileName()

◆ setSubmissionId()

◆ setType()