Public Member Functions | |
| clearSubmissionFiles ($submission) | |
| filterKeywords ($text, $allowWildcards=false) | |
| submissionChangesFinished () | |
| submissionMetadataChanged ($submission) | |
Protected Member Functions | |
| _loadStopwords () | |
Detailed Description
Class to maintain a submission search index.
Definition at line 25 of file SubmissionSearchIndex.inc.php.
Member Function Documentation
◆ _loadStopwords()
|
protected |
Return list of stopwords. FIXME: Should this be locale-specific?
- Returns
- array with stopwords as keys
Definition at line 65 of file SubmissionSearchIndex.inc.php.
Referenced by filterKeywords().
◆ clearSubmissionFiles()
|
abstract |
Remove indexed file contents for a submission
- Parameters
-
$submission Submission
Reimplemented in ArticleSearchIndex.
◆ filterKeywords()
| SubmissionSearchIndex::filterKeywords | ( | $text, | |
$allowWildcards = false |
|||
| ) |
Split a string into a clean array of keywords
- Parameters
-
$text string $allowWildcards boolean
- Returns
- array of keywords
Definition at line 32 of file SubmissionSearchIndex.inc.php.
References _loadStopwords(), Config\getVar(), PKPString\regexp_replace(), PKPString\regexp_split(), PKPString\strlen(), PKPString\strtolower(), and PKPString\substr().
Referenced by ArticleSearchIndex\_indexObjectKeywords().
◆ submissionChangesFinished()
|
abstract |
Let the indexing back-end know that the current transaction finished so that the index can be batch-updated.
Reimplemented in ArticleSearchIndex.
◆ submissionMetadataChanged()
|
abstract |
Signal to the indexing back-end that the metadata of a submission changed.
Push indexing implementations will try to immediately update the index to reflect the changes. Pull implementations will mark articles as "changed" and let the indexing back-end decide the best point in time to actually index the changed data.
- Parameters
-
$submission Submission
Reimplemented in ArticleSearchIndex.
The documentation for this class was generated from the following file:
