• Главная
• SolrWebService

PHP Класс SolrWebService, ojs

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$_fieldCache		A cache containing the available search fields.
$_instId		The unique ID identifying this OJS installation to the solr server.
$_issueCache		An issue cache.
$_journalCache		A journal cache.
$_serviceMessage		A description of the last error or message that occurred when calling the service.
$_solrCore		The solr core we get our data from.
$_solrSearchHandler		The solr search handler name we place our searches on.
$_solrServer		The base URL of the solr server without core and search handler.
$_useProxySettings		Whether the proxy settings in the config.inc.php should be considered for the web service request.

Открытые методы

Метод	Описание
__construct ( $searchHandler, $username, $password, $instId, $useProxy = false )	Constructor
_addArticleXml ( &$articleDoc, &$article, &$journal, $markToDelete = false )	Add the metadata XML of a single article to an XML article list.
_addSubquery ( $fieldList, $searchPhrase, $params )	Add a subquery to the search query.
_cacheMiss ( $cache, $id ) : array	Refresh the cache from the solr server.
_convertDate ( $timestamp ) : string	Convert a date from local time (unix timestamp or ISO date string) to UTC time as understood by solr.
_deleteFromIndex ( $xml ) : boolean	Delete documents from the index (by ID or by query).
_expandFieldList ( $fields ) : string	Expand the given list of fields.
_getAdminUrl ( ) : string	Identifies the general solr admin endpoint from the search handler URL.
_getArticleListXml ( &$articles, $totalCount, &$numDeleted ) : string	Retrieve the XML for a batch of articles to be updated.
_getAutosuggestUrl ( $autosuggestType ) : string	Returns the solr auto-suggestion endpoint.
_getCache ( ) : FileCache	Get the field cache.
_getCoreAdminUrl ( ) : string	Identifies the solr core-specific admin endpoint from the search handler URL.
_getDihUrl ( ) : string	Returns the solr DIH endpoint.
_getDocumentsProcessed ( $result ) : integer	Retrieve the number of indexed documents from a DIH response XML
_getFacetingAutosuggestions ( $url, $searchRequest, $userInput, $fieldName ) : array	Retrieve auto-suggestions from the faceting service.
_getFieldNames ( $fieldType ) : array	Return a list of all text fields that may occur in the index.
_getInterestingTermsUrl ( ) : string	Returns the solr endpoint to retrieve "interesting terms" from a given document.
_getIssue ( $issueId, $journalId ) : Issue	Retrieve an issue (possibly from the cache).
_getJournal ( $journalId ) : Journal	Retrieve a journal (possibly from the cache).
_getLocalesAndFormats ( $field ) : array	Identify all format/locale versions of the given field.
_getOrdering ( $field, $direction ) : string	Generate the ordering parameter of a search query.
_getReloadExternalFilesUrl ( )	Returns the solr endpoint to reload external files.
_getSearchQueryParameters ( &$searchRequest ) : array | null	Create the edismax query parameters from a search request.
_getSearchUrl ( ) : string	Returns the solr search endpoint.
_getSuggesterAutosuggestions ( $url, $userInput, $fieldName ) : array	Retrieve auto-suggestions from the suggester service.
_getUpdateUrl ( ) : string	Returns the solr update endpoint.
_indexingTransaction ( $sendXmlCallback, $batchSize = SOLR_INDEXING_MAX_BATCHSIZE, $journalId = null )	This method encapsulates an indexing transaction (pull or push).
_isArticleAccessAuthorized ( &$article ) : boolean	Check whether access to the given article is authorized to the requesting party (i.e. the Solr server).
_makeRequest ( $url, $params = [], $method = 'GET' ) : DOMXPath	Make a request
_pushIndexingCallback ( &$articleXml, $batchCount, $numDeleted ) : integer	Handle push indexing.
_setQuery ( $fieldList, $searchPhrase, $spellcheck = false )	Set the query parameters for a search query.
_translateSearchPhrase ( $searchPhrase, $backwards = false ) : The	Translate query keywords.
deleteArticleFromIndex ( $articleId ) : boolean	Deletes the given article from the Solr index.
deleteArticlesFromIndex ( $journalId = null ) : boolean	Deletes all articles of a journal or of the installation from the Solr index.
flushFieldCache ( )	Flush the field cache.
getArticleFromIndex ( $articleId ) : array	Retrieve a document directly from the index (for testing/debugging purposes only).
getAutosuggestions ( $searchRequest, $fieldName, $userInput, $autosuggestType ) : array	Retrieve auto-suggestions from the solr index corresponding to the given user input.
getAvailableFields ( $fieldType ) : array	Returns an array with all (dynamic) fields in the index.
getInterestingTerms ( $articleId ) : array	Retrieve "interesting terms" from a document to be used in a "similar documents" search.
getServerStatus ( ) : integer	Checks the solr server status.
getServiceMessage ( ) : string	Get the last service message.
markArticleChanged ( $articleId )	Mark a single article "changed" so that the indexing back-end will update it during the next batch update.
markJournalChanged ( $journalId ) : integer	Mark the given journal for re-indexing.
pullChangedArticles ( $pullIndexingCallback, $batchSize = SOLR_INDEXING_MAX_BATCHSIZE, $journalId = null ) : integer	Retrieves a batch of articles in XML format.
pushChangedArticles ( $batchSize = SOLR_INDEXING_MAX_BATCHSIZE, $journalId = null ) : integer	(Re-)indexes all changed articles in Solr.
rebuildDictionaries ( )	Rebuilds the spelling/auto-suggest dictionaries.
reloadExternalFiles ( )	Reloads external files.
retrieveResults ( &$searchRequest, &$totalResults ) : array	Execute a search against the Solr search server.

Описание методов

Описание свойств