PKPAuthorDAO Class Reference

Inheritance diagram for PKPAuthorDAO:

Public Member Functions
	_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)

Data Fields
	$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

Additional Inherited Members
Static Public Member Functions inherited from DAO
static	getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
Protected Member Functions inherited from DAO
	_getInsertId ($table='', $id='')

Detailed Description

Operations for retrieving and modifying PKPAuthor objects.

See also

PKPAuthor

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

Member Function Documentation

_fromRow()

PKPAuthorDAO::_fromRow

(

$primaryRow

)

Return a DataObject from a result row

Parameters

$primaryRow

array The result row from the primary table lookup

Returns

DataObject

Reimplemented from SchemaDAO.

Definition at line 138 of file PKPAuthorDAO.inc.php.

Referenced by getById(), and getByPublicationId().

changePublicationLocale()

PKPAuthorDAO::changePublicationLocale	(		$publicationId,
			$oldLocale,
			$newLocale
	)

Update author names when publication locale changes.

Parameters

$publicationId	int
$oldLocale	string
$newLocale	string

Definition at line 114 of file PKPAuthorDAO.inc.php.

References getByPublicationId(), and SchemaDAO\updateObject().

deleteBySubmissionId()

PKPAuthorDAO::deleteBySubmissionId

(

$submissionId

)

Delete authors by submission.

Parameters

$submissionId

int

Definition at line 156 of file PKPAuthorDAO.inc.php.

References SchemaDAO\deleteObject(), getByPublicationId(), and DAORegistry\getDAO().

getById()

PKPAuthorDAO::getById

(

$objectId

)

Retrieve an object by ID

Parameters

$objectId

int

Returns

DataObject Overrides the parent implementation to add the submission_locale column

Reimplemented from SchemaDAO.

Definition at line 55 of file PKPAuthorDAO.inc.php.

References _fromRow(), and DAO\retrieve().

getByPublicationId()

PKPAuthorDAO::getByPublicationId	(		$publicationId,
			$sortByAuthorId = false,
			$useIncludeInBrowse = false
	)

Retrieve all authors for a publication.

Parameters

$publicationId	int Publication ID.
$sortByAuthorId	bool Use author Ids as indexes in the array
$useIncludeInBrowse	bool Whether to limit to just include_in_browse authors

Returns

array Authors ordered by sequence

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

References _fromRow(), and DAO\retrieve().

Referenced by changePublicationLocale(), and deleteBySubmissionId().

getInsertId()

PKPAuthorDAO::getInsertId

(

)

Get the ID of the last inserted author.

Returns

int

Reimplemented from SchemaDAO.

Definition at line 148 of file PKPAuthorDAO.inc.php.

References DAO\_getInsertId().

newDataObject()

PKPAuthorDAO::newDataObject

(

)

Get a new data object

Returns

DataObject

Reimplemented from SchemaDAO.

Definition at line 47 of file PKPAuthorDAO.inc.php.

Field Documentation

$primaryKeyColumn

PKPAuthorDAO::$primaryKeyColumn = 'author_id'

Definition at line 31 of file PKPAuthorDAO.inc.php.

$primaryTableColumns

PKPAuthorDAO::$primaryTableColumns

Initial value:

= [
      'id' => 'author_id',
      'email' => 'email',
      'includeInBrowse' => 'include_in_browse',
      'publicationId' => 'publication_id',
      'seq' => 'seq',
      'userGroupId' => 'user_group_id',
   ]

Definition at line 34 of file PKPAuthorDAO.inc.php.

$schemaName

PKPAuthorDAO::$schemaName = SCHEMA_AUTHOR

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

$settingsTableName

PKPAuthorDAO::$settingsTableName = 'author_settings'

Definition at line 28 of file PKPAuthorDAO.inc.php.

$tableName

PKPAuthorDAO::$tableName = 'authors'

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

---

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

• PKPAuthorDAO.inc.php