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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.swishsearch-setstructure" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SwishSearch->setStructure</refname>
<refpurpose>Set the structure flag in the search object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SwishSearch->setStructure</methodname>
<methodparam><type>int</type><parameter>structure</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>structure</parameter></term>
<listitem>
<para>
The structure flag a bitmask is used to limit search to certain parts of HTML
documents (like title, meta, body etc.). Its possible values are listed below.
To combine several values use bitwise OR operator, see example below.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<itemizedlist>
<listitem>
<para>
<constant>Swish::IN_FILE</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Swish::IN_TITLE</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Swish::IN_HEAD</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Swish::IN_BODY</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Swish::IN_COMMENTS</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Swish::IN_HEADER</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Swish::IN_EMPHASIZED</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Swish::IN_META</constant>
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Basic <function>SwishSearch->setStructure</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
try {
$swish = new Swish("index.swish-e");
$search = $swish->prepare();
$results = $search->execute("time");
echo "First query found: ", $results->hits, " hits\n";
$search->setStructure(Swish::IN_TITLE|Swish::IN_HEAD); //search in title and head
$results = $search->execute("time");
echo "Second query found: ", $results->hits, " hits\n";
$search->setStructure(Swish::IN_ALL); //search in whole document, the default value
$results = $search->execute("time");
echo "Third query found: ", $results->hits, " hits\n";
} catch (SwishException $e) {
echo $e->getMessage(), "\n";
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
First query found: 5 hits
Second query found: 0 hits
Third query found: 5 hits
]]>
</screen>
</example>
</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
-->
|
