mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
5c20ff9960
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322142 c90b9560-bf6c-de11-be94-00142212c4b1
148 lines
3.5 KiB
XML
148 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="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
|
|
-->
|