The SolrResponse class

The SolrResponse class

Introduction

(PECL solr >= 0.9.2)

Represents a response from the Solr server.

Class synopsis

abstract class SolrResponse {

/* Constants */

const int PARSE_SOLR_OBJ = 0;

const int PARSE_SOLR_DOC = 1;

/* Properties */

protected int $http_status;

protected int $parser_mode;

protected bool $success;

protected string $http_status_message;

protected string $http_request_url;

protected string $http_raw_request_headers;

protected string $http_raw_request;

protected string $http_raw_response_headers;

protected string $http_raw_response;

protected string $http_digested_response;

/* Methods */

public getDigestedResponse(): string

public getHttpStatus(): int

public getHttpStatusMessage(): string

public getRawRequest(): string

public getRawRequestHeaders(): string

public getRawResponse(): string

public getRawResponseHeaders(): string

public getRequestUrl(): string

public getResponse(): SolrObject

public setParseMode(int $parser_mode = 0): bool

public success(): bool

}

Properties

http_status

The http status of the response.

parser_mode

Whether to parse the solr documents as SolrObject or SolrDocument instances.

success

Was there an error during the request

http_status_message

Detailed message on http status

http_request_url

The request URL

http_raw_request_headers

A string of raw headers sent during the request.

http_raw_request

The raw request sent to the server

http_raw_response_headers

Response headers from the Solr server.

http_raw_response

The response message from the server.

http_digested_response

The response in PHP serialized format.

Predefined Constants

SolrResponse Class Constants

SolrResponse::PARSE_SOLR_OBJ

Documents should be parsed as SolrObject instances

SolrResponse::PARSE_SOLR_DOC

Documents should be parsed as SolrDocument instances.

Table of Contents

• SolrResponse::getDigestedResponse — Returns the XML response as serialized PHP data
• SolrResponse::getHttpStatus — Returns the HTTP status of the response
• SolrResponse::getHttpStatusMessage — Returns more details on the HTTP status
• SolrResponse::getRawRequest — Returns the raw request sent to the Solr server
• SolrResponse::getRawRequestHeaders — Returns the raw request headers sent to the Solr server
• SolrResponse::getRawResponse — Returns the raw response from the server
• SolrResponse::getRawResponseHeaders — Returns the raw response headers from the server
• SolrResponse::getRequestUrl — Returns the full URL the request was sent to
• SolrResponse::getResponse — Returns a SolrObject representing the XML response from the server
• SolrResponse::setParseMode — Sets the parse mode
• SolrResponse::success — Was the request a success

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.solrresponse.php