Open Journal Systems  3.3.0
SubmissionSearchDAO Class Reference
Inheritance diagram for SubmissionSearchDAO:
DAO ArticleSearchDAO

Public Member Functions

 clearIndex ()
 
 deleteSubmissionKeywords ($submissionId, $type=null, $assocId=null)
 
 insertKeyword ($keyword)
 
 insertObject ($submissionId, $type, $assocId, $keepExisting=false)
 
 insertObjectKeyword ($objectId, $keyword, $position)
 
- 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 DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

DAO class for submission search index.

See also
SubmissionSearch

Definition at line 17 of file SubmissionSearchDAO.inc.php.

Member Function Documentation

◆ clearIndex()

SubmissionSearchDAO::clearIndex ( )

Clear the search index.

Definition at line 133 of file SubmissionSearchDAO.inc.php.

References DAO\getDataSource(), Config\getVar(), DAO\setCacheDir(), and DAO\update().

◆ deleteSubmissionKeywords()

SubmissionSearchDAO::deleteSubmissionKeywords (   $submissionId,
  $type = null,
  $assocId = null 
)

Delete all keywords for a submission.

Parameters
$submissionIdint
$typeint optional
$assocIdint optional

Definition at line 59 of file SubmissionSearchDAO.inc.php.

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

◆ insertKeyword()

SubmissionSearchDAO::insertKeyword (   $keyword)

Add a word to the keyword list (if it doesn't already exist).

Parameters
$keywordstring
Returns
int the keyword ID

Definition at line 24 of file SubmissionSearchDAO.inc.php.

References DAO\_getInsertId(), DAO\retrieve(), and DAO\update().

Referenced by insertObjectKeyword().

◆ insertObject()

SubmissionSearchDAO::insertObject (   $submissionId,
  $type,
  $assocId,
  $keepExisting = false 
)

Add a submission object to the index (if already exists, indexed keywords are cleared).

Parameters
$submissionIdint
$typeint
$assocIdint
Returns
int the object ID

Definition at line 90 of file SubmissionSearchDAO.inc.php.

References DAO\_getInsertId(), DAO\retrieve(), and DAO\update().

◆ insertObjectKeyword()

SubmissionSearchDAO::insertObjectKeyword (   $objectId,
  $keyword,
  $position 
)

Index an occurrence of a keyword in an object.

Parameters
$objectIdint
$keywordstring
$positionint
Returns
$keywordId

Definition at line 120 of file SubmissionSearchDAO.inc.php.

References insertKeyword(), and DAO\update().


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