- add http_put_data() and HttpRequest::(set|get|add)PutData()
[m6w6/ext-http] / docs / functions.html
index 02b48406b0cbcfd56f95dc0ab6bb3dd104e4d8f7..148840804190bed8a03cf26a4e58d0f17ba34391 100644 (file)
@@ -386,7 +386,12 @@ See http_get() for a full list of available options.</p>
 <p>Expects the second parameter to be a resource referencing an already <br />
 opened stream, from which the data to upload should be read.<br />
 See http_get() for a full list of available options.</p>
-<p>Returns the HTTP response(s) as string on success. or FALSE on failure.</p>
+<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
+<h2 id="http_put_data">string http_put_data(string url, string data[, array options[, array &info]])</h2>
+<p>Performs an HTTP PUT request on the supplied url.</p>
+<p>Expects the second parameter to be a string containing the data to upload.<br />
+See http_get() for a full list of available options.</p>
+<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
 <h2 id="http_request_method_register">int http_request_method_register(string method)</h2>
 <p>Register a custom request method.</p>
 <p>Expects a string parameter containing the request method name to register.</p>
@@ -777,6 +782,22 @@ If the parameter is empty or omitted the put file will be unset.</p>
 <h3 id="HttpRequest_getPutFile">string HttpRequest::getPutFile()</h3>
 <p>Get previously set put file.</p>
 <p>Returns a string containing the path to the currently set put file.</p>
+<h3 id="HttpRequest_setPutData">bool HttpRequest::setPutData([string put_data])</h3>
+<p>Set PUT data to send, overwriting previously set PUT data.<br />
+Affects only PUT requests.<br />
+Only either PUT data or PUT file can be used for each request.<br />
+PUT data has higher precedence and will be used even if a PUT<br />
+file is set.  </p>
+<p>Accepts a string as parameter containing the data to upload.</p>
+<p>Returns TRUE on success, or FALSE on failure.</p>
+<h3 id="HttpRequest_addPutData">bool HttpRequest::addPutData(string put_data)</h3>
+<p>Add PUT data, leaving previously set PUT data unchanged.<br />
+Affects only PUT requests.</p>
+<p>Expects a string as parameter containing the data to concatenate.</p>
+<p>Returns TRUE on success, or FALSE on failure.</p>
+<h3 id="HttpRequest_getPutData">string HttpRequest::getPutData()</h3>
+<p>Get previously set PUT data.</p>
+<p>Returns a string containing the currently set raw post data.</p>
 <h3 id="HttpRequest_getResponseData">array HttpRequest::getResponseData()</h3>
 <p>Get all response data after the request has been sent.</p>
 <p>Returns an associative array with the key "headers" containing an associative<br />
@@ -1171,6 +1192,8 @@ http.cache_log is set.</p>
 </li>
 <li><a href="#http_put_stream">http_put_stream</a>
 </li>
+<li><a href="#http_put_data">http_put_data</a>
+</li>
 <li><a href="#http_request_method_register">http_request_method_register</a>
 </li>
 <li><a href="#http_request_method_unregister">http_request_method_unregister</a>
@@ -1295,6 +1318,9 @@ http.cache_log is set.</p>
 <li><a href="#HttpRequest_getPostFiles">HttpRequest::getPostFiles()</a></li>
 <li><a href="#HttpRequest_setPutFile">HttpRequest::setPutFile()</a></li>
 <li><a href="#HttpRequest_getPutFile">HttpRequest::getPutFile()</a></li>
+<li><a href="#HttpRequest_setPutData">HttpRequest::setPutData()</a></li>
+<li><a href="#HttpRequest_addPutData">HttpRequest::addPutData()</a></li>
+<li><a href="#HttpRequest_getPutData">HttpRequest::getPutData()</a></li>
 <li><a href="#HttpRequest_getResponseData">HttpRequest::getResponseData()</a></li>
 <li><a href="#HttpRequest_getResponseHeader">HttpRequest::getResponseHeader()</a></li>
 <li><a href="#HttpRequest_getResponseCookies">HttpRequest::getResponseCookies()</a></li>
@@ -1369,7 +1395,7 @@ http.cache_log is set.</p>
 </li>
 </ul>
 </div>
-    <p><b>Generated at: Mon, 20 Feb 2006 17:41:32 +0100</b></p>
+    <p><b>Generated at: Fri, 24 Feb 2006 21:29:29 +0100</b></p>
 </body>
 </html>