<!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>Checks if Solr server is still up</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.optimize.html">SolrClient::optimize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.query.html">SolrClient::query</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.ping" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrClient::ping</h1>
<p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrClient::ping</span> — <span class="dc-title">Checks if Solr server is still up</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrclient.ping-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.solrpingresponse.html" class="type SolrPingResponse">SolrPingResponse</a></span> <span class="methodname"><strong>SolrClient::ping</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrclient.ping-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrclient.ping-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a SolrPingResponse object on success and throws a SolrClientException on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-solrclient.ping-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4725">
<p><strong>Example #1 <span class="methodname"><strong>SolrClient::ping()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$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 />);<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 /><br /></span><span style="color: #0000BB">$pingresponse </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">ping</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>
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.optimize.html">SolrClient::optimize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.query.html">SolrClient::query</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>
