Contributions API

search.module

Version

1.250.2.4 (checked in on 2008/09/17 at 06:42:20 by goba)

Description

Enables site-wide keyword searching.

Constants

Name	Description
PREG_CLASS_CJK	Matches all CJK characters that are candidates for auto-splitting (Chinese, Japanese, Korean). Contains kana and BMP ideographs.
PREG_CLASS_NUMBERS	Matches all 'N' Unicode character classes (numbers)
PREG_CLASS_PUNCTUATION	Matches all 'P' Unicode character classes (punctuation)
PREG_CLASS_SEARCH_EXCLUDE	Matches Unicode character classes to exclude from the search index.

Functions

Name	Description
do_search	Do a query on the full-text search index for a word or words.
search_block	Implementation of hook_block().
search_box	Form builder; Output a search form for the search block and the theme's search box. See alsosearch_box_form_submit()
search_box_form_submit	Process a block search form submission.
search_comment	Implementation of hook_comment().
search_cron	Implementation of hook_cron().
search_data	Perform a standard search on the given keys, and return the formatted results.
search_dirty	Marks a word as dirty (or retrieves the list of dirty words). This is used during indexing (cron). Words which are dirty have outdated total counts in the search_total table, and need to be recounted.
search_excerpt	Returns snippets from a piece of text, with certain keywords highlighted. Used for formatting search results.
search_expand_cjk	Basic CJK tokenizer. Simply splits a string into consecutive, overlapping sequences of characters ('minimum_word_size' long).
search_form	Render a search form.
search_forms
search_get_keys	Helper function for grabbing search keys.
search_help	Implementation of hook_help().
search_index	Update the full-text search index for a particular item.
search_index_split	Splits a string into tokens for indexing.
search_invoke_preprocess	Invokes hook_search_preprocess() in modules.
search_menu	Implementation of hook_menu().
search_nodeapi	Implementation of hook_nodeapi().
search_parse_query	Parse a search query into SQL conditions.
search_perm	Implementation of hook_perm().
search_query_extract	Extract a module-specific search option from a search query. e.g. 'type:book'
search_query_insert	Return a query with the given module-specific search option inserted in. e.g. 'type:book'.
search_simplify	Simplifies a string according to indexing rules.
search_theme	Implementation of hook_theme()
search_touch_node	Change a node's changed timestamp to 'now' to force reindexing.
search_update_totals	This function is called on shutdown to ensure that search_total is always up to date (even if cron times out or otherwise fails).
search_wipe	Wipes a part of or the entire search index.
template_preprocess_search_block_form	Process variables for search-block-form.tpl.php.
template_preprocess_search_theme_form	Process variables for search-theme-form.tpl.php.
_search_excerpt_replace	Helper function for array_walk in search_except.
_search_index_truncate	Helper function for array_walk in search_index_split.
_search_menu
_search_parse_query	Helper function for search_parse_query();