AuthorDAO Class Reference
[Paper]

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

List of all members.

Public Member Functions

_returnAuthorFromRow (&$row)
 deleteAuthor (&$author)
 deleteAuthorById ($authorId, $paperId=null)
 deleteAuthorsByPaper ($paperId)
getAuthor ($authorId)
getAuthorIdsByPaper ($paperId)
getAuthorsAlphabetizedBySchedConf ($schedConfId=null, $initial=null, $rangeInfo=null, $includeEmail=false)
getAuthorsByPaper ($paperId)
 getInsertAuthorId ()
 getLocaleFieldNames ()
getPublishedPapersForAuthor ($schedConfId, $firstName, $middleName, $lastName, $affiliation, $country)
 insertAuthor (&$author)
 resequenceAuthors ($paperId)
 updateAuthor (&$author)
 updateLocaleFields (&$author)


Detailed Description

Operations for retrieving and modifying Author objects.

See also:
Author

Definition at line 21 of file AuthorDAO.inc.php.


Member Function Documentation

& AuthorDAO._returnAuthorFromRow ( &$  row  ) 

Internal function to return an Author object from a row.

Parameters:
$row array
Returns:
Author

Definition at line 212 of file AuthorDAO.inc.php.

Referenced by getAuthor(), getAuthorsAlphabetizedBySchedConf(), and getAuthorsByPaper().

AuthorDAO.deleteAuthor ( &$  author  ) 

Delete an Author.

Parameters:
$author Author

Definition at line 302 of file AuthorDAO.inc.php.

References deleteAuthorById().

Referenced by deleteAuthorsByPaper().

AuthorDAO.deleteAuthorById ( authorId,
paperId = null 
)

Delete an author by ID.

Parameters:
$authorId int
$paperId int optional

Definition at line 311 of file AuthorDAO.inc.php.

Referenced by deleteAuthor().

AuthorDAO.deleteAuthorsByPaper ( paperId  ) 

Delete authors by paper.

Parameters:
$paperId int

Definition at line 326 of file AuthorDAO.inc.php.

References deleteAuthor(), and getAuthorsByPaper().

& AuthorDAO.getAuthor ( authorId  ) 

Retrieve an author by ID.

Parameters:
$authorId int
Returns:
Author

Definition at line 27 of file AuthorDAO.inc.php.

References _returnAuthorFromRow().

& AuthorDAO.getAuthorIdsByPaper ( paperId  ) 

Retrieve the IDs of all authors for a paper.

Parameters:
$paperId int
Returns:
array int ordered by sequence

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

& AuthorDAO.getAuthorsAlphabetizedBySchedConf ( schedConfId = null,
initial = null,
rangeInfo = null,
includeEmail = false 
)

Retrieve all published authors for a scheduled conference. Note that if schedConfId is null, alphabetized authors for all scheduled conferences are returned.

Parameters:
$schedConfId int
$initial An initial the last names must begin with
$rangeInfo Range information
$includeEmail Whether or not to include the email in the select distinct
Returns:
object ItemIterator Authors ordered by sequence

Definition at line 123 of file AuthorDAO.inc.php.

References _returnAuthorFromRow().

& AuthorDAO.getAuthorsByPaper ( paperId  ) 

Retrieve all authors for a paper.

Parameters:
$paperId int
Returns:
array Authors ordered by sequence

Definition at line 48 of file AuthorDAO.inc.php.

References _returnAuthorFromRow().

Referenced by deleteAuthorsByPaper().

AuthorDAO.getInsertAuthorId (  ) 

Get the ID of the last inserted author.

Returns:
int

Definition at line 363 of file AuthorDAO.inc.php.

Referenced by insertAuthor().

AuthorDAO.getLocaleFieldNames (  ) 

Get field names for which data is localized.

Returns:
array

Definition at line 192 of file AuthorDAO.inc.php.

& AuthorDAO.getPublishedPapersForAuthor ( schedConfId,
firstName,
middleName,
lastName,
affiliation,
country 
)

Retrieve all published papers associated with authors with the given first name, middle name, last name, affiliation, and country.

Parameters:
$schedConfId int (null if no restriction desired)
$firstName string
$middleName string
$lastName string
$affiliation string
$country string

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

AuthorDAO.insertAuthor ( &$  author  ) 

Insert a new Author.

Parameters:
$author Author

Definition at line 237 of file AuthorDAO.inc.php.

References getInsertAuthorId(), and updateLocaleFields().

AuthorDAO.resequenceAuthors ( paperId  ) 

Sequentially renumber a paper's authors in their sequence order.

Parameters:
$paperId int

Definition at line 337 of file AuthorDAO.inc.php.

AuthorDAO.updateAuthor ( &$  author  ) 

Update an existing Author.

Parameters:
$author Author

Definition at line 267 of file AuthorDAO.inc.php.

References updateLocaleFields().

AuthorDAO.updateLocaleFields ( &$  author  ) 

Update the localized data for this object

Parameters:
$author object

Definition at line 200 of file AuthorDAO.inc.php.

Referenced by insertAuthor(), and updateAuthor().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7