Open Journal Systems  3.3.0
SubmissionKeywordDAO Class Reference
Inheritance diagram for SubmissionKeywordDAO:
ControlledVocabDAO DAO

Public Member Functions

 build ($publicationId, $assocType=ASSOC_TYPE_PUBLICATION)
 
 deleteByPublicationId ($publicationId)
 
 getAllUniqueKeywords ()
 
 getKeywords ($publicationId, $locales=[], $assocType=ASSOC_TYPE_PUBLICATION)
 
 getLocaleFieldNames ()
 
 insertKeywords ($keywords, $publicationId, $deleteFirst=true, $assocType=ASSOC_TYPE_PUBLICATION)
 
- 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 keywords.

See also
Submission

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

Member Function Documentation

◆ build()

SubmissionKeywordDAO::build (   $publicationId,
  $assocType = ASSOC_TYPE_PUBLICATION 
)

Build/fetch and return a controlled vocabulary for keywords.

Parameters
$publicationIdint
$assocTypeint DO NOT USE: For <3.1 to 3.x migration pkp/pkp-lib#3572 pkp/pkp-lib#6213
Returns
ControlledVocab

Definition at line 29 of file SubmissionKeywordDAO.inc.php.

Referenced by deleteByPublicationId(), getKeywords(), and insertKeywords().

◆ deleteByPublicationId()

SubmissionKeywordDAO::deleteByPublicationId (   $publicationId)

Delete keywords by publication ID

Parameters
int$publicationid
Returns
int|array Controlled Vocab

Definition at line 132 of file SubmissionKeywordDAO.inc.php.

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

Referenced by insertKeywords().

◆ getAllUniqueKeywords()

SubmissionKeywordDAO::getAllUniqueKeywords ( )

Get an array of all of the submission's keywords

Returns
array

Definition at line 74 of file SubmissionKeywordDAO.inc.php.

References DAO\retrieve().

◆ getKeywords()

SubmissionKeywordDAO::getKeywords (   $publicationId,
  $locales = [],
  $assocType = ASSOC_TYPE_PUBLICATION 
)

Get keywords for a submission.

Parameters
$publicationIdint
$localesarray
$assocTypeint DO NOT USE: For <3.1 to 3.x migration pkp/pkp-lib#6213
Returns
array

Definition at line 49 of file SubmissionKeywordDAO.inc.php.

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

◆ getLocaleFieldNames()

SubmissionKeywordDAO::getLocaleFieldNames ( )

Get the list of localized additional fields to store.

Returns
array

Reimplemented from DAO.

Definition at line 38 of file SubmissionKeywordDAO.inc.php.

◆ insertKeywords()

SubmissionKeywordDAO::insertKeywords (   $keywords,
  $publicationId,
  $deleteFirst = true,
  $assocType = ASSOC_TYPE_PUBLICATION 
)

Add an array of keywords

Parameters
$keywordsarray
$publicationIdint
$deleteFirstboolean
$assocTypeint DO NOT USE: For <3.1 to 3.x migration pkp/pkp-lib#3572 pkp/pkp-lib#6213
Returns
int

Definition at line 98 of file SubmissionKeywordDAO.inc.php.

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


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