Open Preprint Systems  3.3.0
SubmissionAgencyDAO Class Reference
Inheritance diagram for SubmissionAgencyDAO:
ControlledVocabDAO DAO

Public Member Functions

 build ($publicationId)
 
 getAgencies ($publicationId, $locales=[])
 
 getAllUniqueAgencies ()
 
 getLocaleFieldNames ()
 
 insertAgencies ($agencies, $publicationId, $deleteFirst=true)
 
- Public Member Functions inherited from ControlledVocabDAO
 _build ($symbolic, $assocType=0, $assocId=0)
 
 _fromRow ($row)
 
 deleteObject ($controlledVocab)
 
 deleteObjectById ($controlledVocabId)
 
 enumerate ($controlledVocabId, $settingName='name')
 
 enumerateBySymbolic ($symbolic, $assocType, $assocId, $settingName='name')
 
 getById ($controlledVocabId)
 
 getBySymbolic ($symbolic, $assocType=0, $assocId=0)
 
 getEntryDAO ()
 
 getInsertId ()
 
 insertObject ($controlledVocab, $dieOnError=true)
 
 installXML ($filename)
 
 newDataObject ()
 
 updateObject (&$controlledVocab)
 
- 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 ()
 
 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 DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

Operations for retrieving and modifying a submission's assigned agencies.

See also
Submission

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

Member Function Documentation

◆ build()

SubmissionAgencyDAO::build (   $publicationId)

Build/fetch and return a controlled vocabulary for agencies.

Parameters
$publicationIdint
Returns
ControlledVocab

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

Referenced by getAgencies(), and insertAgencies().

◆ getAgencies()

SubmissionAgencyDAO::getAgencies (   $publicationId,
  $locales = [] 
)

Get agencies for a specified submission ID.

Parameters
$publicationIdint
$localesarray
Returns
array

Definition at line 46 of file SubmissionAgencyDAO.inc.php.

References build(), and DAORegistry\getDAO().

◆ getAllUniqueAgencies()

SubmissionAgencyDAO::getAllUniqueAgencies ( )

Get an array of all of the submission's agencies

Returns
array

Definition at line 71 of file SubmissionAgencyDAO.inc.php.

References DAO\retrieve().

◆ getLocaleFieldNames()

SubmissionAgencyDAO::getLocaleFieldNames ( )

Get the list of localized additional fields to store.

Returns
array

Reimplemented from DAO.

Definition at line 36 of file SubmissionAgencyDAO.inc.php.

◆ insertAgencies()

SubmissionAgencyDAO::insertAgencies (   $agencies,
  $publicationId,
  $deleteFirst = true 
)

Add an array of agencies

Parameters
$agenciesarray List of agencies.
$publicationIdint Submission ID.
$deleteFirstboolean True iff existing agencies should be removed first.
Returns
int

Definition at line 94 of file SubmissionAgencyDAO.inc.php.

References build(), and DAORegistry\getDAO().


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