PHP 클래스 LucenePlugin, ojs

상속: extends GenericPlugin
파일 보기 프로젝트 열기: pkp/ojs 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$_enabledFacetCategories array
$_facets array
$_highlightedArticles array
$_mailTemplates array
$_solrWebService SolrWebService
$_spellingSuggestion string
$_spellingSuggestionField string

공개 메소드들

메소드 설명
__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.

메소드 상세

__construct() 공개 메소드

Constructor
public __construct ( )

_getEnabledFacetCategories() 공개 메소드

Get all currently enabled facet categories.
public _getEnabledFacetCategories ( ) : array
리턴 array

_getRankingBoostOptions() 공개 메소드

Return the available ranking boost options.
public _getRankingBoostOptions ( ) : array
리턴 array

_indexingMessage() 공개 메소드

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() 공개 메소드

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() 공개 메소드

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.
리턴 boolean True on success, otherwise false.

_spamCheck() 공개 메소드

Checks whether a minimum amount of time has passed since the last email message went out.
public _spamCheck ( ) : boolean
리턴 boolean True if a new email can be sent, false if we better keep silent.

_updateBoostFiles() 공개 메소드

Generate and update the boost file.
public _updateBoostFiles ( )

callbackArticleChangesFinished() 공개 메소드

또한 보기: ArticleSearchIndex::articleChangesFinished()
public callbackArticleChangesFinished ( $hookName, $params )

callbackArticleDaoAdditionalFieldNames() 공개 메소드

또한 보기: DAO::getAdditionalFieldNames()
public callbackArticleDaoAdditionalFieldNames ( $hookName, $args )

callbackArticleDeleted() 공개 메소드

또한 보기: ArticleSearchIndex::articleDeleted()
public callbackArticleDeleted ( $hookName, $params )

callbackArticleMetadataChanged() 공개 메소드

또한 보기: ArticleSearchIndex::articleMetadataChanged()
public callbackArticleMetadataChanged ( $hookName, $params )

callbackGetResultSetOrderingOptions() 공개 메소드

또한 보기: ArticleSearch::getResultSetOrderingOptions()
public callbackGetResultSetOrderingOptions ( $hookName, $params )

callbackGetSimilarityTerms() 공개 메소드

또한 보기: ArticleSearch::getSimilarityTerms()
public callbackGetSimilarityTerms ( $hookName, $params )

callbackLoadCategory() 공개 메소드

또한 보기: PluginRegistry::loadCategory()
public callbackLoadCategory ( $hookName, $args )

callbackLoadHandler() 공개 메소드

또한 보기: PKPPageRouter::route()
public callbackLoadHandler ( $hookName, $args )

callbackRebuildIndex() 공개 메소드

또한 보기: ArticleSearchIndex::rebuildIndex()
public callbackRebuildIndex ( $hookName, $params )

callbackRetrieveResults() 공개 메소드

public callbackRetrieveResults ( $hookName, $params )

callbackSectionDaoAdditionalFieldNames() 공개 메소드

또한 보기: DAO::getAdditionalFieldNames()
public callbackSectionDaoAdditionalFieldNames ( $hookName, $args )

callbackSectionFormConstructor() 공개 메소드

또한 보기: Form::__construct()
public callbackSectionFormConstructor ( $hookName, $params )

callbackSectionFormExecute() 공개 메소드

또한 보기: Form::execute()
public callbackSectionFormExecute ( $hookName, $params )

callbackSectionFormInitData() 공개 메소드

또한 보기: Form::initData()
public callbackSectionFormInitData ( $hookName, $params )

callbackSectionFormReadUserVars() 공개 메소드

또한 보기: Form::readUserVars()
public callbackSectionFormReadUserVars ( $hookName, $params )

callbackSubmissionFileChanged() 공개 메소드

또한 보기: ArticleSearchIndex::submissionFileChanged()
public callbackSubmissionFileChanged ( $hookName, $params )

callbackSubmissionFileDeleted() 공개 메소드

또한 보기: ArticleSearchIndex::submissionFileDeleted()
public callbackSubmissionFileDeleted ( $hookName, $params )

callbackSubmissionFilesChanged() 공개 메소드

또한 보기: ArticleSearchIndex::submissionFilesChanged()
public callbackSubmissionFilesChanged ( $hookName, $params )

callbackTemplateAdditionalArticleInfo() 공개 메소드

public callbackTemplateAdditionalArticleInfo ( $hookName, $params )

callbackTemplateDisplay() 공개 메소드

또한 보기: TemplateManager::display()
public callbackTemplateDisplay ( $hookName, $params )

callbackTemplateFilterInput() 공개 메소드

public callbackTemplateFilterInput ( $hookName, $params )

callbackTemplatePreResults() 공개 메소드

public callbackTemplatePreResults ( $hookName, $params )

callbackTemplateSectionFormAdditionalMetadata() 공개 메소드

public callbackTemplateSectionFormAdditionalMetadata ( $hookName, $params )

callbackTemplateSyntaxInstructions() 공개 메소드

public callbackTemplateSyntaxInstructions ( $hookName, $params )

generateBoostFile() 공개 메소드

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() 공개 메소드

또한 보기: Plugin::getDescription()
public getDescription ( )

getDisplayName() 공개 메소드

또한 보기: Plugin::getDisplayName()
public getDisplayName ( )

getFacets() 공개 메소드

Facets corresponding to a recent search (if any).
public getFacets ( ) : boolean
리턴 boolean

getInstallEmailTemplateDataFile() 공개 메소드

또한 보기: Plugin::getInstallEmailTemplateDataFile()

getInstallEmailTemplatesFile() 공개 메소드

또한 보기: Plugin::getInstallEmailTemplatesFile()

getInstallSitePluginSettingsFile() 공개 메소드

또한 보기: Plugin::getInstallSitePluginSettingsFile()

getMailTemplate() 공개 메소드

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

getSolrWebService() 공개 메소드

Get the solr web service.
public getSolrWebService ( ) : SolrWebService
리턴 SolrWebService

getTemplatePath() 공개 메소드

public getTemplatePath ( $inCore = false )

isSitePlugin() 공개 메소드

또한 보기: Plugin::isSitePlugin()
public isSitePlugin ( )

manage() 공개 메소드

public manage ( $args, $request )

register() 공개 메소드

또한 보기: Plugin::register()
public register ( $category, $path )

setMailTemplate() 공개 메소드

NB: Required to override the mailer implementation for testing.
public setMailTemplate ( $emailKey, &$mailTemplate )
$emailKey string
$mailTemplate MailTemplate

프로퍼티 상세

$_enabledFacetCategories 공개적으로 프로퍼티

public array $_enabledFacetCategories
리턴 array

$_facets 공개적으로 프로퍼티

public array $_facets
리턴 array

$_highlightedArticles 공개적으로 프로퍼티

public array $_highlightedArticles
리턴 array

$_mailTemplates 공개적으로 프로퍼티

public array $_mailTemplates
리턴 array

$_solrWebService 공개적으로 프로퍼티

public SolrWebService $_solrWebService
리턴 SolrWebService

$_spellingSuggestion 공개적으로 프로퍼티

public string $_spellingSuggestion
리턴 string

$_spellingSuggestionField 공개적으로 프로퍼티

public string $_spellingSuggestionField
리턴 string