1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 290987 $ -->
<refentry xml:id="sphinxclient.buildexcerpts" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SphinxClient::buildExcerpts</refname>
<refpurpose>Build text snippets</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>SphinxClient::buildExcerpts</methodname>
<methodparam><type>array</type><parameter>docs</parameter></methodparam>
<methodparam><type>string</type><parameter>index</parameter></methodparam>
<methodparam><type>string</type><parameter>words</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>opts</parameter></methodparam>
</methodsynopsis>
<para>
Connects to searchd, requests it to generate excerpts (snippets) from the
given documents, and returns the results.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>docs</parameter></term>
<listitem>
<para>
Array of strings with documents' contents.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
Index name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>words</parameter></term>
<listitem>
<para>
Keywords to highlight.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>opts</parameter></term>
<listitem>
<para>
Associative array of additional highlighting options (see below).
</para>
</listitem>
</varlistentry>
</variablelist>
<table>
<title>Highlighting options</title>
<tgroup cols="2">
<thead>
<row>
<entry>Option</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>"before_match"</entry>
<entry>A string to insert before a keyword match. Default is "<b>".</entry>
</row>
<row>
<entry>"after_match"</entry>
<entry>A string to insert after a keyword match. Default is "</b>".</entry>
</row>
<row>
<entry>"chunk_separator"</entry>
<entry>A string to insert between snippet chunks (passages). Default is " ... ".</entry>
</row>
<row>
<entry>"limit"</entry>
<entry>Maximum snippet size, in symbols (codepoints). Integer, default is 256.</entry>
</row>
<row>
<entry>"around"</entry>
<entry>How much words to pick around each matching keywords block. Integer, default is 5.</entry>
</row>
<row>
<entry>"exact_phrase"</entry>
<entry>Whether to highlight exact query phrase matches only instead of
individual keywords. Boolean, default is &false;.</entry>
</row>
<row>
<entry>"single_passage"</entry>
<entry>Whether to extract single best passage only. Boolean, default is &false;.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns array of snippets on success&return.falseforfailure;.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
