<!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>Get Document By Id. Utilizes Solr Realtime Get (RTG)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.destruct.html">SolrClient::__destruct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.getbyids.html">SolrClient::getByIds</a></div>
<div class="up"><a href="class.solrclient.html">SolrClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="solrclient.getbyid" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrClient::getById</h1>
<p class="verinfo">(PECL solr >= 2.2.0)</p><p class="refpurpose"><span class="refname">SolrClient::getById</span> — <span class="dc-title">Get Document By Id. Utilizes Solr Realtime Get (RTG)</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrclient.getbyid-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.solrqueryresponse.html" class="type SolrQueryResponse">SolrQueryResponse</a></span> <span class="methodname"><strong>SolrClient::getById</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
)</div>
<p class="para rdfs-comment">
Get Document By Id. Utilizes Solr Realtime Get (RTG).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrclient.getbyid-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">id</code></dt>
<dd>
<p class="para">
Document ID
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrclient.getbyid-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="type"><a href="class.solrqueryresponse.html" class="type SolrQueryResponse">SolrQueryResponse</a></span>
</p>
</div>
<div class="refsect1 examples" id="refsect1-solrclient.getbyid-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5879">
<p><strong>Example #1 <span class="function"><strong>SolrClient::getById()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">include </span><span style="color: #DD0000">"bootstrap.php"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= array<br />(<br /> </span><span style="color: #DD0000">'hostname' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_HOSTNAME</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'login' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_USERNAME</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'password' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_PASSWORD</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'port' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_PORT</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'path' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_PATH<br /></span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrClient</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$response </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">getById</span><span style="color: #007700">(</span><span style="color: #DD0000">'GB18030TEST'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$response</span><span style="color: #007700">-></span><span style="color: #0000BB">getResponse</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
SolrObject Object
(
[doc] => SolrObject Object
(
[id] => GB18030TEST
[name] => Array
(
[0] => Test with some GB18030 encoded characters
)
[features] => Array
(
[0] => No accents here
[1] => 这是一个功能
[2] => This is a feature (translated)
[3] => 这份文件是很有光泽
[4] => This document is very shiny (translated)
)
[price] => Array
(
[0] => 0
)
[inStock] => Array
(
[0] => 1
)
[_version_] => 1510294336239042560
)
)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-solrclient.getbyid-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="solrclient.getbyids.html" class="methodname" rel="rdfs-seeAlso">SolrClient::getByIds()</a> - Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.destruct.html">SolrClient::__destruct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.getbyids.html">SolrClient::getByIds</a></div>
<div class="up"><a href="class.solrclient.html">SolrClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
