From 3d614fbc5da30185c88ba4144982b87cd0723983 Mon Sep 17 00:00:00 2001 From: Alexey Romanenko 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 @@ + + + + + + SphinxClient::close + Closes previously opened persistent connection + + + + &reftitle.description; + + public boolSphinxClient::close + + + + Closes previously opened persistent connection. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.changelog; + + + + + + PECL/sphinx &Version; + &Description; + + + + + 1.0.3 + + Added SphinxClient::close(), available only if compiled with + libsphinxclient >= 0.9.9. + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + + + + + + + + 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 @@ + + + + + + SphinxClient::open + Opens persistent connection to the server + + + + &reftitle.description; + + public boolSphinxClient::open + + + + Opens persistent connection to the server. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.changelog; + + + + + + PECL/sphinx &Version; + &Description; + + + + + 1.0.3 + + Added SphinxClient::open(), available only if compiled with + libsphinxclient >= 0.9.9. + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + + + + + + + + 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 @@ + + + + + + SphinxClient::setOverride + Sets temporary per-document attribute value + overrides + + + + &reftitle.description; + + public boolSphinxClient::setOverride + stringattribute + inttype + arrayvalues + + + 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 + + + + &reftitle.parameters; + + + + attribute + + + An attribute name. + + + + + type + + + An attribute type. Only supports scalar attributes. + + + + + values + + + Array of attribute values that maps document IDs to overridden + attribute values. + + + + + + + + + &reftitle.changelog; + + + + + + PECL/sphinx &Version; + &Description; + + + + + 1.0.3 + + Added SphinxClient::setOverride(), available only if compiled with + libsphinxclient >= 0.9.9. + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + + 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 @@ + + + + + + SphinxClient::status + Queries searchd status + + + + &reftitle.description; + + public arraySphinxClient::status + + + + Queries searchd status, and returns an array of status variable name and + value pairs. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.changelog; + + + + + + PECL/sphinx &Version; + &Description; + + + + + 1.0.3 + + Added SphinxClient::status(), available only if compiled with + libsphinxclient >= 0.9.9. + + + + + + + + + + &reftitle.returnvalues; + + Returns an associative array of search server statistics&return.falseforfailure;. + + + + + + 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 @@ + + + + + \ No newline at end of file +-->