| modification, are permitted provided that the conditions mentioned |
| in the accompanying LICENSE file are met. |
+--------------------------------------------------------------------+
- | Copyright (c) 2004-2006, Michael Wallner <mike@php.net> |
+ | Copyright (c) 2004-2007, Michael Wallner <mike@php.net> |
+--------------------------------------------------------------------+
*/
#define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpRequest, method, 0)
#define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
#define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
+#define HTTP_REQUEST_MALIAS(me, al, vis) ZEND_FENTRY(me, ZEND_MN(HttpRequest_##al), HTTP_ARGS(HttpRequest, al), vis)
HTTP_BEGIN_ARGS(__construct, 0)
HTTP_ARG_VAL(url, 0)
HTTP_ARG_VAL(options, 0)
HTTP_END_ARGS;
+HTTP_BEGIN_ARGS(factory, 0)
+ HTTP_ARG_VAL(url, 0)
+ HTTP_ARG_VAL(method, 0)
+ HTTP_ARG_VAL(options, 0)
+ HTTP_ARG_VAL(class_name, 0)
+HTTP_END_ARGS;
+
HTTP_EMPTY_ARGS(getOptions);
HTTP_BEGIN_ARGS(setOptions, 0)
HTTP_ARG_VAL(options, 0)
HTTP_ARG_VAL(content_type, 0)
HTTP_END_ARGS;
-HTTP_EMPTY_ARGS(getRawPostData);
-HTTP_BEGIN_ARGS(setRawPostData, 0)
- HTTP_ARG_VAL(raw_post_data, 0)
+HTTP_EMPTY_ARGS(getBody);
+HTTP_BEGIN_ARGS(setBody, 0)
+ HTTP_ARG_VAL(request_body_data, 0)
HTTP_END_ARGS;
-HTTP_BEGIN_ARGS(addRawPostData, 1)
- HTTP_ARG_VAL(raw_post_data, 0)
+HTTP_BEGIN_ARGS(addBody, 1)
+ HTTP_ARG_VAL(request_body_data, 0)
HTTP_END_ARGS;
HTTP_EMPTY_ARGS(getPutFile);
HTTP_ARG_VAL(method, 0)
HTTP_END_ARGS;
-#ifdef HAVE_CURL_GETFORMDATA
+#if defined(HAVE_CURL_GETFORMDATA) || defined(HAVE_CURL_FORMGET)
HTTP_BEGIN_ARGS(encodeBody, 2)
HTTP_ARG_VAL(fields, 0)
HTTP_ARG_VAL(files, 0)
HTTP_REQUEST_ME(getPostFields, ZEND_ACC_PUBLIC)
HTTP_REQUEST_ME(addPostFields, ZEND_ACC_PUBLIC)
- HTTP_REQUEST_ME(setRawPostData, ZEND_ACC_PUBLIC)
- HTTP_REQUEST_ME(getRawPostData, ZEND_ACC_PUBLIC)
- HTTP_REQUEST_ME(addRawPostData, ZEND_ACC_PUBLIC)
+ HTTP_REQUEST_ME(setBody, ZEND_ACC_PUBLIC)
+ HTTP_REQUEST_ME(getBody, ZEND_ACC_PUBLIC)
+ HTTP_REQUEST_ME(addBody, ZEND_ACC_PUBLIC)
+ HTTP_REQUEST_MALIAS(setRawPostData, setBody, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
+ HTTP_REQUEST_MALIAS(getRawPostData, getBody, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
+ HTTP_REQUEST_MALIAS(addRawPostData, addBody, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
HTTP_REQUEST_ME(setPostFiles, ZEND_ACC_PUBLIC)
HTTP_REQUEST_ME(addPostFile, ZEND_ACC_PUBLIC)
HTTP_REQUEST_ME(getHistory, ZEND_ACC_PUBLIC)
HTTP_REQUEST_ME(clearHistory, ZEND_ACC_PUBLIC)
+ HTTP_REQUEST_ME(factory, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
+
HTTP_REQUEST_ALIAS(get, http_get)
HTTP_REQUEST_ALIAS(head, http_head)
HTTP_REQUEST_ALIAS(postData, http_post_data)
HTTP_REQUEST_ALIAS(methodUnregister, http_request_method_unregister)
HTTP_REQUEST_ALIAS(methodName, http_request_method_name)
HTTP_REQUEST_ALIAS(methodExists, http_request_method_exists)
-#ifdef HAVE_CURL_GETFORMDATA
+#if defined(HAVE_CURL_GETFORMDATA) || defined(HAVE_CURL_FORMGET)
HTTP_REQUEST_ALIAS(encodeBody, http_request_body_encode)
#endif
EMPTY_FUNCTION_ENTRY
DCL_PROP_N(PRIVATE, postFields);
DCL_PROP_N(PRIVATE, postFiles);
DCL_PROP_N(PRIVATE, responseInfo);
- DCL_PROP_N(PRIVATE, responseData);
DCL_PROP_N(PRIVATE, responseMessage);
DCL_PROP(PRIVATE, long, responseCode, 0);
DCL_PROP(PRIVATE, string, responseStatus, "");
DCL_PROP(PRIVATE, long, method, HTTP_GET);
DCL_PROP(PRIVATE, string, url, "");
DCL_PROP(PRIVATE, string, contentType, "");
- DCL_PROP(PRIVATE, string, rawPostData, "");
+ DCL_PROP(PRIVATE, string, requestBody, "");
DCL_PROP(PRIVATE, string, queryData, "");
DCL_PROP(PRIVATE, string, putFile, "");
DCL_PROP(PRIVATE, string, putData, "");
*/
DCL_CONST(long, "VERSION_1_0", CURL_HTTP_VERSION_1_0);
DCL_CONST(long, "VERSION_1_1", CURL_HTTP_VERSION_1_1);
- DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE);
+ DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE); /* to be removed */
+ DCL_CONST(long, "VERSION_ANY", CURL_HTTP_VERSION_NONE);
+
+ /*
+ * SSL Version Constants
+ */
+ DCL_CONST(long, "SSL_VERSION_TLSv1", CURL_SSLVERSION_TLSv1);
+ DCL_CONST(long, "SSL_VERSION_SSLv2", CURL_SSLVERSION_SSLv2);
+ DCL_CONST(long, "SSL_VERSION_SSLv3", CURL_SSLVERSION_SSLv3);
+ DCL_CONST(long, "SSL_VERSION_ANY", CURL_SSLVERSION_DEFAULT);
+
+ /*
+ * DNS IPvX resolving
+ */
+ DCL_CONST(long, "IPRESOLVE_V4", CURL_IPRESOLVE_V4);
+ DCL_CONST(long, "IPRESOLVE_V6", CURL_IPRESOLVE_V6);
+ DCL_CONST(long, "IPRESOLVE_ANY", CURL_IPRESOLVE_WHATEVER);
/*
* Auth Constants
DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC);
DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST);
DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM);
+ DCL_CONST(long, "AUTH_GSSNEG", CURLAUTH_GSSNEGOTIATE);
DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY);
/*
case HTTP_PUT:
{
- zval *put_data = GET_PROP(putData);
+ zval *put_file = GET_PROP(putFile);
http_request_object_check_request_content_type(getThis());
- if (Z_STRLEN_P(put_data)) {
- obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_CSTRING,
- estrndup(Z_STRVAL_P(put_data), Z_STRLEN_P(put_data)), Z_STRLEN_P(put_data), 1);
- } else {
+
+ if (Z_STRLEN_P(put_file)) {
php_stream_statbuf ssb;
- php_stream *stream = php_stream_open_wrapper_ex(Z_STRVAL_P(GET_PROP(putFile)), "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL, HTTP_DEFAULT_STREAM_CONTEXT);
+ php_stream *stream = php_stream_open_wrapper_ex(Z_STRVAL_P(put_file), "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL, HTTP_DEFAULT_STREAM_CONTEXT);
- if (stream && !php_stream_stat(stream, &ssb)) {
+ if (stream && SUCCESS == php_stream_stat(stream, &ssb)) {
obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_UPLOADFILE, stream, ssb.sb.st_size, 1);
} else {
status = FAILURE;
}
+ } else {
+ zval *put_data = GET_PROP(putData);
+ obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_CSTRING,
+ estrndup(Z_STRVAL_P(put_data), Z_STRLEN_P(put_data)), Z_STRLEN_P(put_data), 1);
}
break;
}
case HTTP_POST:
default:
{
- /* check for raw post data */
- zval *raw_data = GET_PROP(rawPostData);
+ /* check for raw request body */
+ zval *raw_data = GET_PROP(requestBody);
if (Z_STRLEN_P(raw_data)) {
http_request_object_check_request_content_type(getThis());
phpstr_fix(&obj->request->conv.response);
if ((msg = http_message_parse(PHPSTR_VAL(&obj->request->conv.response), PHPSTR_LEN(&obj->request->conv.response)))) {
- char *body;
- size_t body_len;
- zval *headers, *message, *resp;
+ zval *message;
if (zval_is_true(GET_PROP(recordHistory))) {
zval *hist, *history = GET_PROP(history);
}
UPD_PROP(long, responseCode, msg->http.info.response.code);
- UPD_PROP(string, responseStatus, msg->http.info.response.status ? msg->http.info.response.status : "");
-
- MAKE_STD_ZVAL(resp);
- array_init(resp);
- MAKE_STD_ZVAL(headers);
- array_init(headers);
- zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
- add_assoc_zval(resp, "headers", headers);
- phpstr_data(PHPSTR(msg), &body, &body_len);
- add_assoc_stringl(resp, "body", body, body_len, 0);
- SET_PROP(responseData, resp);
- zval_ptr_dtor(&resp);
+ UPD_PROP(string, responseStatus, STR_PTR(msg->http.info.response.status));
MAKE_STD_ZVAL(message);
ZVAL_OBJVAL(message, http_message_object_new_ex(http_message_object_ce, msg, NULL), 0);
ret = SUCCESS;
} else {
/* update properties with empty values*/
- zval *resp = GET_PROP(responseData), *znull;
+ zval *znull;
MAKE_STD_ZVAL(znull);
ZVAL_NULL(znull);
SET_PROP(responseMessage, znull);
zval_ptr_dtor(&znull);
- if (Z_TYPE_P(resp) == IS_ARRAY) {
- zend_hash_clean(Z_ARRVAL_P(resp));
- }
-
UPD_PROP(long, responseCode, 0);
UPD_PROP(string, responseStatus, "");
ret = FAILURE;
}
+ http_request_set_progress_callback(obj->request, NULL);
+
if (!EG(exception) && zend_hash_exists(&Z_OBJCE_P(getThis())->function_table, "onfinish", sizeof("onfinish"))) {
zval *param;
static int apply_pretty_key(void *pDest, int num_args, va_list args, zend_hash_key *hash_key)
{
if (hash_key->nKeyLength > 1) {
- hash_key->h = zend_get_hash_value(pretty_key(hash_key->arKey, hash_key->nKeyLength - 1, 1, 0), hash_key->nKeyLength);
+ hash_key->h = zend_hash_func(pretty_key(hash_key->arKey, hash_key->nKeyLength - 1, 1, 0), hash_key->nKeyLength);
}
return ZEND_HASH_APPLY_KEEP;
}
array_init(new_opts);
old_opts = GET_PROP(options);
if (Z_TYPE_P(old_opts) == IS_ARRAY) {
- array_copy(old_opts, new_opts);
+ array_copy(Z_ARRVAL_P(old_opts), Z_ARRVAL_P(new_opts));
}
- if (prettify_keys && opts) {
- zend_hash_apply_with_arguments(Z_ARRVAL_P(opts), apply_pretty_key, 0);
- }
if (SUCCESS == zend_hash_find(Z_ARRVAL_P(new_opts), key, len, (void *) &entry)) {
if (overwrite) {
zend_hash_clean(Z_ARRVAL_PP(entry));
}
if (opts && zend_hash_num_elements(Z_ARRVAL_P(opts))) {
if (overwrite) {
- array_copy(opts, *entry);
+ array_copy(Z_ARRVAL_P(opts), Z_ARRVAL_PP(entry));
} else {
- array_merge(opts, *entry);
+ array_join(Z_ARRVAL_P(opts), Z_ARRVAL_PP(entry), 0, prettify_keys ? ARRAY_JOIN_PRETTIFY : 0);
}
}
} else if (opts) {
+ if (prettify_keys) {
+ zend_hash_apply_with_arguments(Z_ARRVAL_P(opts), apply_pretty_key, 0);
+ }
ZVAL_ADDREF(opts);
- add_assoc_zval(new_opts, key, opts);
+ add_assoc_zval_ex(new_opts, key, len, opts);
}
SET_PROP(options, new_opts);
zval_ptr_dtor(&new_opts);
if ( (Z_TYPE_P(opts) == IS_ARRAY) &&
(SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), key, len, (void *) &options))) {
convert_to_array(*options);
- array_copy(*options, return_value);
+ array_copy(Z_ARRVAL_PP(options), Z_ARRVAL_P(return_value));
}
}
}
/* ### USERLAND ### */
/* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
- *
- * Instantiate a new HttpRequest object.
- *
- * Accepts a string as optional parameter containing the target request url.
- * Additionally accepts an optional int parameter specifying the request method
- * to use and an associative array as optional third parameter which will be
- * passed to HttpRequest::setOptions().
- *
- * Throws HttpException.
- */
+ Create a new HttpRequest object instance. */
PHP_METHOD(HttpRequest, __construct)
{
char *URL = NULL;
zval *options = NULL;
SET_EH_THROW_HTTP();
- if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sla", &URL, &URL_len, &meth, &options)) {
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sla!", &URL, &URL_len, &meth, &options)) {
+ if (URL) {
+ UPD_STRL(url, URL, URL_len);
+ }
+ if (meth > -1) {
+ UPD_PROP(long, method, meth);
+ }
+ if (options) {
+ zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "setoptions", NULL, options);
+ }
+ }
+ SET_EH_NORMAL();
+}
+/* }}} */
+
+/* {{{ proto HttpRequest HttpRequest::factory([string url[, int request_method HTTP_METH_GET[, array options[, string class_name = "HttpRequest"]]]])
+ Create a new HttpRequest object instance. */
+PHP_METHOD(HttpRequest, factory)
+{
+ char *cn = NULL, *URL = NULL;
+ int cl = 0, URL_len = 0;
+ long meth = -1;
+ zval *options = NULL;
+ zend_object_value ov;
+
+ SET_EH_THROW_HTTP();
+ if ( SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sla!s", &URL, &URL_len, &meth, &options, &cn, &cl) &&
+ SUCCESS == http_object_new(&ov, cn, cl, _http_request_object_new_ex, http_request_object_ce, NULL, NULL)) {
+ RETVAL_OBJVAL(ov, 0);
+ getThis() = return_value;
if (URL) {
UPD_STRL(url, URL, URL_len);
}
/* }}} */
/* {{{ proto bool HttpRequest::setOptions([array options])
- *
- * Set the request options to use. See http_get() for a full list of available options.
- *
- * Accepts an array as optional parameters, which values will overwrite the
- * currently set request options. If the parameter is empty or omitted,
- * the options of the HttpRequest object will be reset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set the request options to use. See http_get() for a full list of available options. */
PHP_METHOD(HttpRequest, setOptions)
{
- char *key = NULL;
- ulong idx = 0;
+ HashKey key = initHashKey(0);
HashPosition pos;
zval *opts = NULL, *old_opts, *new_opts, *add_opts, **opt;
MAKE_STD_ZVAL(add_opts);
array_init(add_opts);
/* some options need extra attention -- thus cannot use array_merge() directly */
- FOREACH_KEYVAL(pos, opts, key, idx, opt) {
- if (key) {
- if (!strcmp(key, "headers")) {
+ FOREACH_KEYVAL(pos, opts, key, opt) {
+ if (key.type == HASH_KEY_IS_STRING) {
+ if (!strcmp(key.str, "headers")) {
zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addheaders", NULL, *opt);
- } else if (!strcmp(key, "cookies")) {
+ } else if (!strcmp(key.str, "cookies")) {
zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addcookies", NULL, *opt);
- } else if (!strcmp(key, "ssl")) {
+ } else if (!strcmp(key.str, "ssl")) {
zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addssloptions", NULL, *opt);
- } else if ((!strcasecmp(key, "url")) || (!strcasecmp(key, "uri"))) {
+ } else if ((!strcasecmp(key.str, "url")) || (!strcasecmp(key.str, "uri"))) {
zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "seturl", NULL, *opt);
- } else if (!strcmp(key, "method")) {
+ } else if (!strcmp(key.str, "method")) {
zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "setmethod", NULL, *opt);
#if HTTP_CURL_VERSION(7,14,1)
- } else if (!strcmp(key, "resetcookies")) {
+ } else if (!strcmp(key.str, "resetcookies")) {
getObject(http_request_object, obj);
http_request_reset_cookies(obj->request, 0);
#endif
- } else if (!strcmp(key, "enablecookies")) {
+ } else if (!strcmp(key.str, "enablecookies")) {
getObject(http_request_object, obj);
http_request_enable_cookies(obj->request);
- } else if (!strcasecmp(key, "recordHistory")) {
+ } else if (!strcasecmp(key.str, "recordHistory")) {
UPD_PROP(bool, recordHistory, 1);
} else {
ZVAL_ADDREF(*opt);
- add_assoc_zval(add_opts, key, *opt);
+ add_assoc_zval_ex(add_opts, key.str, key.len, *opt);
}
- /* reset */
- key = NULL;
}
}
old_opts = GET_PROP(options);
if (Z_TYPE_P(old_opts) == IS_ARRAY) {
- array_copy(old_opts, new_opts);
+ array_copy(Z_ARRVAL_P(old_opts), Z_ARRVAL_P(new_opts));
}
- array_merge(add_opts, new_opts);
+ array_join(Z_ARRVAL_P(add_opts), Z_ARRVAL_P(new_opts), 0, 0);
SET_PROP(options, new_opts);
zval_ptr_dtor(&new_opts);
zval_ptr_dtor(&add_opts);
/* }}} */
/* {{{ proto array HttpRequest::getOptions()
- *
- * Get currently set options.
- *
- * Returns an associative array containing currently set options.
- */
+ Get currently set options. */
PHP_METHOD(HttpRequest, getOptions)
{
NO_ARGS;
/* }}} */
/* {{{ proto bool HttpRequest::setSslOptions([array options])
- *
- * Set SSL options.
- *
- * Accepts an associative array as parameter containing any SSL specific options.
- * If the parameter is empty or omitted, the SSL options will be reset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set SSL options. */
PHP_METHOD(HttpRequest, setSslOptions)
{
http_request_object_set_options_subr("ssl", 1, 0);
/* }}} */
/* {{{ proto bool HttpRequest::addSslOptions(array options)
- *
- * Set additional SSL options.
- *
- * Expects an associative array as parameter containing additional SSL specific options.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set additional SSL options. */
PHP_METHOD(HttpRequest, addSslOptions)
{
http_request_object_set_options_subr("ssl", 0, 0);
/* }}} */
/* {{{ proto array HttpRequest::getSslOtpions()
- *
- * Get previously set SSL options.
- *
- * Returns an associative array containing any previously set SSL options.
- */
+ Get previously set SSL options. */
PHP_METHOD(HttpRequest, getSslOptions)
{
http_request_object_get_options_subr("ssl");
/* }}} */
/* {{{ proto bool HttpRequest::addHeaders(array headers)
- *
- * Add request header name/value pairs.
- *
- * Expects an associative array as parameter containing additional header
- * name/value pairs.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Add request header name/value pairs. */
PHP_METHOD(HttpRequest, addHeaders)
{
http_request_object_set_options_subr("headers", 0, 1);
}
/* {{{ proto bool HttpRequest::setHeaders([array headers])
- *
- * Set request header name/value pairs.
- *
- * Accepts an associative array as parameter containing header name/value pairs.
- * If the parameter is empty or omitted, all previously set headers will be unset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set request header name/value pairs. */
PHP_METHOD(HttpRequest, setHeaders)
{
http_request_object_set_options_subr("headers", 1, 1);
/* }}} */
/* {{{ proto array HttpRequest::getHeaders()
- *
- * Get previously set request headers.
- *
- * Returns an associative array containing all currently set headers.
- */
+ Get previously set request headers. */
PHP_METHOD(HttpRequest, getHeaders)
{
http_request_object_get_options_subr("headers");
/* }}} */
/* {{{ proto bool HttpRequest::setCookies([array cookies])
- *
- * Set cookies.
- *
- * Accepts an associative array as parameter containing cookie name/value pairs.
- * If the parameter is empty or omitted, all previously set cookies will be unset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set cookies. */
PHP_METHOD(HttpRequest, setCookies)
{
http_request_object_set_options_subr("cookies", 1, 0);
/* }}} */
/* {{{ proto bool HttpRequest::addCookies(array cookies)
- *
- * Add cookies.
- *
- * Expects an associative array as parameter containing any cookie name/value
- * pairs to add.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Add cookies. */
PHP_METHOD(HttpRequest, addCookies)
{
http_request_object_set_options_subr("cookies", 0, 0);
/* }}} */
/* {{{ proto array HttpRequest::getCookies()
- *
- * Get previously set cookies.
- *
- * Returns an associative array containing any previously set cookies.
- */
+ Get previously set cookies. */
PHP_METHOD(HttpRequest, getCookies)
{
http_request_object_get_options_subr("cookies");
/* }}} */
/* {{{ proto bool HttpRequest::enableCookies()
- *
- * Enable automatic sending of received cookies.
- * Note that cuutomly set cookies will be sent anyway.
- */
+ Enable automatic sending of received cookies. Note that customly set cookies will be sent anyway. */
PHP_METHOD(HttpRequest, enableCookies)
{
NO_ARGS {
/* }}} */
/* {{{ proto bool HttpRequest::resetCookies([bool session_only = FALSE])
- *
- * Reset all automatically received/sent cookies.
- * Note that customly set cookies are not affected.
- *
- * Accepts an optional bool parameter specifying
- * whether only session cookies should be reset
- * (needs libcurl >= v7.15.4, else libcurl >= v7.14.1).
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Reset all automatically received/sent cookies. Note that customly set cookies are not affected. */
PHP_METHOD(HttpRequest, resetCookies)
{
zend_bool session_only = 0;
/* }}} */
/* {{{ proto bool HttpRequest::setUrl(string url)
- *
- * Set the request URL.
- *
- * Expects a string as parameter specifying the request url.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set the request URL. */
PHP_METHOD(HttpRequest, setUrl)
{
char *URL = NULL;
/* }}} */
/* {{{ proto string HttpRequest::getUrl()
- *
- * Get the previously set request URL.
- *
- * Returns the currently set request url as string.
- */
+ Get the previously set request URL. */
PHP_METHOD(HttpRequest, getUrl)
{
NO_ARGS;
/* }}} */
/* {{{ proto bool HttpRequest::setMethod(int request_method)
- *
- * Set the request method.
- *
- * Expects an int as parameter specifying the request method to use.
- * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set the request method. */
PHP_METHOD(HttpRequest, setMethod)
{
long meth;
/* }}} */
/* {{{ proto int HttpRequest::getMethod()
- *
- * Get the previously set request method.
- *
- * Returns the currently set request method.
- */
+ Get the previously set request method. */
PHP_METHOD(HttpRequest, getMethod)
{
NO_ARGS;
/* }}} */
/* {{{ proto bool HttpRequest::setContentType(string content_type)
- *
- * Set the content type the post request should have.
- *
- * Expects a string as parameters containing the content type of the request
- * (primary/secondary).
- *
- * Returns TRUE on success, or FALSE if the content type does not seem to
- * contain a primary and a secondary part.
- */
+ Set the content type the post request should have. */
PHP_METHOD(HttpRequest, setContentType)
{
char *ctype;
/* }}} */
/* {{{ proto string HttpRequest::getContentType()
- *
- * Get the previously content type.
- *
- * Returns the previously set content type as string.
- */
+ Get the previously content type. */
PHP_METHOD(HttpRequest, getContentType)
{
NO_ARGS;
/* }}} */
/* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
- *
- * Set the URL query parameters to use, overwriting previously set query parameters.
- * Affects any request types.
- *
- * Accepts a string or associative array parameter containing the pre-encoded
- * query string or to be encoded query fields. If the parameter is empty or
- * omitted, the query data will be unset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set the URL query parameters to use, overwriting previously set query parameters. */
PHP_METHOD(HttpRequest, setQueryData)
{
zval *qdata = NULL;
/* }}} */
/* {{{ proto string HttpRequest::getQueryData()
- *
- * Get the current query data in form of an urlencoded query string.
- *
- * Returns a string containing the urlencoded query.
- */
+ Get the current query data in form of an urlencoded query string. */
PHP_METHOD(HttpRequest, getQueryData)
{
NO_ARGS;
/* }}} */
/* {{{ proto bool HttpRequest::addQueryData(array query_params)
- *
- * Add parameters to the query parameter list, leaving previously set unchanged.
- * Affects any request type.
- *
- * Expects an associative array as parameter containing the query fields to add.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Add parameters to the query parameter list, leaving previously set unchanged. */
PHP_METHOD(HttpRequest, addQueryData)
{
zval *qdata, *old_qdata;
/* }}} */
/* {{{ proto bool HttpRequest::addPostFields(array post_data)
- *
- * Adds POST data entries, leaving previously set unchanged, unless a
- * post entry with the same name already exists.
- * Affects only POST and custom requests.
- *
- * Expects an associative array as parameter containing the post fields.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Adds POST data entries, leaving previously set unchanged, unless a post entry with the same name already exists. */
PHP_METHOD(HttpRequest, addPostFields)
{
zval *post_data, *old_post, *new_post;
array_init(new_post);
old_post = GET_PROP(postFields);
if (Z_TYPE_P(old_post) == IS_ARRAY) {
- array_copy(old_post, new_post);
+ array_copy(Z_ARRVAL_P(old_post), Z_ARRVAL_P(new_post));
}
- array_merge(post_data, new_post);
+ array_join(Z_ARRVAL_P(post_data), Z_ARRVAL_P(new_post), 0, 0);
SET_PROP(postFields, new_post);
zval_ptr_dtor(&new_post);
}
/* }}} */
/* {{{ proto bool HttpRequest::setPostFields([array post_data])
- *
- * Set the POST data entries, overwriting previously set POST data.
- * Affects only POST and custom requests.
- *
- * Accepts an associative array as parameter containing the post fields.
- * If the parameter is empty or omitted, the post data will be unset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set the POST data entries, overwriting previously set POST data. */
PHP_METHOD(HttpRequest, setPostFields)
{
zval *post, *post_data = NULL;
MAKE_STD_ZVAL(post);
array_init(post);
if (post_data && zend_hash_num_elements(Z_ARRVAL_P(post_data))) {
- array_copy(post_data, post);
+ array_copy(Z_ARRVAL_P(post_data), Z_ARRVAL_P(post));
}
SET_PROP(postFields, post);
zval_ptr_dtor(&post);
/* }}}*/
/* {{{ proto array HttpRequest::getPostFields()
- *
- * Get previously set POST data.
- *
- * Returns the currently set post fields as associative array.
- */
+ Get previously set POST data. */
PHP_METHOD(HttpRequest, getPostFields)
{
NO_ARGS;
}
/* }}} */
-/* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
- *
- * Set raw post data to send, overwriting previously set raw post data. Don't
- * forget to specify a content type. Affects only POST and custom requests.
- * Only either post fields or raw post data can be used for each request.
- * Raw post data has higher precedence and will be used even if post fields
- * are set.
- *
- * Accepts a string as parameter containing the *raw* post data.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
-PHP_METHOD(HttpRequest, setRawPostData)
+/* {{{ proto bool HttpRequest::setBody([string request_body_data])
+ Set request body to send, overwriting previously set request body. Don't forget to specify a content type. */
+PHP_METHOD(HttpRequest, setBody)
{
char *raw_data = NULL;
int data_len = 0;
raw_data = "";
}
- UPD_STRL(rawPostData, raw_data, data_len);
+ UPD_STRL(requestBody, raw_data, data_len);
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
- *
- * Add raw post data, leaving previously set raw post data unchanged.
- * Affects only POST and custom requests.
- *
- * Expects a string as parameter containing the raw post data to concatenate.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
-PHP_METHOD(HttpRequest, addRawPostData)
+/* {{{ proto bool HttpRequest::addBody(string request_body_data)
+ Add request body data, leaving previously set request body data unchanged. */
+PHP_METHOD(HttpRequest, addBody)
{
char *raw_data;
int data_len;
}
if (data_len) {
- zval *data = GET_PROP(rawPostData);
+ zval *data = GET_PROP(rrequestBody);
if (Z_STRLEN_P(data)) {
Z_STRVAL_P(data) = erealloc(Z_STRVAL_P(data), (Z_STRLEN_P(data) += data_len) + 1);
}
/* }}} */
-/* {{{ proto string HttpRequest::getRawPostData()
- *
- * Get previously set raw post data.
- *
- * Returns a string containing the currently set raw post data.
- */
-PHP_METHOD(HttpRequest, getRawPostData)
+/* {{{ proto string HttpRequest::getBody()
+ Get previously set request body data. */
+PHP_METHOD(HttpRequest, getBody)
{
NO_ARGS;
if (return_value_used) {
- RETURN_PROP(rawPostData);
+ RETURN_PROP(requestBody);
}
}
/* }}} */
/* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
- *
- * Add a file to the POST request, leaving previously set files unchanged.
- * Affects only POST and custom requests. Cannot be used with raw post data.
- *
- * Expects a string parameter containing the form element name, and a string
- * paremeter containing the path to the file which should be uploaded.
- * Additionally accepts an optional string parameter which should contain
- * the content type of the file.
- *
- * Returns TRUE on success, or FALSE if the content type seems not to contain a
- * primary and a secondary content type part.
- */
+ Add a file to the POST request, leaving previously set files unchanged. */
PHP_METHOD(HttpRequest, addPostFile)
{
zval *entry, *old_post, *new_post;
array_init(new_post);
old_post = GET_PROP(postFiles);
if (Z_TYPE_P(old_post) == IS_ARRAY) {
- array_copy(old_post, new_post);
+ array_copy(Z_ARRVAL_P(old_post), Z_ARRVAL_P(new_post));
}
add_next_index_zval(new_post, entry);
SET_PROP(postFiles, new_post);
/* }}} */
/* {{{ proto bool HttpRequest::setPostFiles([array post_files])
- *
- * Set files to post, overwriting previously set post files.
- * Affects only POST and requests. Cannot be used with raw post data.
- *
- * Accepts an array containing the files to post. Each entry should be an
- * associative array with "name", "file" and "type" keys. If the parameter
- * is empty or omitted the post files will be unset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set files to post, overwriting previously set post files. */
PHP_METHOD(HttpRequest, setPostFiles)
{
zval *files = NULL, *post;
MAKE_STD_ZVAL(post);
array_init(post);
if (files && (Z_TYPE_P(files) == IS_ARRAY)) {
- array_copy(files, post);
+ array_copy(Z_ARRVAL_P(files), Z_ARRVAL_P(post));
}
SET_PROP(postFiles, post);
zval_ptr_dtor(&post);
/* }}} */
/* {{{ proto array HttpRequest::getPostFiles()
- *
- * Get all previously added POST files.
- *
- * Returns an array containing currently set post files.
- */
+ Get all previously added POST files. */
PHP_METHOD(HttpRequest, getPostFiles)
{
NO_ARGS;
/* }}} */
/* {{{ proto bool HttpRequest::setPutFile([string file])
- *
- * Set file to put. Affects only PUT requests.
- *
- * Accepts a string as parameter referencing the path to file.
- * If the parameter is empty or omitted the put file will be unset.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set file to put. Affects only PUT requests. */
PHP_METHOD(HttpRequest, setPutFile)
{
char *file = "";
/* }}} */
/* {{{ proto string HttpRequest::getPutFile()
- *
- * Get previously set put file.
- *
- * Returns a string containing the path to the currently set put file.
- */
+ Get previously set put file. */
PHP_METHOD(HttpRequest, getPutFile)
{
NO_ARGS;
/* }}} */
/* {{{ proto bool HttpRequest::setPutData([string put_data])
- *
- * Set PUT data to send, overwriting previously set PUT data.
- * Affects only PUT requests.
- * Only either PUT data or PUT file can be used for each request.
- * PUT data has higher precedence and will be used even if a PUT
- * file is set.
- *
- * Accepts a string as parameter containing the data to upload.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Set PUT data to send, overwriting previously set PUT data. */
PHP_METHOD(HttpRequest, setPutData)
{
char *put_data = NULL;
/* }}} */
/* {{{ proto bool HttpRequest::addPutData(string put_data)
- *
- * Add PUT data, leaving previously set PUT data unchanged.
- * Affects only PUT requests.
- *
- * Expects a string as parameter containing the data to concatenate.
- *
- * Returns TRUE on success, or FALSE on failure.
- */
+ Add PUT data, leaving previously set PUT data unchanged. */
PHP_METHOD(HttpRequest, addPutData)
{
char *put_data;
/* }}} */
/* {{{ proto string HttpRequest::getPutData()
- *
- * Get previously set PUT data.
- *
- * Returns a string containing the currently set raw post data.
- */
+ Get previously set PUT data. */
PHP_METHOD(HttpRequest, getPutData)
{
NO_ARGS;
/* }}} */
/* {{{ proto array HttpRequest::getResponseData()
- *
- * Get all response data after the request has been sent.
- *
- * Returns an associative array with the key "headers" containing an associative
- * array holding all response headers, as well as the key "body" containing a
- * string with the response body.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response.
- */
+ Get all response data after the request has been sent. */
PHP_METHOD(HttpRequest, getResponseData)
{
NO_ARGS;
if (return_value_used) {
- RETURN_PROP(responseData);
+ char *body;
+ size_t body_len;
+ zval *headers, *message = GET_PROP(responseMessage);
+
+ if (Z_TYPE_P(message) == IS_OBJECT) {
+ getObjectEx(http_message_object, msg, message);
+
+ array_init(return_value);
+
+ MAKE_STD_ZVAL(headers);
+ array_init(headers);
+ zend_hash_copy(Z_ARRVAL_P(headers), &msg->message->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
+ add_assoc_zval(return_value, "headers", headers);
+
+ phpstr_data(PHPSTR(msg->message), &body, &body_len);
+ add_assoc_stringl(return_value, "body", body, body_len, 0);
+ }
}
}
/* }}} */
/* {{{ proto mixed HttpRequest::getResponseHeader([string name])
- *
- * Get response header(s) after the request has been sent.
- *
- * Accepts an string as optional parameter specifying a certain header to read.
- * If the parameter is empty or omitted all response headers will be returned.
- *
- * Returns either a string with the value of the header matching name if requested,
- * FALSE on failure, or an associative array containing all response headers.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response.
- */
+ Get response header(s) after the request has been sent. */
PHP_METHOD(HttpRequest, getResponseHeader)
{
if (return_value_used) {
- zval *data, **headers, **header;
+ zval *header;
char *header_name = NULL;
int header_len = 0;
- if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &header_name, &header_len)) {
- RETURN_FALSE;
- }
-
- data = GET_PROP(responseData);
- if ( (Z_TYPE_P(data) == IS_ARRAY) &&
- (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "headers", sizeof("headers"), (void *) &headers)) &&
- (Z_TYPE_PP(headers) == IS_ARRAY)) {
- if (!header_len || !header_name) {
- RETVAL_ZVAL(*headers, 1, 0);
- } else if (SUCCESS == zend_hash_find(Z_ARRVAL_PP(headers), pretty_key(header_name, header_len, 1, 1), header_len + 1, (void *) &header)) {
- RETVAL_ZVAL(*header, 1, 0);
- } else {
- RETVAL_FALSE;
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &header_name, &header_len)) {
+ zval *message = GET_PROP(responseMessage);
+
+ if (Z_TYPE_P(message) == IS_OBJECT) {
+ getObjectEx(http_message_object, msg, message);
+
+ if (header_len) {
+ if ((header = http_message_header_ex(msg->message, pretty_key(header_name, header_len, 1, 1), header_len + 1, 0))) {
+ RETURN_ZVAL(header, 1, 1);
+ }
+ } else {
+ array_init(return_value);
+ zend_hash_copy(Z_ARRVAL_P(return_value), &msg->message->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
+ return;
+ }
}
- } else {
- RETVAL_FALSE;
}
+ RETURN_FALSE;
}
}
/* }}} */
/* {{{ proto array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])
- *
- * Get response cookie(s) after the request has been sent.
- *
- * Returns an array of stdClass objects like http_parse_cookie would return.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response.
- */
+ Get response cookie(s) after the request has been sent. */
PHP_METHOD(HttpRequest, getResponseCookies)
{
if (return_value_used) {
long flags = 0;
- zval *allowed_extras_array = NULL, *data, **headers;
-
- if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|la", &flags, &allowed_extras_array)) {
- RETURN_FALSE;
- }
-
- data = GET_PROP(responseData);
- if ( (Z_TYPE_P(data) == IS_ARRAY) &&
- (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "headers", sizeof("headers"), (void *) &headers)) &&
- (Z_TYPE_PP(headers) == IS_ARRAY)) {
+ zval *allowed_extras_array = NULL;
+
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|la!", &flags, &allowed_extras_array)) {
int i = 0;
- ulong idx = 0;
- char *key = NULL, **allowed_extras = NULL;
- zval **header = NULL, **entry = NULL;
+ HashKey key = initHashKey(0);
+ char **allowed_extras = NULL;
+ zval **header = NULL, **entry = NULL, *message = GET_PROP(responseMessage);
HashPosition pos, pos1, pos2;
- array_init(return_value);
-
- if (allowed_extras_array) {
- allowed_extras = ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array)) + 1, sizeof(char *));
- FOREACH_VAL(pos, allowed_extras_array, entry) {
- ZVAL_ADDREF(*entry);
- convert_to_string_ex(entry);
- allowed_extras[i++] = estrndup(Z_STRVAL_PP(entry), Z_STRLEN_PP(entry));
- zval_ptr_dtor(entry);
+ if (Z_TYPE_P(message) == IS_OBJECT) {
+ getObjectEx(http_message_object, msg, message);
+
+ array_init(return_value);
+
+ if (allowed_extras_array) {
+ allowed_extras = ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array)) + 1, sizeof(char *));
+ FOREACH_VAL(pos, allowed_extras_array, entry) {
+ ZVAL_ADDREF(*entry);
+ convert_to_string_ex(entry);
+ allowed_extras[i++] = estrndup(Z_STRVAL_PP(entry), Z_STRLEN_PP(entry));
+ zval_ptr_dtor(entry);
+ }
}
- }
-
- FOREACH_HASH_KEYVAL(pos1, Z_ARRVAL_PP(headers), key, idx, header) {
- if (key && !strcasecmp(key, "Set-Cookie")) {
- http_cookie_list list;
-
- if (Z_TYPE_PP(header) == IS_ARRAY) {
- zval **single_header;
+
+ FOREACH_HASH_KEYVAL(pos1, &msg->message->hdrs, key, header) {
+ if (key.type == HASH_KEY_IS_STRING && !strcasecmp(key.str, "Set-Cookie")) {
+ http_cookie_list list;
- FOREACH_VAL(pos2, *header, single_header) {
- ZVAL_ADDREF(*single_header);
- convert_to_string_ex(single_header);
- if (http_parse_cookie_ex(&list, Z_STRVAL_PP(single_header), flags, allowed_extras)) {
+ if (Z_TYPE_PP(header) == IS_ARRAY) {
+ zval **single_header;
+
+ FOREACH_VAL(pos2, *header, single_header) {
+ ZVAL_ADDREF(*single_header);
+ convert_to_string_ex(single_header);
+ if (http_parse_cookie_ex(&list, Z_STRVAL_PP(single_header), flags, allowed_extras)) {
+ zval *cookie;
+
+ MAKE_STD_ZVAL(cookie);
+ object_init(cookie);
+ http_cookie_list_tostruct(&list, cookie);
+ add_next_index_zval(return_value, cookie);
+ http_cookie_list_dtor(&list);
+ }
+ zval_ptr_dtor(single_header);
+ }
+ } else {
+ ZVAL_ADDREF(*header);
+ convert_to_string_ex(header);
+ if (http_parse_cookie_ex(&list, Z_STRVAL_PP(header), flags, allowed_extras)) {
zval *cookie;
MAKE_STD_ZVAL(cookie);
add_next_index_zval(return_value, cookie);
http_cookie_list_dtor(&list);
}
- zval_ptr_dtor(single_header);
+ zval_ptr_dtor(header);
}
- } else {
- ZVAL_ADDREF(*header);
- convert_to_string_ex(header);
- if (http_parse_cookie_ex(&list, Z_STRVAL_PP(header), flags, allowed_extras)) {
- zval *cookie;
-
- MAKE_STD_ZVAL(cookie);
- object_init(cookie);
- http_cookie_list_tostruct(&list, cookie);
- add_next_index_zval(return_value, cookie);
- http_cookie_list_dtor(&list);
- }
- zval_ptr_dtor(header);
}
}
- /* reset key */
- key = NULL;
- }
-
- if (allowed_extras) {
- for (i = 0; allowed_extras[i]; ++i) {
- efree(allowed_extras[i]);
+
+ if (allowed_extras) {
+ for (i = 0; allowed_extras[i]; ++i) {
+ efree(allowed_extras[i]);
+ }
+ efree(allowed_extras);
}
- efree(allowed_extras);
+
+ return;
}
- } else {
- RETURN_FALSE;
}
+ RETURN_FALSE;
}
}
/* }}} */
/* {{{ proto string HttpRequest::getResponseBody()
- *
- * Get the response body after the request has been sent.
- *
- * Returns a string containing the response body.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response.
- */
+ Get the response body after the request has been sent. */
PHP_METHOD(HttpRequest, getResponseBody)
{
NO_ARGS;
if (return_value_used) {
- zval **body;
- zval *data = GET_PROP(responseData);
+ zval *message = GET_PROP(responseMessage);
- if ( (Z_TYPE_P(data) == IS_ARRAY) &&
- (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "body", sizeof("body"), (void *) &body))) {
- RETURN_ZVAL(*body, 1, 0);
+ if (Z_TYPE_P(message) == IS_OBJECT) {
+ getObjectEx(http_message_object, msg, message);
+ RETURN_PHPSTR_DUP(&msg->message->body);
} else {
RETURN_FALSE;
}
/* }}} */
/* {{{ proto int HttpRequest::getResponseCode()
- *
- * Get the response code after the request has been sent.
- *
- * Returns an int representing the response code.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response.
- */
+ Get the response code after the request has been sent. */
PHP_METHOD(HttpRequest, getResponseCode)
{
NO_ARGS;
/* }}} */
/* {{{ proto string HttpRequest::getResponseStatus()
- *
- * Get the response status (i.e. the string after the response code) after the message has been sent.
- *
- * Returns a string containing the response status text.
- */
+ Get the response status (i.e. the string after the response code) after the message has been sent. */
PHP_METHOD(HttpRequest, getResponseStatus)
{
NO_ARGS;
/* }}} */
/* {{{ proto mixed HttpRequest::getResponseInfo([string name])
- *
- * Get response info after the request has been sent.
- * See http_get() for a full list of returned info.
- *
- * Accepts a string as optional parameter specifying the info to read.
- * If the parameter is empty or omitted, an associative array containing
- * all available info will be returned.
- *
- * Returns either a scalar containing the value of the info matching name if
- * requested, FALSE on failure, or an associative array containing all
- * available info.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response.
- */
+ Get response info after the request has been sent. */
PHP_METHOD(HttpRequest, getResponseInfo)
{
if (return_value_used) {
/* }}}*/
/* {{{ proto HttpMessage HttpRequest::getResponseMessage()
- *
- * Get the full response as HttpMessage object after the request has been sent.
- *
- * Returns an HttpMessage object of the response.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response. Use HttpMessage::getParentMessage()
- * to access the data of previously received responses within this request
- * cycle.
- *
- * Throws HttpException, HttpRuntimeException.
- */
+ Get the full response as HttpMessage object after the request has been sent. */
PHP_METHOD(HttpRequest, getResponseMessage)
{
NO_ARGS {
/* }}} */
/* {{{ proto HttpMessage HttpRequest::getRequestMessage()
- *
- * Get sent HTTP message.
- *
- * Returns an HttpMessage object representing the sent request.
- *
- * If redirects were allowed and several responses were received, the data
- * references the last received response. Use HttpMessage::getParentMessage()
- * to access the data of previously sent requests within this request
- * cycle.
- *
- * Note that the internal request message is immutable, that means that the
- * request message received through HttpRequest::getRequestMessage() will
- * always look the same for the same request, regardless of any changes you
- * may have made to the returned object.
- *
- * Throws HttpMalformedHeadersException, HttpEncodingException.
- */
+ Get sent HTTP message. */
PHP_METHOD(HttpRequest, getRequestMessage)
{
NO_ARGS;
/* }}} */
/* {{{ proto string HttpRequest::getRawRequestMessage()
- *
- * Get sent HTTP message.
- *
- * Returns an HttpMessage in a form of a string
- */
+ Get sent HTTP message. */
PHP_METHOD(HttpRequest, getRawRequestMessage)
{
NO_ARGS;
/* }}} */
/* {{{ proto string HttpRequest::getRawResponseMessage()
- *
- * Get the entire HTTP response.
- *
- * Returns the complete web server response, including the headers in a form of a string.
- */
+ Get the entire HTTP response. */
PHP_METHOD(HttpRequest, getRawResponseMessage)
{
NO_ARGS;
/* }}} */
/* {{{ proto HttpMessage HttpRequest::getHistory()
- *
- * Get all sent requests and received responses as an HttpMessage object.
- *
- * If you want to record history, set the instance variable
- * HttpRequest::$recordHistory to TRUE.
- *
- * Returns an HttpMessage object representing the complete request/response
- * history.
- *
- * The object references the last received response, use HttpMessage::getParentMessage()
- * to access the data of previously sent requests and received responses.
- *
- * Throws HttpRuntimeException.
- */
+ Get all sent requests and received responses as an HttpMessage object. */
PHP_METHOD(HttpRequest, getHistory)
{
NO_ARGS;
/* }}} */
/* {{{ proto void HttpRequest::clearHistory()
- *
- * Clear the history.
- */
+ Clear the history. */
PHP_METHOD(HttpRequest, clearHistory)
{
NO_ARGS {
/* }}} */
/* {{{ proto HttpMessage HttpRequest::send()
- *
- * Send the HTTP request.
- *
- * Returns the received response as HttpMessage object.
- *
- * NOTE: While an exception may be thrown, the transfer could have succeeded
- * at least partially, so you might want to check the return values of various
- * HttpRequest::getResponse*() methods.
- *
- * Throws HttpRuntimeException, HttpRequestException,
- * HttpMalformedHeaderException, HttpEncodingException.
- *
- * GET example:
- * <pre>
- * <?php
- * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
- * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
- * $r->addQueryData(array('category' => 3));
- * try {
- * $r->send();
- * if ($r->getResponseCode() == 200) {
- * file_put_contents('local.rss', $r->getResponseBody());
- * }
- * } catch (HttpException $ex) {
- * echo $ex;
- * }
- * ?>
- * </pre>
- *
- * POST example:
- * <pre>
- * <?php
- * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
- * $r->setOptions(array('cookies' => array('lang' => 'de')));
- * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
- * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
- * try {
- * echo $r->send()->getBody();
- * } catch (HttpException $ex) {
- * echo $ex;
- * }
- * ?>
- * </pre>
- */
+ Send the HTTP request. */
PHP_METHOD(HttpRequest, send)
{
getObject(http_request_object, obj);