SphinxClient::buildExcerpts

Contents

(PECL sphinx >= 0.1.0)

SphinxClient::buildExcerpts — Build text snippets

Description

public SphinxClient::buildExcerpts ( array $docs , string $index , string $words [, array $opts ] ) : array

Connects to searchd, requests it to generate excerpts (snippets) from the given documents, and returns the results.

PHP: SphinxClient::buildExcerpts - Manual Home of Manuel PHP Contents Haut

Parameters

docs: Array of strings with documents' contents.
index: Index name.
words: Keywords to highlight.
opts: Associative array of additional highlighting options (see below).

**Highlighting options**
Option	Description
"before_match"	A string to insert before a keyword match. Default is "<b>".
"after_match"	A string to insert after a keyword match. Default is "</b>".
"chunk_separator"	A string to insert between snippet chunks (passages). Default is " ... ".
"limit"	Maximum snippet size, in symbols (codepoints). Integer, default is 256.
"around"	How much words to pick around each matching keywords block. Integer, default is 5.
"exact_phrase"	Whether to highlight exact query phrase matches only instead of individual keywords. Boolean, default is `FALSE`.
"single_passage"	Whether to extract single best passage only. Boolean, default is `FALSE`.

PHP: SphinxClient::buildExcerpts - Manual Home of Manuel PHP Contents Haut

Return Values

Returns array of snippets on success or FALSE on failure.

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-sphinxclient.buildexcerpts.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut