Public Member Functions

ChapterDAO Class Reference
[Monograph]

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

List of all members.

Public Member Functions

_returnFromRow (&$row)
 ChapterDAO ()
 deleteById ($chapterId)
 deleteByMonographId ($monographId)
 deleteObject (&$chapter)
getChapter ($chapterId, $monographId=null)
getChapters ($monographId, $rangeInfo=null)
 getInsertChapterId ()
 getLocaleFieldNames ()
 insertChapter (&$chapter)
 newDataObject ()
 resequenceChapters ($monographId=null)
 updateLocaleFields (&$chapter)
 updateObject (&$chapter)

Detailed Description

Operations for retrieving and modifying ChapterAuthor objects.

Operations for retrieving and modifying Chapter objects.

monograph

See also:
Chapter
ChapterDAO
AuthorDAO - This DAO does NOT offer operations for manipulating Author Objects. AuthorDAO should be used for that instead.
Chapter
AuthorDAO

Definition at line 20 of file ChapterDAO.inc.php.


Member Function Documentation

& ChapterDAO._returnFromRow ( &$  row  ) 

Internal function to return a Chapter object from a row.

Parameters:
$row array
Returns:
Chapter

Definition at line 93 of file ChapterDAO.inc.php.

References newDataObject().

Referenced by getChapter().

ChapterDAO.ChapterDAO (  ) 

Constructor.

Definition at line 24 of file ChapterDAO.inc.php.

ChapterDAO.deleteById ( chapterId  ) 

Delete a board chapter, including membership info

Parameters:
$chapterId int

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

Referenced by deleteObject().

ChapterDAO.deleteByMonographId ( monographId  ) 

Delete board chapters by assoc ID, including membership info

Parameters:
$assocType int
$monographId int

Definition at line 181 of file ChapterDAO.inc.php.

References deleteObject(), and getChapters().

ChapterDAO.deleteObject ( &$  chapter  ) 

Delete a board chapter, including membership info

Parameters:
$chapter Chapter

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

References deleteById().

Referenced by deleteByMonographId().

& ChapterDAO.getChapter ( chapterId,
monographId = null 
)

Retrieve a chapter by ID.

Parameters:
$chapterId int
$assocType int optional
$monographId int optional
Returns:
Chapter

Definition at line 35 of file ChapterDAO.inc.php.

References _returnFromRow().

& ChapterDAO.getChapters ( monographId,
rangeInfo = null 
)

Get all chapters for a given monograph.

Parameters:
$monographId int
$rangeInfo object RangeInfo object (optional)
Returns:
DAOResultFactory

Definition at line 61 of file ChapterDAO.inc.php.

Referenced by deleteByMonographId().

ChapterDAO.getInsertChapterId (  ) 

Get the ID of the last inserted board chapter.

Returns:
int

Definition at line 222 of file ChapterDAO.inc.php.

Referenced by insertChapter().

ChapterDAO.getLocaleFieldNames (  ) 

Get the list of fields for which locale data is stored.

Returns:
array

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

ChapterDAO.insertChapter ( &$  chapter  ) 

Insert a new board chapter.

Parameters:
$chapter Chapter

Definition at line 119 of file ChapterDAO.inc.php.

References getInsertChapterId(), and updateLocaleFields().

ChapterDAO.newDataObject (  ) 

Get a new data object

Returns:
Chapter

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

Referenced by _returnFromRow().

ChapterDAO.resequenceChapters ( monographId = null  ) 

Sequentially renumber chapters in their sequence order, optionally by monographId

Parameters:
$monographId int

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

ChapterDAO.updateLocaleFields ( &$  chapter  ) 

Update the settings for this object

Parameters:
$chapter object

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

Referenced by insertChapter(), and updateObject().

ChapterDAO.updateObject ( &$  chapter  ) 

Update an existing board chapter.

Parameters:
$chapter Chapter

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

References updateLocaleFields().


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