CkHttpResponse PHP Extension Reference Documentation

CkHttpResponse

Represents a complete HTTP response.

Object Creation

$obj = new CkHttpResponse();

Properties

(read-only)
void get_Body(CkByteData byteData)

The response body returned as a byte array.

(read-only)
string bodyQP();

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

(read-only)
string bodyStr();

The response body returned as a string.

(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.

(read-only)
int get_ContentLength()

The content length of the response, in bytes.

(read-only)
int64 get_ContentLength64()

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

(read-only)
string dateStr();

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

string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

(read-only)
string domain();

The domain of the HTTP server that created this response.

(read-only)
string finalRedirectUrl();

Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

(read-only)
string fullMime();

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

(read-only)
string header();

The full text of the response header.

(read-only)
string lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

(read-only)
string lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

(read-only)
string lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

(read-only)
int get_NumCookies()

The number of cookies included in the response.

(read-only)
int get_NumHeaderFields()

The number of response header fields.

(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.

(read-only)
string statusLine();

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

(read-only)
string statusText();

Introduced in version 9.5.0.49

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".

bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

(read-only)
string version();

Version of the component/library, such as "9.5.0.63"

Methods

bool GetBodyBd(CkBinData binData);

Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns true for success, false for failure.

bool GetBodySb(CkStringBuilder sb);

Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

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.

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.

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.

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.

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.

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.

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.

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.

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.

bool LoadTaskResult(CkTask task);

Introduced in version 9.5.0.52

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.

Getting the HTTP Response after an Asynchronous HTTP Request Completes

bool SaveBodyBinary(string path);

Saves the body of the HTTP response to a file.

Returns true for success, false for failure.

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.

bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

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.