PHP Class LucenePlugin, ojs

Inheritance: extends GenericPlugin

Afficher le fichier Open project: pkp/ojs Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$_enabledFacetCategories	array
$_facets	array
$_highlightedArticles	array
$_mailTemplates	array
$_solrWebService	SolrWebService
$_spellingSuggestion	string
$_spellingSuggestionField	string

Méthodes publiques

Méthode	Description
__construct ( )	Constructor
_getEnabledFacetCategories ( ) : array	Get all currently enabled facet categories.
_getRankingBoostOptions ( ) : array	Return the available ranking boost options.
_indexingMessage ( $log, $message, &$messages )	Output an indexing message.
_informTechAdmin ( $error, $journal = null, $isSearchProblem = false )	Send an email to the site's tech admin warning that an indexing error has occurred.
_rebuildIndex ( $log, $journal, $buildIndex, $buildDictionaries, $updateBoostFile, &$messages ) : boolean	Rebuild the index for all journals or a single journal
_spamCheck ( ) : boolean	Checks whether a minimum amount of time has passed since the last email message went out.
_updateBoostFiles ( )	Generate and update the boost file.
callbackArticleChangesFinished ( $hookName, $params )
callbackArticleDaoAdditionalFieldNames ( $hookName, $args )
callbackArticleDeleted ( $hookName, $params )
callbackArticleMetadataChanged ( $hookName, $params )
callbackGetResultSetOrderingOptions ( $hookName, $params )
callbackGetSimilarityTerms ( $hookName, $params )
callbackLoadCategory ( $hookName, $args )
callbackLoadHandler ( $hookName, $args )
callbackRebuildIndex ( $hookName, $params )
callbackRetrieveResults ( $hookName, $params )
callbackSectionDaoAdditionalFieldNames ( $hookName, $args )
callbackSectionFormConstructor ( $hookName, $params )
callbackSectionFormExecute ( $hookName, $params )
callbackSectionFormInitData ( $hookName, $params )
callbackSectionFormReadUserVars ( $hookName, $params )
callbackSubmissionFileChanged ( $hookName, $params )
callbackSubmissionFileDeleted ( $hookName, $params )
callbackSubmissionFilesChanged ( $hookName, $params )
callbackTemplateAdditionalArticleInfo ( $hookName, $params )
callbackTemplateDisplay ( $hookName, $params )
callbackTemplateFilterInput ( $hookName, $params )
callbackTemplatePreResults ( $hookName, $params )
callbackTemplateSectionFormAdditionalMetadata ( $hookName, $params )
callbackTemplateSyntaxInstructions ( $hookName, $params )
generateBoostFile ( $timeFilter, $output = true )	Generate an external boost file from usage statistics data.
getDescription ( )
getDisplayName ( )
getFacets ( ) : boolean	Facets corresponding to a recent search (if any).
getInstallEmailTemplateDataFile ( )
getInstallEmailTemplatesFile ( )
getInstallSitePluginSettingsFile ( )
getMailTemplate ( $emailKey, $journal = null )	Instantiate a MailTemplate
getSolrWebService ( ) : SolrWebService	Get the solr web service.
getTemplatePath ( $inCore = false )
isSitePlugin ( )
manage ( $args, $request )
register ( $category, $path )
setMailTemplate ( $emailKey, &$mailTemplate )	Set an alternative article mailer implementation.

Method Details

__construct() public méthode

Constructor

public __construct ( )

_getEnabledFacetCategories() public méthode

Get all currently enabled facet categories.

public _getEnabledFacetCategories ( ) : array
Résultat	array

_getRankingBoostOptions() public méthode

Return the available ranking boost options.

public _getRankingBoostOptions ( ) : array
Résultat	array

_indexingMessage() public méthode

Output an indexing message.

public _indexingMessage ( $log, $message, &$messages )
$log		boolean Whether to write the log to standard output.
$message		string The message to display/add.
$messages		string Return parameter for log message output.

_informTechAdmin() public méthode

Send an email to the site's tech admin warning that an indexing error has occurred.

public _informTechAdmin ( $error, $journal = null, $isSearchProblem = false )
$error		array An array of article ids.
$journal		Journal A journal object.
$isSearchProblem		boolean Whether a search problem is being reported.

_rebuildIndex() public méthode

Rebuild the index for all journals or a single journal

public _rebuildIndex ( $log, $journal, $buildIndex, $buildDictionaries, $updateBoostFile, &$messages ) : boolean
$log		boolean Whether to write the log to standard output.
$journal		Journal If given, only re-index this journal.
$buildIndex		boolean Whether to rebuild the journal index.
$buildDictionaries		boolean Whether to rebuild dictionaries.
$messages		string Return parameter for log message output.
Résultat	boolean	True on success, otherwise false.

_spamCheck() public méthode

Checks whether a minimum amount of time has passed since the last email message went out.

public _spamCheck ( ) : boolean
Résultat	boolean	True if a new email can be sent, false if we better keep silent.

_updateBoostFiles() public méthode

Generate and update the boost file.

public _updateBoostFiles ( )

callbackArticleChangesFinished() public méthode

See also: ArticleSearchIndex::articleChangesFinished()

public callbackArticleChangesFinished ( $hookName, $params )

callbackArticleDaoAdditionalFieldNames() public méthode

See also: DAO::getAdditionalFieldNames()

public callbackArticleDaoAdditionalFieldNames ( $hookName, $args )

callbackArticleDeleted() public méthode

See also: ArticleSearchIndex::articleDeleted()

public callbackArticleDeleted ( $hookName, $params )

callbackArticleMetadataChanged() public méthode

See also: ArticleSearchIndex::articleMetadataChanged()

public callbackArticleMetadataChanged ( $hookName, $params )

callbackGetResultSetOrderingOptions() public méthode

See also: ArticleSearch::getResultSetOrderingOptions()

public callbackGetResultSetOrderingOptions ( $hookName, $params )

callbackGetSimilarityTerms() public méthode

See also: ArticleSearch::getSimilarityTerms()

public callbackGetSimilarityTerms ( $hookName, $params )

callbackLoadCategory() public méthode

See also: PluginRegistry::loadCategory()

public callbackLoadCategory ( $hookName, $args )

callbackLoadHandler() public méthode

callbackRebuildIndex() public méthode

See also: ArticleSearchIndex::rebuildIndex()

public callbackRebuildIndex ( $hookName, $params )

callbackRetrieveResults() public méthode

public callbackRetrieveResults ( $hookName, $params )

callbackSectionDaoAdditionalFieldNames() public méthode

See also: DAO::getAdditionalFieldNames()

public callbackSectionDaoAdditionalFieldNames ( $hookName, $args )

callbackSectionFormConstructor() public méthode

callbackSectionFormExecute() public méthode

callbackSectionFormInitData() public méthode

callbackSectionFormReadUserVars() public méthode

callbackSubmissionFileChanged() public méthode

See also: ArticleSearchIndex::submissionFileChanged()

public callbackSubmissionFileChanged ( $hookName, $params )

callbackSubmissionFileDeleted() public méthode

See also: ArticleSearchIndex::submissionFileDeleted()

public callbackSubmissionFileDeleted ( $hookName, $params )

callbackSubmissionFilesChanged() public méthode

See also: ArticleSearchIndex::submissionFilesChanged()

public callbackSubmissionFilesChanged ( $hookName, $params )

callbackTemplateAdditionalArticleInfo() public méthode

public callbackTemplateAdditionalArticleInfo ( $hookName, $params )

callbackTemplateDisplay() public méthode

callbackTemplateFilterInput() public méthode

public callbackTemplateFilterInput ( $hookName, $params )

callbackTemplatePreResults() public méthode

public callbackTemplatePreResults ( $hookName, $params )

callbackTemplateSectionFormAdditionalMetadata() public méthode

public callbackTemplateSectionFormAdditionalMetadata ( $hookName, $params )

callbackTemplateSyntaxInstructions() public méthode

public callbackTemplateSyntaxInstructions ( $hookName, $params )

generateBoostFile() public méthode

The file will be empty when an error condition is met.

public generateBoostFile ( $timeFilter, $output = true )
$timeFilter		string Can be one of "all" (all-time statistics) or "month" (last month only).
$output		boolean\|string When true then write to stdout, otherwise interpret the variable as file name and write to the given file.

getDescription() public méthode

getDisplayName() public méthode

getFacets() public méthode

Facets corresponding to a recent search (if any).

public getFacets ( ) : boolean
Résultat	boolean

getInstallEmailTemplateDataFile() public méthode

See also: Plugin::getInstallEmailTemplateDataFile()

public getInstallEmailTemplateDataFile ( )

getInstallEmailTemplatesFile() public méthode

See also: Plugin::getInstallEmailTemplatesFile()

public getInstallEmailTemplatesFile ( )

getInstallSitePluginSettingsFile() public méthode

See also: Plugin::getInstallSitePluginSettingsFile()

public getInstallSitePluginSettingsFile ( )

getMailTemplate() public méthode

Instantiate a MailTemplate

public getMailTemplate ( $emailKey, $journal = null )
$emailKey		string
$journal		Journal

getSolrWebService() public méthode

Get the solr web service.

public getSolrWebService ( ) : SolrWebService
Résultat	SolrWebService

getTemplatePath() public méthode

public getTemplatePath ( $inCore = false )

isSitePlugin() public méthode

manage() public méthode

public manage ( $args, $request )

register() public méthode

setMailTemplate() public méthode

NB: Required to override the mailer implementation for testing.

public setMailTemplate ( $emailKey, &$mailTemplate )
$emailKey		string
$mailTemplate		MailTemplate

Property Details

$_enabledFacetCategories public_oe property

public array $_enabledFacetCategories
Résultat	array

$_facets public_oe property

public array $_facets
Résultat	array

$_highlightedArticles public_oe property

public array $_highlightedArticles
Résultat	array

$_mailTemplates public_oe property

public array $_mailTemplates
Résultat	array

$_solrWebService public_oe property

public SolrWebService $_solrWebService
Résultat	SolrWebService

$_spellingSuggestion public_oe property

public string $_spellingSuggestion
Résultat	string

$_spellingSuggestionField public_oe property

public string $_spellingSuggestionField
Résultat	string