LibraryFile Class Reference [Press]

Library file class. More...

List of all members.

Public Member Functions
	getDateModified ()
	getDateUploaded ()
	getDocumentType ()
	getFileName ()
	getFilePath ()
	getFileSize ()
	getFileType ()
	getLocalizedName ()
	getMonographId ()
	getName ($locale)
	getNiceFileSize ()
	getOriginalFileName ()
	getPressId ()
	getType ()
	LibraryFile ()
	setDateModified ($dateModified)
	setDateUploaded ($dateUploaded)
	setFileName ($fileName)
	setFileSize ($fileSize)
	setFileType ($fileType)
	setMonographId ($monographId)
	setName ($name, $locale)
	setOriginalFileName ($originalFileName)
	setPressId ($pressId)
	setType ($type)

---

Detailed Description

Library file class.

See also:

LibraryFileDAO

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

---

Member Function Documentation

LibraryFile.getDateModified

(

)

Get modified date of file.

Returns:

date

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

LibraryFile.getDateUploaded

(

)

Get uploaded date of file.

Returns:

date

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

LibraryFile.getDocumentType

(

)

Get the file's document type (enumerated types)

Returns:

string

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

References getFileType().

LibraryFile.getFileName

(

)

Get file name of the file.

Parameters:

return

string

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

Referenced by getFilePath().

LibraryFile.getFilePath

(

)

Return absolute path to the file on the host filesystem.

Returns:

string

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

References getFileName(), and getPressId().

LibraryFile.getFileSize

(

)

Get file size of file.

Returns:

int

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

LibraryFile.getFileType

(

)

Get file type of the file. @ return string

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

Referenced by getDocumentType().

LibraryFile.getLocalizedName

(

)

Get the localized name of the file

Returns:

string

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

LibraryFile.getMonographId

(

)

Get ID of monograph.

Returns:

int

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

LibraryFile.getName

(

$

locale

)

Get the name of the file

Parameters:

$locale

string

Returns:

string

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

LibraryFile.getNiceFileSize

(

)

Get nice file size of file.

Returns:

string

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

LibraryFile.getOriginalFileName

(

)

Get original file name of the file.

Parameters:

return

string

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

LibraryFile.getPressId

(

)

Get ID of press.

Returns:

int

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

Referenced by getFilePath().

LibraryFile.getType

(

)

Get type of the file. @ return string

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

LibraryFile.LibraryFile

(

)

Constructor.

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

LibraryFile.setDateModified

(

$

dateModified

)

Set modified date of file.

Parameters:

$dateModified

date

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

LibraryFile.setDateUploaded

(

$

dateUploaded

)

Set uploaded date of file.

Parameters:

$dateUploaded

date

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

LibraryFile.setFileName

(

$

fileName

)

Set file name of the file.

Parameters:

$fileName

string

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

LibraryFile.setFileSize

(

$

fileSize

)

Set file size of file.

Parameters:

$fileSize

int

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

LibraryFile.setFileType

(

$

fileType

)

Set file type of the file.

Parameters:

$fileType

string

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

LibraryFile.setMonographId

(

$

monographId

)

Set ID of monograph.

Parameters:

$monograph

int

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

LibraryFile.setName	(	$	name,
		$	locale
	)

Set the name of the file

Parameters:

	$name	string
	$locale	string

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

LibraryFile.setOriginalFileName

(

$

originalFileName

)

Set original file name of the file.

Parameters:

$originalFileName

string

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

LibraryFile.setPressId

(

$

pressId

)

Set ID of press.

Parameters:

$pressId

int

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

LibraryFile.setType

(

$

type

)

Set type of the file.

Parameters:

$type

string

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

---

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

• classes/press/LibraryFile.inc.php