LibraryFileDAO Class Reference [Press]

Operations for retrieving and modifying LibraryFile objects. More...

List of all members.

Public Member Functions
&	_fromRow (&$row)
	deleteById ($fileId, $revision=null)
	filenameExists ($pressId, $fileName)
&	getById ($fileId)
&	getByMonographId ($monographId, $type=null, $pressId=null)
&	getByPressId ($pressId, $type=null)
	getInsertLibraryFileId ()
	getLocaleFieldNames ()
	insertObject (&$libraryFile)
	LibraryFileDAO ()
	newDataObject ()
	updateLocaleFields (&$libraryFile)
	updateObject (&$libraryFile)

---

Detailed Description

Operations for retrieving and modifying LibraryFile objects.

See also:

LibraryFile

Definition at line 18 of file LibraryFileDAO.inc.php.

---

Member Function Documentation

& LibraryFileDAO._fromRow

(

&$

row

)

Internal function to return a LibraryFile object from a row.

Parameters:

$row

array

Returns:

LibraryFile

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

References newDataObject().

Referenced by getById().

LibraryFileDAO.deleteById	(	$	fileId,
		$	revision = null
	)

Delete a library file by ID.

Parameters:

	$libraryId	int
	$revision	int

Definition at line 220 of file LibraryFileDAO.inc.php.

LibraryFileDAO.filenameExists	(	$	pressId,
		$	fileName
	)

Check if a file with this filename already exists

Parameters:

$filename

String the filename to be checked

Returns:

bool

Definition at line 236 of file LibraryFileDAO.inc.php.

& LibraryFileDAO.getById

(

$

fileId

)

Retrieve a library file by ID.

Parameters:

	$fileId	int
	$revision	int optional, if omitted latest revision is used
	$libraryId	int optional

Returns:

LibraryFile

Definition at line 33 of file LibraryFileDAO.inc.php.

References _fromRow().

& LibraryFileDAO.getByMonographId	(	$	monographId,
		$	type = null,
		$	pressId = null
	)

Retrieve all library files for a monograph.

Parameters:

	$monographId	int
	$type	(optional)
	$pressId	(optional) int

Returns:

array LibraryFiles

Definition at line 77 of file LibraryFileDAO.inc.php.

& LibraryFileDAO.getByPressId	(	$	pressId,
		$	type = null
	)

Retrieve all library files for a press.

Parameters:

	$pressId	int
	$type	(optional)

Returns:

array LibraryFiles

Definition at line 56 of file LibraryFileDAO.inc.php.

LibraryFileDAO.getInsertLibraryFileId

(

)

Get the ID of the last inserted library file.

Returns:

int

Definition at line 253 of file LibraryFileDAO.inc.php.

LibraryFileDAO.getLocaleFieldNames

(

)

Get the list of fields for which data is localized.

Returns:

array

Definition at line 105 of file LibraryFileDAO.inc.php.

LibraryFileDAO.insertObject

(

&$

libraryFile

)

Insert a new LibraryFile.

Parameters:

$libraryFile

LibraryFile

Returns:

int

Definition at line 151 of file LibraryFileDAO.inc.php.

References updateLocaleFields().

LibraryFileDAO.LibraryFileDAO

(

)

Constructor

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

LibraryFileDAO.newDataObject

(

)

Construct a new data object corresponding to this DAO.

Returns:

SignoffEntry

Definition at line 96 of file LibraryFileDAO.inc.php.

Referenced by _fromRow().

LibraryFileDAO.updateLocaleFields

(

&$

libraryFile

)

Update the localized fields for this file.

Parameters:

$libraryFile

Definition at line 113 of file LibraryFileDAO.inc.php.

Referenced by insertObject(), and updateObject().

LibraryFileDAO.updateObject

(

&$

libraryFile

)

Update a LibraryFile

Parameters:

$monograph

MonographFile

Returns:

int

Definition at line 186 of file LibraryFileDAO.inc.php.

References updateLocaleFields().

---

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

• classes/press/LibraryFileDAO.inc.php