| Свойство | Тип | Описание | |
|---|---|---|---|
| $_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. |
| public _getEnabledFacetCategories ( ) : array | ||
| Результат | array | |
| public _getRankingBoostOptions ( ) : array | ||
| Результат | array | |
| 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. | |
| 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. | |
| 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. |
| public _spamCheck ( ) : boolean | ||
| Результат | boolean | True if a new email can be sent, false if we better keep silent. |
| public _updateBoostFiles ( ) |
| public callbackArticleChangesFinished ( $hookName, $params ) |
| public callbackArticleDaoAdditionalFieldNames ( $hookName, $args ) |
| public callbackArticleMetadataChanged ( $hookName, $params ) |
| public callbackGetResultSetOrderingOptions ( $hookName, $params ) |
| public callbackGetSimilarityTerms ( $hookName, $params ) |
| public callbackSectionDaoAdditionalFieldNames ( $hookName, $args ) |
| public callbackSectionFormConstructor ( $hookName, $params ) |
| public callbackSectionFormExecute ( $hookName, $params ) |
| public callbackSectionFormInitData ( $hookName, $params ) |
| public callbackSectionFormReadUserVars ( $hookName, $params ) |
| public callbackSubmissionFileChanged ( $hookName, $params ) |
| public callbackSubmissionFileDeleted ( $hookName, $params ) |
| public callbackSubmissionFilesChanged ( $hookName, $params ) |
| public callbackTemplateAdditionalArticleInfo ( $hookName, $params ) |
| public callbackTemplateFilterInput ( $hookName, $params ) |
| public callbackTemplatePreResults ( $hookName, $params ) |
| public callbackTemplateSectionFormAdditionalMetadata ( $hookName, $params ) |
| public callbackTemplateSyntaxInstructions ( $hookName, $params ) |
| 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. | |
| public getMailTemplate ( $emailKey, $journal = null ) | ||
| $emailKey | string | |
| $journal | Journal | |
| public getSolrWebService ( ) : SolrWebService | ||
| Результат | SolrWebService | |
| public setMailTemplate ( $emailKey, &$mailTemplate ) | ||
| $emailKey | string | |
| $mailTemplate | MailTemplate | |
| public string $_spellingSuggestionField | ||
| Результат | string | |