<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Change the format of result set array</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sphinxclient.runqueries.html">SphinxClient::runQueries</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sphinxclient.setconnecttimeout.html">SphinxClient::setConnectTimeout</a></div>
<div class="up"><a href="class.sphinxclient.html">SphinxClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="sphinxclient.setarrayresult" class="refentry">
<div class="refnamediv">
<h1 class="refname">SphinxClient::setArrayResult</h1>
<p class="verinfo">(PECL sphinx >= 0.1.0)</p><p class="refpurpose"><span class="refname">SphinxClient::setArrayResult</span> — <span class="dc-title">Change the format of result set array</span></p>
</div>
<div class="refsect1 description" id="refsect1-sphinxclient.setarrayresult-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SphinxClient::setArrayResult</strong></span>
( <span class="methodparam"><span class="type">bool</span> <code class="parameter">$array_result</code><span class="initializer"> = false</span></span>
)</div>
<p class="para rdfs-comment">
Controls the format of search results set arrays (whether matches should
be returned as an array or a hash).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-sphinxclient.setarrayresult-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">array_result</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">array_result</code></em> is <strong><code>FALSE</code></strong>, matches
are returned as a hash with document IDs as keys, and other information (weight,
attributes) as values. If <em><code class="parameter">array_result</code></em> is <strong><code>TRUE</code></strong>, matches
are returned as a plain array with complete per-match information including
document IDs.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-sphinxclient.setarrayresult-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Always returns <strong><code>TRUE</code></strong>.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sphinxclient.runqueries.html">SphinxClient::runQueries</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sphinxclient.setconnecttimeout.html">SphinxClient::setConnectTimeout</a></div>
<div class="up"><a href="class.sphinxclient.html">SphinxClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
