Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
LucenePlugin Class Reference
Inheritance diagram for LucenePlugin:
GenericPlugin

Public Member Functions

 _getEnabledFacetCategories ()
 
 _getRankingBoostOptions ()
 
 _getResultSetOrdering ($journal)
 
 _getResultSetOrderingDirectionOptions ()
 
 _getResultSetOrderingOptions ($journal)
 
 _informTechAdmin ($error, $journal=null, $isSearchProblem=false)
 
 _setBreadcrumbs ()
 
 _spamCheck ()
 
 callbackArticleChangesFinished ($hookName, $params)
 
 callbackArticleDaoAdditionalFieldNames ($hookName, $args)
 
 callbackArticleDeleted ($hookName, $params)
 
 callbackArticleFileChanged ($hookName, $params)
 
 callbackArticleFileDeleted ($hookName, $params)
 
 callbackArticleFilesChanged ($hookName, $params)
 
 callbackArticleMetadataChanged ($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)
 
 callbackSuppFileMetadataChanged ($hookName, $params)
 
 callbackTemplateAdditionalArticleInfo ($hookName, $params)
 
 callbackTemplateAdditionalArticleLinks ($hookName, $params)
 
 callbackTemplateDisplay ($hookName, $params)
 
 callbackTemplateFilterInput ($hookName, $params)
 
 callbackTemplatePreResults ($hookName, $params)
 
 callbackTemplateSectionFormAdditionalMetadata ($hookName, $params)
 
 callbackTemplateSyntaxInstructions ($hookName, $params)
 
 getDescription ()
 
 getDisplayName ()
 
 getFacets ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallSitePluginSettingsFile ()
 
getMailTemplate ($emailKey, $journal=null)
 
 getManagementVerbs ()
 
getSolrWebService ()
 
 getTemplatePath ()
 
 isSitePlugin ()
 
 LucenePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams)
 
 register ($category, $path)
 
 setMailTemplate ($emailKey, &$mailTemplate)
 
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 
 getManagementVerbs ($verbs=array())
 
 manage ($verb, $args, &$message, &$messageParams)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Lucene plugin class.

Definition at line 22 of file LucenePlugin.inc.php.

Member Function Documentation

LucenePlugin::_getEnabledFacetCategories ( )

Get all currently enabled facet categories.

Returns
array

Definition at line 952 of file LucenePlugin.inc.php.

References Plugin\getSetting().

Referenced by callbackLoadCategory(), and callbackRetrieveResults().

LucenePlugin::_getRankingBoostOptions ( )

Return the available ranking boost options.

Returns
array

Definition at line 1029 of file LucenePlugin.inc.php.

Referenced by callbackSectionFormConstructor(), callbackSectionFormExecute(), callbackSectionFormInitData(), and callbackTemplateSectionFormAdditionalMetadata().

LucenePlugin::_getResultSetOrdering (   $journal)

Return the currently selected result set ordering option (default: descending relevance).

Parameters
$journalJournal
Returns
array An array with the order field as the first entry and the order direction as the second entry.

Definition at line 923 of file LucenePlugin.inc.php.

References _getResultSetOrderingDirectionOptions(), _getResultSetOrderingOptions(), and PKPApplication\getRequest().

Referenced by callbackRetrieveResults(), and callbackTemplateDisplay().

LucenePlugin::_getResultSetOrderingDirectionOptions ( )

Return the available options for the result set ordering direction.

Returns
array

Definition at line 908 of file LucenePlugin.inc.php.

Referenced by _getResultSetOrdering(), and callbackTemplateDisplay().

LucenePlugin::_getResultSetOrderingOptions (   $journal)

Return the available options for result set ordering.

Parameters
$journalJournal
Returns
array

Definition at line 886 of file LucenePlugin.inc.php.

Referenced by _getResultSetOrdering(), and callbackTemplateDisplay().

LucenePlugin::_informTechAdmin (   $error,
  $journal = null,
  $isSearchProblem = false 
)

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

Parameters
$errorarray An array of article ids.
$journalJournal A journal object.
$isSearchProblemboolean Whether a search problem is being reported.

Definition at line 994 of file LucenePlugin.inc.php.

References _spamCheck(), getMailTemplate(), and PKPApplication\getRequest().

Referenced by callbackArticleChangesFinished(), callbackRebuildIndex(), and callbackRetrieveResults().

LucenePlugin::_setBreadcrumbs ( )

Set the page's breadcrumbs, given the plugin's tree of items to append.

Definition at line 861 of file LucenePlugin.inc.php.

References Request\url().

LucenePlugin::_spamCheck ( )

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

Returns
boolean True if a new email can be sent, false if we better keep silent.

Definition at line 975 of file LucenePlugin.inc.php.

References Plugin\getSetting(), and Plugin\updateSetting().

Referenced by _informTechAdmin().

LucenePlugin::callbackArticleChangesFinished (   $hookName,
  $params 
)
LucenePlugin::callbackArticleDaoAdditionalFieldNames (   $hookName,
  $args 
)
See Also
DAO::getAdditionalFieldNames()

Definition at line 331 of file LucenePlugin.inc.php.

LucenePlugin::callbackArticleDeleted (   $hookName,
  $params 
)
See Also
ArticleSearchIndex::articleDeleted()

Definition at line 531 of file LucenePlugin.inc.php.

LucenePlugin::callbackArticleFileChanged (   $hookName,
  $params 
)
LucenePlugin::callbackArticleFileDeleted (   $hookName,
  $params 
)
LucenePlugin::callbackArticleFilesChanged (   $hookName,
  $params 
)
LucenePlugin::callbackArticleMetadataChanged (   $hookName,
  $params 
)
LucenePlugin::callbackLoadCategory (   $hookName,
  $args 
)
LucenePlugin::callbackLoadHandler (   $hookName,
  $args 
)
LucenePlugin::callbackRebuildIndex (   $hookName,
  $params 
)
LucenePlugin::callbackRetrieveResults (   $hookName,
  $params 
)
LucenePlugin::callbackSectionDaoAdditionalFieldNames (   $hookName,
  $args 
)
See Also
DAO::getAdditionalFieldNames()

Definition at line 342 of file LucenePlugin.inc.php.

LucenePlugin::callbackSectionFormConstructor (   $hookName,
  $params 
)
See Also
Form::Form()

Definition at line 639 of file LucenePlugin.inc.php.

References _getRankingBoostOptions().

LucenePlugin::callbackSectionFormExecute (   $hookName,
  $params 
)
See Also
Form::execute()

Definition at line 691 of file LucenePlugin.inc.php.

References _getRankingBoostOptions().

LucenePlugin::callbackSectionFormInitData (   $hookName,
  $params 
)
See Also
Form::initData()

Definition at line 656 of file LucenePlugin.inc.php.

References _getRankingBoostOptions().

LucenePlugin::callbackSectionFormReadUserVars (   $hookName,
  $params 
)
See Also
Form::readUserVars()

Definition at line 682 of file LucenePlugin.inc.php.

LucenePlugin::callbackSuppFileMetadataChanged (   $hookName,
  $params 
)
LucenePlugin::callbackTemplateAdditionalArticleInfo (   $hookName,
  $params 
)
See Also
templates/search/searchResults.tpl

Definition at line 805 of file LucenePlugin.inc.php.

References Plugin\getSetting().

LucenePlugin::callbackTemplateAdditionalArticleLinks (   $hookName,
  $params 
)
See Also
templates/search/searchResults.tpl

Definition at line 773 of file LucenePlugin.inc.php.

References PKPApplication\getRequest(), and Plugin\getSetting().

LucenePlugin::callbackTemplateDisplay (   $hookName,
  $params 
)
LucenePlugin::callbackTemplateFilterInput (   $hookName,
  $params 
)
See Also
templates/search/searchResults.tpl

Definition at line 745 of file LucenePlugin.inc.php.

References getTemplatePath().

LucenePlugin::callbackTemplatePreResults (   $hookName,
  $params 
)
See Also
templates/search/searchResults.tpl

Definition at line 756 of file LucenePlugin.inc.php.

References getTemplatePath().

LucenePlugin::callbackTemplateSectionFormAdditionalMetadata (   $hookName,
  $params 
)
See Also
templates/manager/sections/sectionForm.tpl

Definition at line 842 of file LucenePlugin.inc.php.

References _getRankingBoostOptions(), and getTemplatePath().

LucenePlugin::callbackTemplateSyntaxInstructions (   $hookName,
  $params 
)
See Also
templates/search/searchResults.tpl

Definition at line 833 of file LucenePlugin.inc.php.

LucenePlugin::getDescription ( )
See Also
PKPPlugin::getDescription()

Definition at line 181 of file LucenePlugin.inc.php.

LucenePlugin::getDisplayName ( )
See Also
PKPPlugin::getDisplayName()

Definition at line 174 of file LucenePlugin.inc.php.

LucenePlugin::getFacets ( )

Facets corresponding to a recent search (if any).

Returns
boolean

Definition at line 70 of file LucenePlugin.inc.php.

LucenePlugin::getInstallEmailTemplateDataFile ( )
LucenePlugin::getInstallEmailTemplatesFile ( )
LucenePlugin::getInstallSitePluginSettingsFile ( )
& LucenePlugin::getMailTemplate (   $emailKey,
  $journal = null 
)

Instantiate a MailTemplate

Parameters
$emailKeystring
$journalJournal

Definition at line 93 of file LucenePlugin.inc.php.

Referenced by _informTechAdmin().

LucenePlugin::getManagementVerbs ( )
See Also
GenericPlugin::getManagementVerbs()

Definition at line 226 of file LucenePlugin.inc.php.

& LucenePlugin::getSolrWebService ( )

Get the solr web service.

Returns
SolrWebService

Definition at line 61 of file LucenePlugin.inc.php.

Referenced by callbackArticleChangesFinished(), callbackRebuildIndex(), and callbackRetrieveResults().

LucenePlugin::isSitePlugin ( )
See Also
PKPPlugin::isSitePlugin()

Definition at line 209 of file LucenePlugin.inc.php.

LucenePlugin::LucenePlugin ( )

Constructor

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

LucenePlugin::manage (   $verb,
  $args,
$message,
$messageParams 
)
LucenePlugin::register (   $category,
  $path 
)
LucenePlugin::setMailTemplate (   $emailKey,
$mailTemplate 
)

Set an alternative article mailer implementation.

NB: Required to override the mailer implementation for testing.

Parameters
$emailKeystring
$mailTemplateMailTemplate

Definition at line 83 of file LucenePlugin.inc.php.


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