From 4a0ca822a0aadf25a2e0771ee0a86570ff72ccff Mon Sep 17 00:00:00 2001 From: Justin Martin Date: Sat, 7 Jan 2012 19:55:57 +0000 Subject: [PATCH] Documented deprecation of setRawPostData method, which is now aliased to setBody. Closes bug #58935. Added setBody method documentation. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@321879 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/http/HttpRequest/setBody.xml | 85 +++++++++++++++++++ reference/http/HttpRequest/setRawPostData.xml | 14 ++- 2 files changed, 95 insertions(+), 4 deletions(-) create mode 100644 reference/http/HttpRequest/setBody.xml diff --git a/reference/http/HttpRequest/setBody.xml b/reference/http/HttpRequest/setBody.xml new file mode 100644 index 0000000000..ee761f7906 --- /dev/null +++ b/reference/http/HttpRequest/setBody.xml @@ -0,0 +1,85 @@ + + + + + HttpRequest::setBody + Set request body to send, overwriting previously set request body. + + + + &reftitle.description; + + boolHttpRequest::setBody + stringrequest_body_data + + + Set request body to send, overwriting previously set request body. + + + + + &reftitle.parameters; + + + + request_body_data + + + The request body to overwrite the existing request body with. + + Ensure that a Content-Type is specified in the request body. + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.notes; + + + This method was previously available as + HttpRequest::setRawPostData. + + + + + + &reftitle.seealso; + + + HttpRequest::setRawPostData + + + + + + diff --git a/reference/http/HttpRequest/setRawPostData.xml b/reference/http/HttpRequest/setRawPostData.xml index c40ad84fca..15057d50d3 100644 --- a/reference/http/HttpRequest/setRawPostData.xml +++ b/reference/http/HttpRequest/setRawPostData.xml @@ -23,6 +23,15 @@ Raw post data has higher precedence and will be used even if post fields are set. + + + + This function alias is DEPRECATED and only + exists for backwards compatibility reasons. The use of this function + is not recommended, as it may be removed from PHP in the future. + HttpRequest::setBody should be used instead. + + @@ -114,17 +123,14 @@ Use the PEAR Coding Standards --> -