php-doc-en/reference/swish/reference.xml
2007-12-10 17:06:11 +00:00

124 lines
3.1 KiB
XML

<?xml version = '1.0' encoding = 'iso-8859-1'?>
<!-- $Revision: 1.9 $ -->
<!-- Purpose: utilspec.nontext -->
<!-- Membership: pecl, external -->
<!-- State: experimental -->
<reference xml:id="ref.swish" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Swish Functions</title>
<titleabbrev>swish</titleabbrev>
<partintro>
<section xml:id="swish.intro" >
&reftitle.intro;
<para>
The swish extension provides the bindings for Swish-e API.
Swish-e stands for "Simple Web Indexing System for Humans - Enhanced" and
is an open source system for indexing and search.
Swish-e itself is licensed under GPL license, but uses a clause that
allows applications to link against the library if every copy of the
combined work is accompanied by the URL to Swish-e source code. Here it
is: <link xlink:href="http://swish-e.org">http://swish-e.org</link>.
</para>
&warn.experimental;
</section>
<section xml:id="swish.requirements" >
&reftitle.required;
<para>
PECL/swish requires PHP 5.1.3 or newer.
</para>
</section>
<section xml:id="swish.install" >
&reftitle.install;
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;swish">&url.pecl.package;swish</link>.
</para>
<para>
The latest PECL/swish Win32 DLL can be downloaded here:
<link xlink:href='&url.pecl.win.ext;php_swish.dll'>php_swish.dll</link>.
</para>
</section>
<section xml:id="swish.configuration">
&reftitle.runtime;
&no.config;
</section>
<section xml:id="swish.examples">
&reftitle.examples;
<para>
<example>
<title>Basic search query</title>
<programlisting role="php">
<![CDATA[
<?php
try {
$swish = new Swish("index.swish-e");
$results = $swish->query("test OR text");
echo "Found ", $results->hits, " results\n";
while ($result = $results->nextResult()) {
var_dump($result);
break; //break after the first result
}
} catch (SwishException $e) {
echo "Error: ", $e->getMessage(), "\n";
}
?>
]]>
</programlisting>
</example>
</para>
&example.outputs.similar;
<screen>
<![CDATA[
Found 9 results
object(SwishResult)#3 (8) {
["swishreccount"]=>
int(1)
["swishrank"]=>
int(1000)
["swishfilenum"]=>
int(10)
["swishdbfile"]=>
string(13) "index.swish-e"
["swishdocpath"]=>
string(23) "README.SUBMITTING_PATCH"
["swishtitle"]=>
NULL
["swishdocsize"]=>
int(4557)
["swishlastmodified"]=>
int(1072136752)
}
]]>
</screen>
</section>
&reference.swish.constants;
&reference.swish.classes;
</partintro>
&reference.swish.entities.functions;
</reference>
<!-- 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:"../../../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
-->