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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<section xml:id="swish.classes" xmlns="http://docbook.org/ns/docbook">
&reftitle.classes;
<section>
&reftitle.classes;
<section xml:id="swish.class.swish">
<title><classname>Swish</classname></title>
<para>
</para>
<section xml:id="swish.class.swish.properties">
&reftitle.properties;
<itemizedlist>
<listitem>
<para>
<property>indexes</property> - the array of indexes used and their properties. Certain
list of properties depends on Swish-e version.
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="swish.class.swish.methods">
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<xref linkend="function.swish-construct" /> - constructs new
<classname>Swish</classname> object.
Throws <classname>SwishException</classname> on error.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swish-prepare" /> - prepares and returns
<classname>SwishSearch</classname> object.
Throws <classname>SwishException</classname> on error.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swish-query" /> - executes the query and
returns <classname>SwishResults</classname> object.
Throws <classname>SwishException</classname> on error.
</para>
</listitem>
<listitem>
<para><xref linkend="function.swish-getmetalist" /> - returns an array
of meta entries for the given index file.</para>
</listitem>
<listitem>
<para><xref linkend="function.swish-getpropertylist" /> - returns an array
of properties for the given index file.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id="swish.class.swishsearch">
<title><classname>SwishSearch</classname></title>
<para>
</para>
<section xml:id="swish.class.swishsearch.methods">
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<xref linkend="function.swishsearch-setstructure" /> - sets the
structure flag in the search object. This flag is used to limit search
to certain parts of HTML documents.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishsearch-setphrasedelimiter" /> - sets
the phrase delimiter character. The default delimiter is double-quotes.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishsearch-setsort" /> - sets the sort
order of the results.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishsearch-setlimit" /> - sets the limits
for the search.
Throws <classname>SwishException</classname> on error.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishsearch-resetlimit" /> - resets the
limits.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishsearch-execute" /> - executes the
query and returns <classname>SwishResults</classname> object.
Throws <classname>SwishException</classname> on error.
</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id="swish.class.swishresults">
<title><classname>SwishResults</classname></title>
<para>
</para>
<section xml:id="swish.class.swishresults.properties">
&reftitle.properties;
<itemizedlist>
<listitem>
<para>
<property>hits</property> - the number of results in this
<classname>SwishResults</classname> object.
</para>
</listitem>
<listitem>
<para>
<property>indexes</property> - the array of indexes used in the search.
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="swish.class.swishresults.methods">
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<xref linkend="function.swishresults-nextresult" /> - returns
next <classname>SwishResult</classname> object or &false; if no
more results are available.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishresults-seekresult" /> - sets the
current seek position in the <classname>SwishResults</classname>
object.
Throws <classname>SwishException</classname> on error.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishresults-getparsedwords" /> -
returns an array of words in the query with stopwords removed.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishresults-getremovedstopwords" /> -
returns an array of removed stopwords.
</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id="swish.class.swishresult">
<title><classname>SwishResult</classname></title>
<para>
</para>
<section xml:id="swish.class.swishresult.properties">
&reftitle.properties;
<itemizedlist>
<listitem>
<para>Properties list depends on Swish-e version, see examples.</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="swish.class.swishresult.methods">
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<xref linkend="function.swishresult-getmetalist" /> - returns
an array of meta entries for the index used in this result.
</para>
</listitem>
<listitem>
<para>
<xref linkend="function.swishresult-stem" /> - stems the word
and returns result as an array of strings.
Throws <classname>SwishException</classname> on error.
</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id="swish.class.swishexception">
<title><classname>SwishException</classname></title>
<para>
<classname>SwishException</classname> extends the built in
<classname>Exception</classname> class and possesses the same set of
properties and methods. See <xref
linkend="language.exceptions.extending"/> for more details.
</para>
</section>
</section>
</section>
<!-- 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
-->
|
