Chilkat_9_5_0.HttpResponse PHP ActiveX Reference Documentation

Chilkat_9_5_0.HttpResponse

Represents a complete HTTP response.

Object Creation

$obj = new COM("Chilkat_9_5_0.HttpResponse");

Properties

VARIANT Body (read-only)

The response body returned as a byte array.

string BodyQP (read-only)

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

string BodyStr (read-only)

The response body returned as a string.

string Charset (read-only)

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

int ContentLength (read-only)

The content length of the response, in bytes.

Date Date (read-only)

This property is deprecated. It will be removed in a future version.

The Date response header field, returned in a date/time data type.

string DateStr (read-only)

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

string DebugLogFilePath

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.

string Domain (read-only)

The domain of the HTTP server that created this response.

string FinalRedirectUrl (read-only)

Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

string FullMime (read-only)

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

string Header (read-only)

The full text of the response header.

VARIANT LastBinaryResult (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

string LastErrorHtml (read-only)

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.

string LastErrorText (read-only)

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

string LastErrorXml (read-only)

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 LastMethodSuccess

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.

string LastStringResult (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

int LastStringResultLen (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

int NumCookies (read-only)

The number of cookies included in the response.

int NumHeaderFields (read-only)

The number of response header fields.

int StatusCode (read-only)

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.

string StatusLine (read-only)

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

string StatusText (read-only)

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 VerboseLogging

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.

string Version (read-only)

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

Methods

bool GetBodyBd(Chilkat_9_5_0.BinData 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(Chilkat_9_5_0.StringBuilder sb)

Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

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 null on failure

Date GetCookieExpires(int index)

This method is deprecated. It will be removed in a future version.

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.

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 null on failure

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 null on failure

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 null on failure

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 null on failure

string GetHeaderField(string fieldName)

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

Returns null on failure

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 null on failure

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 null on failure

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 null on failure

bool LoadTaskResult(Chilkat_9_5_0.Task 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.

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 null on failure