mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
86e6094e86
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
231 lines
7.4 KiB
XML
231 lines
7.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<phpdoc:classref xml:id="class.solrresponse" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
<title>The SolrResponse class</title>
|
|
<titleabbrev>SolrResponse</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ SolrResponse intro -->
|
|
<section xml:id="solrresponse.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
Represents a response from the Solr server.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="solrresponse.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass><classname>SolrResponse</classname></ooclass>
|
|
|
|
<!-- {{{ Class synopsis -->
|
|
<classsynopsisinfo>
|
|
<ooclass>
|
|
<modifier>abstract</modifier>
|
|
<classname>SolrResponse</classname>
|
|
</ooclass>
|
|
</classsynopsisinfo>
|
|
<!-- }}} -->
|
|
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="solrresponse.constants.parse-solr-obj">SolrResponse::PARSE_SOLR_OBJ</varname>
|
|
<initializer>0</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="solrresponse.constants.parse-solr-doc">SolrResponse::PARSE_SOLR_DOC</varname>
|
|
<initializer>1</initializer>
|
|
</fieldsynopsis>
|
|
|
|
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>int</type>
|
|
<varname linkend="solrresponse.props.http-status">http_status</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>int</type>
|
|
<varname linkend="solrresponse.props.parser-mode">parser_mode</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>bool</type>
|
|
<varname linkend="solrresponse.props.success">success</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>string</type>
|
|
<varname linkend="solrresponse.props.http-status-message">http_status_message</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>string</type>
|
|
<varname linkend="solrresponse.props.http-request-url">http_request_url</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>string</type>
|
|
<varname linkend="solrresponse.props.http-raw-request-headers">http_raw_request_headers</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>string</type>
|
|
<varname linkend="solrresponse.props.http-raw-request">http_raw_request</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>string</type>
|
|
<varname linkend="solrresponse.props.http-raw-response-headers">http_raw_response_headers</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>string</type>
|
|
<varname linkend="solrresponse.props.http-raw-response">http_raw_response</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<type>string</type>
|
|
<varname linkend="solrresponse.props.http-digested-response">http_digested_response</varname>
|
|
</fieldsynopsis>
|
|
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</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>
|
|
|
|
|
|
<!-- {{{ SolrResponse properties -->
|
|
<section xml:id="solrresponse.props">
|
|
&reftitle.properties;
|
|
<variablelist>
|
|
<varlistentry xml:id="solrresponse.props.http-status">
|
|
<term><varname>http_status</varname></term>
|
|
<listitem>
|
|
<para>The http status of the response.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="solrresponse.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="solrresponse.props.success">
|
|
<term><varname>success</varname></term>
|
|
<listitem>
|
|
<para>Was there an error during the request</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="solrresponse.props.http-status-message">
|
|
<term><varname>http_status_message</varname></term>
|
|
<listitem>
|
|
<para>Detailed message on http status</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="solrresponse.props.http-request-url">
|
|
<term><varname>http_request_url</varname></term>
|
|
<listitem>
|
|
<para>The request URL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="solrresponse.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="solrresponse.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="solrresponse.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="solrresponse.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="solrresponse.props.http-digested-response">
|
|
<term><varname>http_digested_response</varname></term>
|
|
<listitem>
|
|
<para>The response in PHP serialized format.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
|
|
<!-- {{{ SolrResponse constants -->
|
|
<section xml:id="solrresponse.constants">
|
|
&reftitle.constants;
|
|
<section xml:id="solrresponse.constants.types">
|
|
<title>SolrResponse Class Constants</title>
|
|
<variablelist>
|
|
|
|
<varlistentry xml:id="solrresponse.constants.parse-solr-obj">
|
|
<term><constant>SolrResponse::PARSE_SOLR_OBJ</constant></term>
|
|
<listitem>
|
|
<para>Documents should be parsed as SolrObject instances</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="solrresponse.constants.parse-solr-doc">
|
|
<term><constant>SolrResponse::PARSE_SOLR_DOC</constant></term>
|
|
<listitem>
|
|
<para>Documents should be parsed as SolrDocument instances.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</section>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
|
|
</partintro>
|
|
|
|
&reference.solr.entities.solrresponse;
|
|
|
|
</phpdoc:classref>
|
|
|
|
<!-- 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
|
|
-->
|