# mnoGoSearch Functions

## Introduction

These functions allow you to access the mnoGoSearch (former UdmSearch) free search engine. mnoGoSearch is a full-featured search engine software for intranet and internet servers, distributed under the GNU license. mnoGoSearch has a number of unique features, which makes it appropriate for a wide range of applications from search within your site to a specialized search system such as cooking recipes or newspaper search, FTP archive search, news articles search, etc. It offers full-text indexing and searching for HTML, PDF, and text documents. mnoGoSearch consists of two parts. The first is an indexing mechanism (indexer). The purpose of the indexer is to walk through HTTP, FTP, NEWS servers or local files, recursively grabbing all the documents and storing meta-data about that documents in a SQL database in a smart and effective manner. After every document is referenced by its corresponding URL, meta-data is collected by the indexer for later use in a search process. The search is performed via Web interface. C, CGI, PHP and Perl search front ends are included.

More information about mnoGoSearch can be found at » http://www.mnogosearch.org/.

> Note: This extension has been moved to the » PECL repository and is no longer bundled with PHP as of PHP 5.1.0.

> Note: This extension is not available on Windows platforms.

## Requirements

Download mnoGosearch from » http://www.mnogosearch.org/ and install it on your system. You need at least version 3.1.10 of mnoGoSearch installed to use these functions.

## Installation

In order to have these functions available, you must compile PHP with mnoGosearch support by using the --with-mnogosearch option. If you use this option without specifying the path to mnoGosearch, PHP will look for mnoGosearch under /usr/local/mnogosearch path by default. If you installed mnoGosearch at a different location you should specify it: --with-mnogosearch=DIR.

Information for installing this PECL extension may be found in the manual chapter titled Installation of PECL extensions. Additional information such as new releases, downloads, source files, maintainer information, and a CHANGELOG, can be located here: » http://pecl.php.net/package/mnogosearch.

> Note: PHP contains built-in MySQL access library, which can be used to access MySQL. It is known that mnoGoSearch is not compatible with this built-in library and can work only with generic MySQL libraries. Thus, if you use mnoGoSearch with MySQL, during PHP configuration you have to indicate the directory of your MySQL installation, that was used during mnoGoSearch configuration, i.e. for example: --with-mnogosearch --with-mysql=/usr.

## Runtime Configuration

This extension has no configuration directives defined in php.ini.

## Resource Types

## Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

`UDM_FIELD_URLID` (integer)
`UDM_FIELD_URL` (integer)
`UDM_FIELD_CONTENT` (integer)
`UDM_FIELD_TITLE` (integer)
`UDM_FIELD_KEYWORDS` (integer)
`UDM_FIELD_DESC` (integer)
`UDM_FIELD_DESCRIPTION` (integer)
`UDM_FIELD_TEXT` (integer)
`UDM_FIELD_SIZE` (integer)
`UDM_FIELD_RATING` (integer)
`UDM_FIELD_SCORE` (integer)
`UDM_FIELD_MODIFIED` (integer)
`UDM_FIELD_ORDER` (integer)
`UDM_FIELD_CRC` (integer)
`UDM_FIELD_CATEGORY` (integer)
`UDM_FIELD_LANG` (integer)
`UDM_FIELD_CHARSET` (integer)
`UDM_PARAM_PAGE_SIZE` (integer)
`UDM_PARAM_PAGE_NUM` (integer)
`UDM_PARAM_SEARCH_MODE` (integer)
`UDM_PARAM_CACHE_MODE` (integer)
`UDM_PARAM_TRACK_MODE` (integer)
`UDM_PARAM_PHRASE_MODE` (integer)
`UDM_PARAM_CHARSET` (integer)
`UDM_PARAM_LOCAL_CHARSET` (integer)
`UDM_PARAM_BROWSER_CHARSET` (integer)
`UDM_PARAM_STOPTABLE` (integer)
`UDM_PARAM_STOP_TABLE` (integer)
`UDM_PARAM_STOPFILE` (integer)
`UDM_PARAM_STOP_FILE` (integer)
`UDM_PARAM_WEIGHT_FACTOR` (integer)
`UDM_PARAM_WORD_MATCH` (integer)
`UDM_PARAM_MAX_WORD_LEN` (integer)
`UDM_PARAM_MAX_WORDLEN` (integer)
`UDM_PARAM_MIN_WORD_LEN` (integer)
`UDM_PARAM_MIN_WORDLEN` (integer)
`UDM_PARAM_ISPELL_PREFIXES` (integer)
`UDM_PARAM_ISPELL_PREFIX` (integer)
`UDM_PARAM_PREFIXES` (integer)
`UDM_PARAM_PREFIX` (integer)
`UDM_PARAM_CROSS_WORDS` (integer)
`UDM_PARAM_CROSSWORDS` (integer)
`UDM_PARAM_VARDIR` (integer)
`UDM_PARAM_DATADIR` (integer)
`UDM_PARAM_HLBEG` (integer)
`UDM_PARAM_HLEND` (integer)
`UDM_PARAM_SYNONYM` (integer)
`UDM_PARAM_SEARCHD` (integer)
`UDM_PARAM_QSTRING` (integer)
`UDM_PARAM_REMOTE_ADDR` (integer)
`UDM_LIMIT_CAT` (integer)
`UDM_LIMIT_URL` (integer)
`UDM_LIMIT_TAG` (integer)
`UDM_LIMIT_LANG` (integer)
`UDM_LIMIT_DATE` (integer)
`UDM_PARAM_FOUND` (integer)
`UDM_PARAM_NUM_ROWS` (integer)
`UDM_PARAM_WORDINFO` (integer)
`UDM_PARAM_WORD_INFO` (integer)
`UDM_PARAM_SEARCHTIME` (integer)
`UDM_PARAM_SEARCH_TIME` (integer)
`UDM_PARAM_FIRST_DOC` (integer)
`UDM_PARAM_LAST_DOC` (integer)
`UDM_MODE_ALL` (integer)
`UDM_MODE_ANY` (integer)
`UDM_MODE_BOOL` (integer)
`UDM_MODE_PHRASE` (integer)
`UDM_CACHE_ENABLED` (integer)
`UDM_CACHE_DISABLED` (integer)
`UDM_TRACK_ENABLED` (integer)
`UDM_TRACK_DISABLED` (integer)
`UDM_PHRASE_ENABLED` (integer)
`UDM_PHRASE_DISABLED` (integer)
`UDM_CROSS_WORDS_ENABLED` (integer)
`UDM_CROSSWORDS_ENABLED` (integer)
`UDM_CROSS_WORDS_DISABLED` (integer)
`UDM_CROSSWORDS_DISABLED` (integer)
`UDM_PREFIXES_ENABLED` (integer)
`UDM_PREFIX_ENABLED` (integer)
`UDM_ISPELL_PREFIXES_ENABLED` (integer)
`UDM_ISPELL_PREFIX_ENABLED` (integer)
`UDM_PREFIXES_DISABLED` (integer)
`UDM_PREFIX_DISABLED` (integer)
`UDM_ISPELL_PREFIXES_DISABLED` (integer)
`UDM_ISPELL_PREFIX_DISABLED` (integer)
`UDM_ISPELL_TYPE_AFFIX` (integer)
`UDM_ISPELL_TYPE_SPELL` (integer)
`UDM_ISPELL_TYPE_DB` (integer)
`UDM_ISPELL_TYPE_SERVER` (integer)
`UDM_MATCH_WORD` (integer)
`UDM_MATCH_BEGIN` (integer)
`UDM_MATCH_SUBSTR` (integer)
`UDM_MATCH_END` (integer)

## Table of Contents

- udm_add_search_limit — Add various search limits
- udm_alloc_agent_array — Allocate mnoGoSearch session
- udm_alloc_agent — Allocate mnoGoSearch session
- udm_api_version — Get mnoGoSearch API version
- udm_cat_list — Get all the categories on the same level with the current one
- udm_cat_path — Get the path to the current category
- udm_check_charset — Check if the given charset is known to mnogosearch
- udm_check_stored — Check connection to stored
- udm_clear_search_limits — Clear all mnoGoSearch search restrictions
- udm_close_stored — Close connection to stored
- udm_crc32 — Return CRC32 checksum of given string
- udm_errno — Get mnoGoSearch error number
- udm_error — Get mnoGoSearch error message
- udm_find — Perform search
- udm_free_agent — Free mnoGoSearch session
- udm_free_ispell_data — Free memory allocated for ispell data
- udm_free_res — Free mnoGoSearch result
- udm_get_doc_count — Get total number of documents in database
- udm_get_res_field — Fetch a result field
- udm_get_res_param — Get mnoGoSearch result parameters
- udm_hash32 — Return Hash32 checksum of gived string
- udm_load_ispell_data — Load ispell data
- udm_open_stored — Open connection to stored
- udm_set_agent_param — Set mnoGoSearch agent session parameters