---
product: Chilkat
product_version: 11.7.0
language: phpext
language_label: PHP Extension
class: HttpResponse
class_name: CkHttpResponse
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/phpCkHttpResponseRef.html
---
# Chilkat HttpResponse — PHP Extension — v11.7.0

> Chilkat 11.7.0 · language=phpext · class=HttpResponse (CkHttpResponse)
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/HttpResponse.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/guide.md`.

## Purpose

**Inspect HTTP status, headers, cookies, redirects, and response bodies.**

`Chilkat.HttpResponse` represents an HTTP response returned by certain `Chilkat.Http` methods. It provides access to the response status line, status code, headers, cookies, charset, content length, body bytes, body text, full MIME response, redirect URL, and helper methods for saving or loading the response body into Chilkat objects such as `BinData`, `StringBuilder`, `JsonObject`, `JsonArray`, and `Xml`.

**Status and reason**

Read the HTTP status code, status line, and related response information to determine whether the request succeeded, redirected, or failed.

**Headers and cookies**

Inspect response headers, retrieve individual header values, and access cookies returned by the server.

**Body as text or bytes**

Get the response body as raw bytes or decoded text, using the response charset information when appropriate.

**Structured body loading**

Load the body directly into `JsonObject`, `JsonArray`, `Xml`, `BinData`, or `StringBuilder` objects for further processing.

**Redirect information**

Access redirect-related information such as the redirect URL when the server responds with a redirect status.

**Save and inspect responses**

Save body content, inspect the full MIME-style response, and use response metadata for diagnostics, logging, or API troubleshooting.

**Common pattern:** Send a request with `Chilkat.Http`, check the `StatusCode`, inspect headers or cookies as needed, then retrieve the body in the form best suited to the response content: text, bytes, `BinData`, `StringBuilder`, JSON, or XML. Use `HttpResponse` for response inspection; use `Chilkat.Http` for the actual network request.

For an extended overview, see [HttpResponse Class Overview](https://www.chilkatsoft.com/httpresponse_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```php
$obj = new CkHttpResponse();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PHP Extension.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string debugLogFilePath(); void put_DebugLogFilePath(string strVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `(read-only) string lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `(read-only) string lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `(read-only) string lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool get_LastMethodSuccess() void put_LastMethodSuccess(bool boolVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `Utf8` | `bool get_Utf8() void put_Utf8(bool boolVal);` | read/write | When set to `true`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `bool get_VerboseLogging() void put_VerboseLogging(bool boolVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `(read-only) string version();` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BodyQP` | property, read-only | `(read-only) string bodyQP();` |
| `BodyStr` | property, read-only | `(read-only) string bodyStr();` |
| `Charset` | property, read-only | `(read-only) string charset();` |
| `ContentLength` | property, read-only | `(read-only) int get_ContentLength()` |
| `ContentLength64` | property, read-only | `(read-only) int64 get_ContentLength64()` |
| `DateStr` | property, read-only | `(read-only) string dateStr();` |
| `Domain` | property, read-only | `(read-only) string domain();` |
| `FinalRedirectUrl` | property, read-only | `(read-only) string finalRedirectUrl();` |
| `FullMime` | property, read-only | `(read-only) string fullMime();` |
| `Header` | property, read-only | `(read-only) string header();` |
| `NumCookies` | property, read-only | `(read-only) int get_NumCookies()` |
| `NumHeaderFields` | property, read-only | `(read-only) int get_NumHeaderFields()` |
| `StatusCode` | property, read-only | `(read-only) int get_StatusCode()` |
| `StatusLine` | property, read-only | `(read-only) string statusLine();` |
| `StatusText` | property, read-only | `(read-only) string statusText();` |
| `UncommonOptions` | property, read/write | `string uncommonOptions(); void put_UncommonOptions(string strVal);` |
| `GetBodyBd` | method | `bool GetBodyBd(CkBinData $binData);` |
| `GetBodyJarr` | method | `bool GetBodyJarr(CkJsonArray $jarr);` |
| `GetBodyJson` | method | `bool GetBodyJson(CkJsonObject $json);` |
| `GetBodySb` | method | `bool GetBodySb(CkStringBuilder $sb);` |
| `GetBodyXml` | method | `bool GetBodyXml(CkXml $xml);` |
| `GetCookieDomain` | method | `bool GetCookieDomain(int $index, CkString outStr); string getCookieDomain(int index);` |
| `GetCookieExpiresStr` | method | `bool GetCookieExpiresStr(int $index, CkString outStr); string getCookieExpiresStr(int index);` |
| `GetCookieName` | method | `bool GetCookieName(int $index, CkString outStr); string getCookieName(int index);` |
| `GetCookiePath` | method | `bool GetCookiePath(int $index, CkString outStr); string getCookiePath(int index);` |
| `GetCookieValue` | method | `bool GetCookieValue(int $index, CkString outStr); string getCookieValue(int index);` |
| `GetHeaderField` | method | `bool GetHeaderField(string $fieldName, CkString outStr); string getHeaderField(string fieldName);` |
| `GetHeaderFieldAttr` | method | `bool GetHeaderFieldAttr(string $fieldName, string $attrName, CkString outStr); string getHeaderFieldAttr(string fieldName, string attrName);` |
| `GetHeaderName` | method | `bool GetHeaderName(int $index, CkString outStr); string getHeaderName(int index);` |
| `GetHeaderValue` | method | `bool GetHeaderValue(int $index, CkString outStr); string getHeaderValue(int index);` |
| `LoadTaskResult` | method | `bool LoadTaskResult(CkTask $task);` |
| `SaveBodyBinary` | method | `bool SaveBodyBinary(string $path);` |
| `SaveBodyText` | method | `bool SaveBodyText(bool $bCrlf, string $path);` |
| `UrlEncParamValue` | method | `bool UrlEncParamValue(string $encodedParamString, string $paramName, CkString outStr); string urlEncParamValue(string encodedParamString, string paramName);` |

## Properties

### HttpResponse.BodyQP

`Chilkat 11.7.0 · phpext · HttpResponse · BodyQP · property · read-only`

```php
(read-only)

string bodyQP();
```

The same as the Body property, but returned as a quoted-printable encoded string.

### HttpResponse.BodyStr

`Chilkat 11.7.0 · phpext · HttpResponse · BodyStr · property · read-only`

```php
(read-only)

string bodyStr();
```

The response body returned as a string.

### HttpResponse.Charset

`Chilkat 11.7.0 · phpext · HttpResponse · Charset · property · read-only`

```php
(read-only)

string charset();
```

The response charset, such as `iso-8859-1`, if applicable. Obviously, responses for GIF and JPG files will not have a charset.

### HttpResponse.ContentLength

`Chilkat 11.7.0 · phpext · HttpResponse · ContentLength · property · read-only`

```php
(read-only)

int get_ContentLength()
```

The content length of the response, in bytes.

### HttpResponse.ContentLength64

`Chilkat 11.7.0 · phpext · HttpResponse · ContentLength64 · property · read-only`

```php
(read-only)

int64 get_ContentLength64()
```

The content length of the response, in number of bytes, returned as a 64-bit integer.

### HttpResponse.DateStr

`Chilkat 11.7.0 · phpext · HttpResponse · DateStr · property · read-only`

```php
(read-only)

string dateStr();
```

Returns the content of the Date response header field in RFC822 date/time string format.

### HttpResponse.Domain

`Chilkat 11.7.0 · phpext · HttpResponse · Domain · property · read-only`

```php
(read-only)

string domain();
```

The domain of the HTTP server that created this response.

### HttpResponse.FinalRedirectUrl

`Chilkat 11.7.0 · phpext · HttpResponse · FinalRedirectUrl · property · read-only · since 9.5.0.49`

```php
(read-only)

string finalRedirectUrl();
```

Returns the redirect URL for 301/302 responses.

### HttpResponse.FullMime

`Chilkat 11.7.0 · phpext · HttpResponse · FullMime · property · read-only`

```php
(read-only)

string fullMime();
```

Returns the full MIME (header + body) of the HTTP response.

### HttpResponse.Header

`Chilkat 11.7.0 · phpext · HttpResponse · Header · property · read-only`

```php
(read-only)

string header();
```

The full text of the response header.

### HttpResponse.NumCookies

`Chilkat 11.7.0 · phpext · HttpResponse · NumCookies · property · read-only`

```php
(read-only)

int get_NumCookies()
```

The number of cookies included in the response.

### HttpResponse.NumHeaderFields

`Chilkat 11.7.0 · phpext · HttpResponse · NumHeaderFields · property · read-only`

```php
(read-only)

int get_NumHeaderFields()
```

The number of response header fields.

### HttpResponse.StatusCode

`Chilkat 11.7.0 · phpext · HttpResponse · StatusCode · property · read-only`

```php
(read-only)

int get_StatusCode()
```

The status code (as an integer) from the first line of an HTTP response. If the StatusLine = `HTTP/1.0 200 OK`, the response status code returned is 200.

### HttpResponse.StatusLine

`Chilkat 11.7.0 · phpext · HttpResponse · StatusLine · property · read-only`

```php
(read-only)

string statusLine();
```

The first line of an HTTP response, such as `HTTP/1.0 200 OK`.

### HttpResponse.StatusText

`Chilkat 11.7.0 · phpext · HttpResponse · StatusText · property · read-only · since 9.5.0.49`

```php
(read-only)

string statusText();
```

The text that follows the status code in the 1st line of the HTTP response. For example, i the first line of an HTTP response is `HTTP/1.0 200 OK`, then this property contains `OK`.

### HttpResponse.UncommonOptions

`Chilkat 11.7.0 · phpext · HttpResponse · UncommonOptions · property · read/write · since 9.5.0.89`

```php
string uncommonOptions();

void put_UncommonOptions(string strVal);
```

This is a catch-all property to be used for uncommon needs. Can be set to a list of the following comma separated keywords:

- `TakeResponseBody` - Introduced in v9.5.0.89. The GetBody\* methods will transfer the body to the target object instead of copying the contents. This can be useful if the response body is extremely large because it will reduce the overall memory requirement.

## Methods

### HttpResponse.GetBodyBd

`Chilkat 11.7.0 · phpext · HttpResponse · GetBodyBd · method · since 9.5.0.64`

```php
bool GetBodyBd(CkBinData $binData);
```

Copies the response body to a BinData object.

Returns true for success, false for failure.

### HttpResponse.GetBodyJarr

`Chilkat 11.7.0 · phpext · HttpResponse · GetBodyJarr · method · since 9.5.0.89`

```php
bool GetBodyJarr(CkJsonArray $jarr);
```

Loads the JSON array response body into a JsonArray This method should only be called when it is known that the response body contains a JSON array (beginning with a square bracket '\[' and ending with a square bracket '\]')

Returns true for success, false for failure.

### HttpResponse.GetBodyJson

`Chilkat 11.7.0 · phpext · HttpResponse · GetBodyJson · method · since 9.5.0.89`

```php
bool GetBodyJson(CkJsonObject $json);
```

Loads the JSON response body into a JsonObject. This method should only be called when it is known that the response body contains JSON (beginning with a curly brace '{' and ending with a curly brace '}')

Returns true for success, false for failure.

### HttpResponse.GetBodySb

`Chilkat 11.7.0 · phpext · HttpResponse · GetBodySb · method · since 9.5.0.64`

```php
bool GetBodySb(CkStringBuilder $sb);
```

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

### HttpResponse.GetBodyXml

`Chilkat 11.7.0 · phpext · HttpResponse · GetBodyXml · method · since 9.5.0.89`

```php
bool GetBodyXml(CkXml $xml);
```

Loads the XML response body into an XML object. This method should only be called when it is known that the response body contains XML.

Returns true for success, false for failure.

### HttpResponse.GetCookieDomain

`Chilkat 11.7.0 · phpext · HttpResponse · GetCookieDomain · method`

```php
bool GetCookieDomain(int $index, CkString outStr);

string getCookieDomain(int index);
```

Returns the domain of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

### HttpResponse.GetCookieExpiresStr

`Chilkat 11.7.0 · phpext · HttpResponse · GetCookieExpiresStr · method`

```php
bool GetCookieExpiresStr(int $index, CkString outStr);

string getCookieExpiresStr(int index);
```

Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

### HttpResponse.GetCookieName

`Chilkat 11.7.0 · phpext · HttpResponse · GetCookieName · method`

```php
bool GetCookieName(int $index, CkString outStr);

string getCookieName(int index);
```

Returns the name of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

### HttpResponse.GetCookiePath

`Chilkat 11.7.0 · phpext · HttpResponse · GetCookiePath · method`

```php
bool GetCookiePath(int $index, CkString outStr);

string getCookiePath(int index);
```

Returns the path of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

### HttpResponse.GetCookieValue

`Chilkat 11.7.0 · phpext · HttpResponse · GetCookieValue · method`

```php
bool GetCookieValue(int $index, CkString outStr);

string getCookieValue(int index);
```

Returns the value of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

### HttpResponse.GetHeaderField

`Chilkat 11.7.0 · phpext · HttpResponse · GetHeaderField · method`

```php
bool GetHeaderField(string $fieldName, CkString outStr);

string getHeaderField(string fieldName);
```

Returns the value of a response header field accessed by field name.

Returns true for success, false for failure.

### HttpResponse.GetHeaderFieldAttr

`Chilkat 11.7.0 · phpext · HttpResponse · GetHeaderFieldAttr · method`

```php
bool GetHeaderFieldAttr(string $fieldName, string $attrName, CkString outStr);

string getHeaderFieldAttr(string fieldName, string attrName);
```

Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr(`content-type`,`charset`)

Returns true for success, false for failure.

### HttpResponse.GetHeaderName

`Chilkat 11.7.0 · phpext · HttpResponse · GetHeaderName · method`

```php
bool GetHeaderName(int $index, CkString outStr);

string getHeaderName(int index);
```

Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns true for success, false for failure.

### HttpResponse.GetHeaderValue

`Chilkat 11.7.0 · phpext · HttpResponse · GetHeaderValue · method`

```php
bool GetHeaderValue(int $index, CkString outStr);

string getHeaderValue(int index);
```

Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns true for success, false for failure.

### HttpResponse.LoadTaskResult

`Chilkat 11.7.0 · phpext · HttpResponse · LoadTaskResult · method · since 9.5.0.52`

```php
bool LoadTaskResult(CkTask $task);
```

Loads the HTTP response from a completed asynchronous task. A failed return value indicates that no HTTP response was received in the HTTP asynchronous method call (i.e. the asynchronous HTTP request failed in such a way that no response was received).

Returns true for success, false for failure.

### HttpResponse.SaveBodyBinary

`Chilkat 11.7.0 · phpext · HttpResponse · SaveBodyBinary · method`

```php
bool SaveBodyBinary(string $path);
```

Saves the body of the HTTP response to a file.

Returns true for success, false for failure.

### HttpResponse.SaveBodyText

`Chilkat 11.7.0 · phpext · HttpResponse · SaveBodyText · method`

```php
bool SaveBodyText(bool $bCrlf, string $path);
```

Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If `bCrlf` is `true`, then line endings are automatically converted to CRLF if necessary. If `bCrlf` is `false`, then line-endings are automatically converted to bare-LF's (Unix style) if necessary.

To save the HTTP response body exactly as-is (with no line-ending manipulation), then call SaveBodyBinary.

Returns true for success, false for failure.

### HttpResponse.UrlEncParamValue

`Chilkat 11.7.0 · phpext · HttpResponse · UrlEncParamValue · method`

```php
bool UrlEncParamValue(string $encodedParamString, string $paramName, CkString outStr);

string urlEncParamValue(string encodedParamString, string paramName);
```

Convenience method for parsing a param's value out of a URL-encoded param string. For example, if a caller passes the following string in `encodedParamString`:

```
oauth_token=ABC&oauth_token_secret=123&oauth_callback_confirmed=true
```

and `oauth_token_secret` in `paramName`, then the return value would be `123`.

Returns true for success, false for failure.

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/BinData.md), [`JsonArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/JsonArray.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/JsonObject.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/Task.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/Xml.md)