SOLRRESPONSE(3) 1 SOLRRESPONSE(3)The SolrResponse classINTRODUCTION
Represents a response from the Solr server.
CLASS SYNOPSIS
SolrResponse
abstract
SolrResponse
Constants
o const integer$SolrResponse::PARSE_SOLR_OBJ0
o const integer$SolrResponse::PARSE_SOLR_DOC1
Properties
o protected integer$http_status
o protected integer$parser_mode
o protected bool$success
o protected string$http_status_message
o protected string$http_request_url
o protected string$http_raw_request_headers
o protected string$http_raw_request
o protected string$http_raw_response_headers
o protected string$http_raw_response
o protected string$http_digested_response
Methods
o public string SolrResponse::getDigestedResponse (void )
o public int SolrResponse::getHttpStatus (void )
o public string SolrResponse::getHttpStatusMessage (void )
o public string SolrResponse::getRawRequest (void )
o public string SolrResponse::getRawRequestHeaders (void )
o public string SolrResponse::getRawResponse (void )
o public string SolrResponse::getRawResponseHeaders (void )
o public string SolrResponse::getRequestUrl (void )
o public SolrObject SolrResponse::getResponse (void )
o public bool SolrResponse::setParseMode ([int $parser_mode])
o public bool SolrResponse::success (void )
PROPERTIES
o $http_status
-The http status of the response.
o $parser_mode
-Whether to parse the solr documents as SolrObject or SolrDocument instances.
o $success
-Was there an error during the request
o $http_status_message
-Detailed message on http status
o $http_request_url
-The request URL
o $http_raw_request_headers
-A string of raw headers sent during the request.
o $http_raw_request
-The raw request sent to the server
o $http_raw_response_headers
-Response headers from the Solr server.
o $http_raw_response
-The response message from the server.
o $http_digested_response
-The response in PHP serialized format.
PREDEFINED CONSTANTS SOLRRESPONSE CLASS CONSTANTS
o SolrResponse::PARSE_SOLR_OBJ -Documents should be parsed as SolrObject instances
o SolrResponse::PARSE_SOLR_DOC -Documents should be parsed as SolrDocument instances.
PHP Documentation Group SOLRRESPONSE(3)
Check Out this Related Man Page
HTTPMESSAGE(3) 1 HTTPMESSAGE(3)The HttpMessage classCLASS SYNOPSIS
HttpMessage
HttpMessageIteratorCountableSerializable
o public void HttpMessage::addHeaders (array $headers, [bool $append = false])
o public HttpMessage::__construct ([string $message])
o public HttpMessage HttpMessage::detach (void )
o static public HttpMessage HttpMessage::factory ([string $raw_message], [string $class_name = "HttpMessage"])
o static public HttpMessage HttpMessage::fromEnv (int $message_type, [string $class_name = "HttpMessage"])
o static public HttpMessage HttpMessage::fromString ([string $raw_message], [string $class_name = "HttpMessage"])
o public string HttpMessage::getBody (void )
o public string HttpMessage::getHeader (string $header)
o public array HttpMessage::getHeaders (void )
o public string HttpMessage::getHttpVersion (void )
o public HttpMessage HttpMessage::getParentMessage (void )
o public string HttpMessage::getRequestMethod (void )
o public string HttpMessage::getRequestUrl (void )
o public int HttpMessage::getResponseCode (void )
o public string HttpMessage::getResponseStatus (void )
o public int HttpMessage::getType (void )
o public string HttpMessage::guessContentType (string $magic_file, [int $magic_mode = MAGIC_MIME])
o public void HttpMessage::prepend (HttpMessage $message, [bool $top = true])
o public HttpMessage HttpMessage::reverse (void )
o public bool HttpMessage::send (void )
o public void HttpMessage::setBody (string $body)
o public void HttpMessage::setHeaders (array $headers)
o public bool HttpMessage::setHttpVersion (string $version)
o public bool HttpMessage::setRequestMethod (string $method)
o public bool HttpMessage::setRequestUrl (string $url)
o public bool HttpMessage::setResponseCode (int $code)
o public bool HttpMessage::setResponseStatus (string $status)
o public void HttpMessage::setType (int $type)
o public HttpRequest|HttpResponse HttpMessage::toMessageTypeObject (void )
o public string HttpMessage::toString ([bool $include_parent = false])
CLASS MEMBERS PROPERTIES
Instance Properties
+----------+-----------------------------+---+---+
|Modifiers | | | |
| | | | |
| | Type | | |
| | | | |
| | Name | | |
| | | | |
| | Description | | |
| | | | |
+----------+-----------------------------+---+---+
|protected | | | |
| | | | |
| | int | | |
| | | | |
| | type | | |
| | | | |
| | message type | | |
| | | | |
|protected | | | |
| | | | |
| | string | | |
| | | | |
| | body | | |
| | | | |
| | message body | | |
| | | | |
|protected | | | |
| | | | |
| | float | | |
| | | | |
| | httpVersion | | |
| | | | |
| | HTTP protocol version | | |
| | | | |
|protected | | | |
| | | | |
| | array | | |
| | | | |
| | headers | | |
| | | | |
| | message headers | | |
| | | | |
|protected | | | |
| | | | |
| | string | | |
| | | | |
| | requestMethod | | |
| | | | |
| | request method name | | |
| | | | |
|protected | | | |
| | | | |
| | requestUrl | | |
| | | | |
| | string | | |
| | | | |
| | request URL | | |
| | | | |
|protected | | | |
| | | | |
| | int | | |
| | | | |
| | responseCode | | |
| | | | |
| | response code | | |
| | | | |
|protected | | | |
| | | | |
| | string | | |
| | | | |
| | responseStatus | | |
| | | | |
| | response status message | | |
| | | | |
|protected | | | |
| | | | |
| | HttpMessage | | |
| | | | |
| | parentMessage | | |
| | | | |
| | reference to parent message | | |
| | | | |
+----------+-----------------------------+---+---+
Note
None of these default properties can be accessed by reference, array key/index notation nor be used in increment or decrement oper-
ations.
PREDEFINED CONSTANTS
+-----+--------------------------------------+---+
|Type | | |
| | | |
| | Name | |
| | | |
| | Description | |
| | | |
+-----+--------------------------------------+---+
|int | | |
| | | |
| | TYPE_NONE | |
| | | |
| | message has is of no specific type | |
| | | |
|int | | |
| | | |
| | TYPE_REQUEST | |
| | | |
| | message is a request style HTTP mes- | |
| | sage | |
| | | |
|int | | |
| | | |
| | TYPE_RESPONSE | |
| | | |
| | message is a response style HTTP | |
| | message | |
| | | |
+-----+--------------------------------------+---+
PHP Documentation Group HTTPMESSAGE(3)