From 8148b7c32f160cbe2cdc37e7271ac62aa2133b7c Mon Sep 17 00:00:00 2001
From: friendica <info@friendica.com>
Date: Wed, 27 Mar 2013 19:02:01 -0700
Subject: update manage table and some documentation

---
 include/network.php | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

(limited to 'include/network.php')

diff --git a/include/network.php b/include/network.php
index 9d7ae8497..427519c7a 100644
--- a/include/network.php
+++ b/include/network.php
@@ -10,6 +10,7 @@ function get_capath() {
 
 // curl wrapper. If binary flag is true, return binary
 // results. 
+
 /**
  * fetch_url is deprecated and being replaced by the more capable z_fetch_url
  * please use that function instead.
@@ -204,6 +205,26 @@ function post_url($url,$params, $headers = null, &$redirects = 0, $timeout = 0)
 	return($body);
 }
 
+/**
+ * @function z_fetch_url
+ * @param string $url
+ *    URL to fetch
+ * @param boolean $binary = false
+ *    TRUE if asked to return binary results (file download)
+ * @param int $redirects = 0
+ *    internal use, recursion counter
+ * @param array $opts (optional parameters)
+ *    'accept_content' => supply Accept: header with 'accept_content' as the value
+ *    'timeout' => int seconds, default system config value or 60 seconds
+ *    'http_auth' => username:password
+ *    'novalidate' => do not validate SSL certs, default is to validate using our CA list
+ *    
+ * @returns array
+ *    'return_code' => HTTP return code or 0 if timeout or failure
+ *    'success' => boolean true (if HTTP 2xx result) or false
+ *    'header' => HTTP headers
+ *    'body' => fetched content
+ */
 
 function z_fetch_url($url, $binary = false, $redirects = 0, $opts = array()) {
 
@@ -421,7 +442,15 @@ function xml_status($st, $message = '') {
 	killme();
 }
 
-
+/**
+ * @function http_status_exit
+ * 
+ * Send HTTP status header and exit
+ * @param int $val
+ *    integer HTTP status result value
+ *
+ * @returns (does not return, process is terminated)
+ */
 
 function http_status_exit($val) {
 
-- 
cgit v1.2.3