search.module
Version 1.176.2.5 (checked in on 2006/08/05 at 14:36:41 by killes)
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 | Output a search form for the search block and the theme's search box. |
| search_box_form_submit | Process a block search form submission. |
| 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_form_submit | Process a search form submission. |
| search_form_validate | As the search form collates keys from other modules hooked in via hook_form_alter, the validation takes place in _submit. search_form_validate() is used solely to set the 'processed_keys' form value for the basic search form. |
| 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_menu | Implementation of hook_menu(). |
| search_parse_query | Parse a search query into SQL conditions. |
| search_perm | Implementation of hook_perm(). |
| search_preprocess | Invokes hook_search_preprocess() in modules. |
| 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_settings | Menu callback; displays the search module settings page. |
| search_settings_form_validate | Implementation of hook_validate(). |
| search_simplify | Simplifies a string according to indexing rules. |
| 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_view | Menu callback; presents the search form and/or search results. |
| search_wipe | Wipes a part of or the entire search index. |
| search_wipe_confirm | Menu callback: confirm wiping of the index. |
| search_wipe_confirm_submit | Handler for wipe confirmation |
| theme_search_block_form | Theme the block search form. |
| theme_search_item | Format a single result entry of a search query. This function is normally called by theme_search_page() or hook_search_page(). |
| theme_search_page | Format the result page of a search query. |
| theme_search_theme_form | Theme the theme search form. |
| _search_excerpt_replace | Helper function for array_walk in search_except. |
| _search_index_truncate | Helper function for array_walk in search_index_split. |
| _search_parse_query | Helper function for search_parse_query(); |