interface SearchIndexInterface
Same name in other branches
- 9 core/modules/search/src/SearchIndexInterface.php \Drupal\search\SearchIndexInterface
- 10 core/modules/search/src/SearchIndexInterface.php \Drupal\search\SearchIndexInterface
- 11.x core/modules/search/src/SearchIndexInterface.php \Drupal\search\SearchIndexInterface
Provides search index management functions.
Hierarchy
- interface \Drupal\search\SearchIndexInterface
Expanded class hierarchy of SearchIndexInterface
All classes that implement SearchIndexInterface
Related topics
6 files declare their use of SearchIndexInterface
- HelpSearch.php in core/
modules/ help_topics/ src/ Plugin/ Search/ HelpSearch.php - NodeSearch.php in core/
modules/ node/ src/ Plugin/ Search/ NodeSearch.php - SearchMatchTest.php in core/
modules/ search/ tests/ src/ Kernel/ SearchMatchTest.php - SearchMultilingualEntityTest.php in core/
modules/ search/ tests/ src/ Functional/ SearchMultilingualEntityTest.php - SearchNodeUpdateAndDeletionTest.php in core/
modules/ search/ tests/ src/ Functional/ SearchNodeUpdateAndDeletionTest.php
File
-
core/
modules/ search/ src/ SearchIndexInterface.php, line 10
Namespace
Drupal\searchView source
interface SearchIndexInterface {
/**
* Updates the full-text search index for a particular item.
*
* @param string $type
* The plugin ID or other machine-readable type of this item,
* which should be less than 64 bytes.
* @param int $sid
* An ID number identifying this particular item (e.g., node ID).
* @param string $langcode
* Language code for the language of the text being indexed.
* @param string $text
* The content of this item. Must be a piece of HTML or plain text.
* @param bool $update_weights
* (optional) TRUE if word weights should be updated. FALSE otherwise;
* defaults to TRUE. If you pass in FALSE, then you need to have your
* calls to this method in a try/finally block, and at the end of your
* index run in the finally clause, you will need to call
* self::updateWordWeights(), passing in all of the returned words, to
* update the word weights.
*
* @return string[]
* The words to be updated.
*
* @throws \Drupal\search\Exception\SearchIndexException
* If there is an error indexing the text.
*/
public function index($type, $sid, $langcode, $text, $update_weights = TRUE);
/**
* Clears either a part of, or the entire search index.
*
* This function is meant for use by search page plugins, or for building a
* user interface that lets users clear all or parts of the search index.
*
* @param string|null $type
* (optional) The plugin ID or other machine-readable type for the items to
* remove from the search index. If omitted, $sid and $langcode are ignored
* and the entire search index is cleared.
* @param int|array|null $sid
* (optional) The ID or array of IDs of the items to remove from the search
* index. If omitted, all items matching $type are cleared, and $langcode
* is ignored.
* @param string|null $langcode
* (optional) Language code of the item to remove from the search index. If
* omitted, all items matching $sid and $type are cleared.
*
* @throws \Drupal\search\Exception\SearchIndexException
* If there is an error clearing the index.
*/
public function clear($type = NULL, $sid = NULL, $langcode = NULL);
/**
* Changes the timestamp on indexed items to 'now' to force reindexing.
*
* This function is meant for use by search page plugins, or for building a
* user interface that lets users mark all or parts of the search index for
* reindexing.
*
* @param string $type
* (optional) The plugin ID or other machine-readable type of this item. If
* omitted, the entire search index is marked for reindexing, and $sid and
* $langcode are ignored.
* @param int $sid
* (optional) An ID number identifying this particular item (e.g., node ID).
* If omitted, everything matching $type is marked, and $langcode is
* ignored.
* @param string $langcode
* (optional) The language code to mark. If omitted, everything matching
* $type and $sid is marked.
*
* @throws \Drupal\search\Exception\SearchIndexException
* If there is an error marking the index for re-indexing.
*/
public function markForReindex($type = NULL, $sid = NULL, $langcode = NULL);
/**
* Updates the {search_total} database table.
*
* @param array $words
* An array whose keys are words from self::index() whose total weights
* need to be updated.
*
* @throws \Drupal\search\Exception\SearchIndexException
* If there is an error updating the totals.
*/
public function updateWordWeights(array $words);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
SearchIndexInterface::clear | public | function | Clears either a part of, or the entire search index. | 1 |
SearchIndexInterface::index | public | function | Updates the full-text search index for a particular item. | 1 |
SearchIndexInterface::markForReindex | public | function | Changes the timestamp on indexed items to 'now' to force reindexing. | 1 |
SearchIndexInterface::updateWordWeights | public | function | Updates the {search_total} database table. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.