Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
AuthorDAO Class Reference
Inheritance diagram for AuthorDAO:
PKPAuthorDAO DAO

Public Member Functions

 AuthorDAO ()
 
 deleteAuthorsByArticle ($submissionId)
 
getAuthorsAlphabetizedByJournal ($journalId=null, $initial=null, $rangeInfo=null, $includeEmail=false)
 
getPublishedArticlesForAuthor ($journalId, $firstName, $middleName, $lastName, $affiliation, $country)
 
 insertAuthor (&$author)
 
 newDataObject ()
 
 updateAuthor (&$author)
 
- Public Member Functions inherited from PKPAuthorDAO
_returnAuthorFromRow (&$row)
 
_returnSimpleAuthorFromRow (&$row)
 
 deleteAuthor (&$author)
 
 deleteAuthorById ($authorId, $submissionId=null)
 
getAuthor ($authorId, $submissionId=null)
 
 getAuthorCountBySubmissionId ($submissionId)
 
getAuthorsBySubmissionId ($submissionId, $sortByAuthorId=false)
 
 getInsertAuthorId ()
 
 getLocaleFieldNames ()
 
getPrimaryContact ($submissionId)
 
 newDataObject ()
 
 PKPAuthorDAO ()
 
 resequenceAuthors ($submissionId)
 
 resetPrimaryContact ($authorId, $submissionId)
 
 updateLocaleFields (&$author)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Additional Inherited Members

- Public Attributes inherited from DAO
 $_dataSource
 

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::AuthorDAO ( )

Constructor

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

AuthorDAO::deleteAuthorsByArticle (   $submissionId)

Delete authors by submission.

Parameters
$submissionIdint

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

References PKPAuthorDAO\deleteAuthor(), and PKPAuthorDAO\getAuthorsBySubmissionId().

& AuthorDAO::getAuthorsAlphabetizedByJournal (   $journalId = null,
  $initial = null,
  $rangeInfo = null,
  $includeEmail = false 
)

Retrieve all published authors for a journal in an associative array by the first letter of the last name, for example: $returnedArray['S'] gives array($misterSmithObject, $misterSmytheObject, ...) Keys will appear in sorted order. Note that if journalId is null, alphabetized authors for all journals are returned.

Parameters
$journalIdint
$initialAn initial the last names must begin with
$rangeInfoRange information
$includeEmailWhether or not to include the email in the select distinct
Returns
array Authors ordered by sequence

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

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), DAO\retrieveRange(), and String\strtolower().

& AuthorDAO::getPublishedArticlesForAuthor (   $journalId,
  $firstName,
  $middleName,
  $lastName,
  $affiliation,
  $country 
)

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

Parameters
$journalIdint (null if no restriction desired)
$firstNamestring
$middleNamestring
$lastNamestring
$affiliationstring
$countrystring

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

References DAORegistry\getDAO(), and DAO\retrieve().

AuthorDAO::insertAuthor ( $author)

Insert a new Author.

Parameters
$authorAuthor

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

References PKPAuthorDAO\getInsertAuthorId(), DAO\update(), and PKPAuthorDAO\updateLocaleFields().

AuthorDAO::newDataObject ( )

Get a new data object

Returns
DataObject

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

AuthorDAO::updateAuthor ( $author)

Update an existing Author.

Parameters
$authorAuthor

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

References DAO\update(), and PKPAuthorDAO\updateLocaleFields().


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