Open Journal Systems  3.3.0
AuthorDAO Class Reference
Inheritance diagram for AuthorDAO:
PKPAuthorDAO SchemaDAO DAO

Public Member Functions

 getAuthorsAlphabetizedByJournal ($journalId=null, $initial=null, $rangeInfo=null, $includeEmail=false)
 
- Public Member Functions inherited from PKPAuthorDAO
 _fromRow ($primaryRow)
 
 changePublicationLocale ($publicationId, $oldLocale, $newLocale)
 
 deleteBySubmissionId ($submissionId)
 
 getById ($objectId)
 
 getByPublicationId ($publicationId, $sortByAuthorId=false, $useIncludeInBrowse=false)
 
 getInsertId ()
 
 newDataObject ()
 
- Public Member Functions inherited from SchemaDAO
 deleteById ($objectId)
 
 deleteObject ($object)
 
 insertObject ($object)
 
 updateObject ($object)
 
- Public Member Functions inherited from DAO
 __construct ($dataSource=null, $callHooks=true)
 
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAdditionalFieldNames ()
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getLocaleFieldNames ()
 
 getType ($value)
 
 handleError ($dataSource, $sql)
 
 nullOrInt ($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

- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
 
- Data Fields inherited from PKPAuthorDAO
 $primaryKeyColumn = 'author_id'
 
 $primaryTableColumns
 
 $schemaName = SCHEMA_AUTHOR
 
 $settingsTableName = 'author_settings'
 
 $tableName = 'authors'
 
- Data Fields inherited from SchemaDAO
 $primaryKeyColumn
 
 $primaryTableColumns = array()
 
 $schemaName
 
 $settingsTableName
 
 $tableName
 
- Data Fields inherited from DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

Operations for retrieving and modifying Author objects.

See also
Author

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

Member Function Documentation

◆ getAuthorsAlphabetizedByJournal()

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

Retrieve all published authors for a journal by the first letter of the family name. Authors will be sorted by (family, given). Note that if journalId is null, alphabetized authors for all enabled journals are returned. If authors have the same given names, first names and affiliations in all journal locales, as well as country and email (otional), they are considered to be the same.

Parameters
$journalIdint Optional journal ID to restrict results to
$initialAn initial a family name must begin with, "-" for authors with no family names
$rangeInfoRange information
$includeEmailboolean Whether or not to include the email in the select distinct
Returns
DAOResultFactory Authors ordered by last name, given name

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

References PKPApplication\get(), DAORegistry\getDAO(), AppLocale\getLocale(), DAO\retrieveRange(), and PKPString\strtolower().


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