solrpingresponse.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.solrpingresponse" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The SolrPingResponse class</title>
 <titleabbrev>SolrPingResponse</titleabbrev>

 <partintro>

<!-- {{{ SolrPingResponse intro -->
  <section xml:id="solrpingresponse.intro">
   &reftitle.intro;
   <para>
    Represents a response to a ping request to the server
   </para>
  </section>
<!-- }}} -->

  <section xml:id="solrpingresponse.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>SolrPingResponse</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>final</modifier>
      <classname>SolrPingResponse</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>SolrResponse</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrpingresponse.constants.parse-solr-obj">SolrPingResponse::PARSE_SOLR_OBJ</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrpingresponse.constants.parse-solr-doc">SolrPingResponse::PARSE_SOLR_DOC</varname>
     <initializer>1</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>

    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrpingresponse')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrpingresponse')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrpingresponse')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])"/>
    
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrresponse')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ SolrPingResponse properties -->
  <section xml:id="solrpingresponse.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="solrpingresponse.props.http-status">
     <term><varname>http_status</varname></term>
     <listitem>
      <para>The http status of the response.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.parser-mode">
     <term><varname>parser_mode</varname></term>
     <listitem>
      <para>Whether to parse the solr documents as SolrObject or SolrDocument instances.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.success">
     <term><varname>success</varname></term>
     <listitem>
      <para>Was there an error during the request</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.http-status-message">
     <term><varname>http_status_message</varname></term>
     <listitem>
      <para>Detailed message on http status</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.http-request-url">
     <term><varname>http_request_url</varname></term>
     <listitem>
      <para>The request URL</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.http-raw-request-headers">
     <term><varname>http_raw_request_headers</varname></term>
     <listitem>
      <para>A string of raw headers sent during the request</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.http-raw-request">
     <term><varname>http_raw_request</varname></term>
     <listitem>
      <para>The raw request sent to the server</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.http-raw-response-headers">
     <term><varname>http_raw_response_headers</varname></term>
     <listitem>
      <para>Response headers from the Solr server</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.http-raw-response">
     <term><varname>http_raw_response</varname></term>
     <listitem>
      <para>The response message from the server</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrpingresponse.props.http-digested-response">
     <term><varname>http_digested_response</varname></term>
     <listitem>
      <para>The response in PHP serialized format.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->

  
<!-- {{{ SolrPingResponse constants -->
  <section xml:id="solrpingresponse.constants">
   &reftitle.constants;
   <section xml:id="solrpingresponse.constants.types">
    <title>SolrPingResponse Class Constants</title>
    <variablelist>

     <varlistentry xml:id="solrpingresponse.constants.parse-solr-obj">
      <term><constant>SolrPingResponse::PARSE_SOLR_OBJ</constant></term>
      <listitem>
       <para>Documents should be parsed as SolrObject instances</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="solrpingresponse.constants.parse-solr-doc">
      <term><constant>SolrPingResponse::PARSE_SOLR_DOC</constant></term>
      <listitem>
       <para>Documents should be parsed as SolrDocument instances.</para>
      </listitem>
     </varlistentry>

    </variablelist>
   </section>
  </section>
<!-- }}} -->


 </partintro>

 &reference.solr.entities.solrpingresponse;

</reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->