From 3d614fbc5da30185c88ba4144982b87cd0723983 Mon Sep 17 00:00:00 2001
From: Alexey Romanenko <santiago@php.net>
Date: Tue, 19 Jan 2010 14:01:10 +0000
Subject: [PATCH] added docs for new methods

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@293733 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/sphinx/sphinxclient/close.xml       |  88 ++++++++++++++
 reference/sphinx/sphinxclient/open.xml        |  88 ++++++++++++++
 reference/sphinx/sphinxclient/setoverride.xml | 112 ++++++++++++++++++
 reference/sphinx/sphinxclient/status.xml      |  80 +++++++++++++
 reference/sphinx/versions.xml                 |   7 +-
 5 files changed, 374 insertions(+), 1 deletion(-)
 create mode 100644 reference/sphinx/sphinxclient/close.xml
 create mode 100644 reference/sphinx/sphinxclient/open.xml
 create mode 100644 reference/sphinx/sphinxclient/setoverride.xml
 create mode 100644 reference/sphinx/sphinxclient/status.xml

diff --git a/reference/sphinx/sphinxclient/close.xml b/reference/sphinx/sphinxclient/close.xml
new file mode 100644
index 0000000000..23693d68e2
--- /dev/null
+++ b/reference/sphinx/sphinxclient/close.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291655 $ -->
+
+<refentry xml:id="sphinxclient.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SphinxClient::close</refname>
+  <refpurpose>Closes previously opened persistent connection</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>SphinxClient::close</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Closes previously opened persistent connection.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+ 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>PECL/sphinx &Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>1.0.3</entry>
+       <entry>
+        Added SphinxClient::close(), available only if compiled with
+        libsphinxclient >= 0.9.9.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><xref linkend="sphinxclient.open" /></member>
+   </simplelist>
+  </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
+-->
diff --git a/reference/sphinx/sphinxclient/open.xml b/reference/sphinx/sphinxclient/open.xml
new file mode 100644
index 0000000000..d57b4a1f32
--- /dev/null
+++ b/reference/sphinx/sphinxclient/open.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291655 $ -->
+
+<refentry xml:id="sphinxclient.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SphinxClient::open</refname>
+  <refpurpose>Opens persistent connection to the server</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>SphinxClient::open</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Opens persistent connection to the server.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+ 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>PECL/sphinx &Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>1.0.3</entry>
+       <entry>
+        Added SphinxClient::open(), available only if compiled with
+        libsphinxclient >= 0.9.9.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><xref linkend="sphinxclient.close" /></member>
+   </simplelist>
+  </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
+-->
diff --git a/reference/sphinx/sphinxclient/setoverride.xml b/reference/sphinx/sphinxclient/setoverride.xml
new file mode 100644
index 0000000000..8784d8f7d6
--- /dev/null
+++ b/reference/sphinx/sphinxclient/setoverride.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291655 $ -->
+
+<refentry xml:id="sphinxclient.setoverride" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SphinxClient::setOverride</refname>
+  <refpurpose>Sets temporary per-document attribute value
+   overrides</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>SphinxClient::setOverride</methodname>
+   <methodparam><type>string</type><parameter>attribute</parameter></methodparam>
+   <methodparam><type>int</type><parameter>type</parameter></methodparam>
+   <methodparam><type>array</type><parameter>values</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Sets temporary (per-query) per-document attribute value overrides. Override
+   feature lets you "temporary" update attribute values for some documents
+   within a single query, leaving all other queries unaffected. This might be
+   useful for personalized data </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>attribute</parameter></term>
+     <listitem>
+      <para>
+       An attribute name.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>type</parameter></term>
+     <listitem>
+      <para>
+       An attribute type. Only supports scalar attributes.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>values</parameter></term>
+     <listitem>
+      <para>
+       Array of attribute values that maps document IDs to overridden
+       attribute values.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>PECL/sphinx &Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>1.0.3</entry>
+       <entry>
+        Added SphinxClient::setOverride(), available only if compiled with
+        libsphinxclient >= 0.9.9.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </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
+-->
diff --git a/reference/sphinx/sphinxclient/status.xml b/reference/sphinx/sphinxclient/status.xml
new file mode 100644
index 0000000000..79ec85d0ff
--- /dev/null
+++ b/reference/sphinx/sphinxclient/status.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291655 $ -->
+
+<refentry xml:id="sphinxclient.status" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SphinxClient::status</refname>
+  <refpurpose>Queries searchd status</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>array</type><methodname>SphinxClient::status</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Queries searchd status, and returns an array of status variable name and
+   value pairs.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+ 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>PECL/sphinx &Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>1.0.3</entry>
+       <entry>
+        Added SphinxClient::status(), available only if compiled with
+        libsphinxclient >= 0.9.9.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an associative array of search server statistics&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
+-->
diff --git a/reference/sphinx/versions.xml b/reference/sphinx/versions.xml
index 4f3e088f5d..92c50bbd8f 100644
--- a/reference/sphinx/versions.xml
+++ b/reference/sphinx/versions.xml
@@ -35,6 +35,11 @@
  <function name='SphinxClient::setServer' from='PECL sphinx &gt;= 0.1.0'/>
  <function name='SphinxClient::setSortMode' from='PECL sphinx &gt;= 0.1.0'/>
  <function name='SphinxClient::updateAttributes' from='PECL sphinx &gt;= 0.1.0'/>
+ <function name='SphinxClient::setSelect' from='PECL sphinx &gt;= 1.0.1'/>
+ <function name='SphinxClient::setOverride' from='PECL sphinx &gt;= 1.0.3'/>
+ <function name='SphinxClient::open' from='PECL sphinx &gt;= 1.0.3'/>
+ <function name='SphinxClient::close' from='PECL sphinx &gt;= 1.0.3'/>
+ <function name='SphinxClient::status' from='PECL sphinx &gt;= 1.0.3'/>
 </versions>
 
 <!-- Keep this comment at the end of the file
@@ -56,4 +61,4 @@ End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
--->
\ No newline at end of file
+-->