Class sphinxAPI

Sphinx PHP searchd client API, derived from sphinxapi.php of Andrew Aksyonoff / Sphinx Technologies Inc. (http://www.sphinxsearch.com/)

SphinxClient

Extended by

sphinxAPI

Direct known subclasses

Located at sphinxapi.lib.php

Methods summary

`public`	# `__construct( boolean $useQL = false, integer $QLdriver = 0 )` Parameters `$useQL` (sphinxQL implementation require sphinx version >= 2.0.1-beta and use only methods from sphinxAPI/sphinxQL not SphinxClient) `$QLdriver` use 0 to autodetect best MySQL driver or use SphinxQL_over_* to force
`public`	# `__destruct( )`
`public`	# `EscapeString( $string )`
`public`	# `GetLastError( )`
`public`	# `GetLastWarning( )`
`public integer`	# `getVersion( )` get the used version of the PHP Sphinx API get the used version of the PHP Sphinx API Returns integer
`public array`	# `getStatistics( )` return a array with statistics about request timings return a array with statistics about request timings Returns array
`public`	# `SetServer( mixed $host, mixed $port = null )` set the server ip/port (if you set more than one server, loadbalancing is active, to deactivate set only one server) !!! use small values for the connection timeout if loadbalacing is active !!! set the server ip/port (if you set more than one server, loadbalancing is active, to deactivate set only one server) !!! use small values for the connection timeout if loadbalacing is active !!! Parameters `$host` as string `$port` as int
`public`	# `SetLimits( integer $offset, integer $limit = 1000, integer $max = 0, integer $cutoff = 0 )` set the offset/limit/cutoff for a search set the offset/limit/cutoff for a search Parameters `$offset` `$limit` `$max` `$cutoff`
`public`	# `lbReconnectTime( mixed $time )` reconnect time after failover reconnect time after failover Parameters `$time` => "2minutes" as string or 300 as int (sec.)
`public`	# `retryTime( integer $ms )` time for retry a lost connection, or if sphinx daemon busy time for retry a lost connection, or if sphinx daemon busy Parameters `$ms`
`public boolean`	# `Connect( )` connect the server connect the server Returns boolean
`private`	# `cleanOldFashionQuery( & $query )`
`public array`	# `Query( mixed $query, string $index = "*", string $comment = "" )` connect to searchd server, run given search query through given indexes and return the search results connect to searchd server, run given search query through given indexes and return the search results Parameters `$query` string for sphinx client API / string or sphinxQLBuilder object for sphinxQL `$index` (not for QL) `$comment` (not for QL) Returns array
`public sphinxResult`	# `rQuery( mixed $query, string $index = "*", string $comment = "" )` connect to searchd server, run given search query through given indexes and return the search results connect to searchd server, run given search query through given indexes and return the search results Parameters `$query` `$index` `$comment` Returns `sphinxResult`
`public`	# `SetConnectTimeout( integer $timeout_sec )` set the connection timeout set the connection timeout Parameters `$timeout_sec`
`public resource`	# `_Connect( )` Returns resource

Constants summary

`integer`	`SphinxQL_over_MySQL`	# `0`
`integer`	`SphinxQL_over_MySQLi`	# `1`

Properties summary

`private integer`	`$_version`	# `0`
`private integer`	`$_timeout_sec`	# `10`
`private array`	`$_servers`	# `array()`
`private integer`	`$_lb_reconnect_time_sec`	# `60`
`private integer`	`$_retry_on_connection_lost_ms`	# `1000`
`private boolean`	`$_sphinxQL`	# `false`
`private`	`$_sphinxQL_mysql`	# `null`
`private string`	`$_ql_error`	# `""`
`private integer`	`$_QLdriver`	# `0`
`protected string`	`$_sphinx_type`	# `'SPH'`
`private array`	`$_statistic`	# `array()`
`public integer`	`$m_last_query_ms` return the last query execution time return the last query execution time	# `0`
`public boolean`	`$m_show_old_fashion_query_info` show a deprecated info if you use "old fashion queries" with a newer release like API version >= 4505 / search daemon >= 2.1 (this memvar will be removed in future releases) show a deprecated info if you use "old fashion queries" with a newer release like API version >= 4505 / search daemon >= 2.1 (this memvar will be removed in future releases)	# `true`
`public boolean`	`$m_precheck_old_fashion_query` do a precheck before sending request for the use of "old-fashion" variables if the query is build by "sphinxQLBuilder" (this memvar will be removed in future releases) do a precheck before sending request for the use of "old-fashion" variables if the query is build by "sphinxQLBuilder" (this memvar will be removed in future releases)	# `true`