From 4a0ca822a0aadf25a2e0771ee0a86570ff72ccff Mon Sep 17 00:00:00 2001
From: Justin Martin <frozenfire@php.net>
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 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision:$ -->
+<refentry xml:id="function.httprequest-setbody" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>HttpRequest::setBody</refname>
+  <refpurpose>Set request body to send, overwriting previously set request body.</refpurpose>
+ </refnamediv>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>HttpRequest::setBody</methodname>
+   <methodparam choice="opt"><type>string</type><parameter>request_body_data</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Set request body to send, overwriting previously set request body.
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>request_body_data</parameter></term>
+     <listitem>
+      <para>
+       The request body to overwrite the existing request body with.
+       <caution>
+        <simpara>Ensure that a Content-Type is specified in the request body.</simpara>
+       </caution>
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="notes">
+  &reftitle.notes;
+  <caution>
+   <para>
+    This method was previously available as
+    <function>HttpRequest::setRawPostData</function>.
+   </para>
+  </caution>
+ </refsect1>
+ 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>HttpRequest::setRawPostData</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
+ 
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
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.
   </para>
+  
+  <warning>
+   <simpara>
+    This function alias is <emphasis>DEPRECATED</emphasis> 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.
+    <function>HttpRequest::setBody</function> should be used instead.
+   </simpara>
+  </warning>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -114,17 +123,14 @@ Use the PEAR Coding Standards
  -->
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>HttpRequest::setBody</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>