From b69fca14e76a2f5db0cd0924fe5e7056e94771b1 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 26 Feb 2013 15:49:37 -0800 Subject: initial doco --- doc/html/include_2network_8php.html | 894 ++++++++++++++++++++++++++++++++++++ 1 file changed, 894 insertions(+) create mode 100644 doc/html/include_2network_8php.html (limited to 'doc/html/include_2network_8php.html') diff --git a/doc/html/include_2network_8php.html b/doc/html/include_2network_8php.html new file mode 100644 index 000000000..53778c2aa --- /dev/null +++ b/doc/html/include_2network_8php.html @@ -0,0 +1,894 @@ + + + + + + +The Red Project: include/network.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Project +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
network.php File Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

 get_capath ()
 
 fetch_url ($url, $binary=false, &$redirects=0, $timeout=0, $accept_content=Null)
 
 post_url ($url, $params, $headers=null, &$redirects=0, $timeout=0)
 
 z_fetch_url ($url, $binary=false, $redirects=0, $opts=array())
 
 z_post_url ($url, $params, $headers=null, $redirects=0, $timeout=0)
 
 json_return_and_die ($x)
 
 xml_status ($st, $message= '')
 
 http_status_exit ($val)
 
 convert_xml_element_to_array ($xml_element, &$recursion_depth=0)
 
 webfinger_dfrn ($s, &$hcard)
 
 webfinger ($s, $debug=false)
 
 lrdd ($uri, $debug=false)
 
 fetch_lrdd_template ($host)
 
 fetch_xrd_links ($url)
 
 validate_url (&$url)
 
 validate_email ($addr)
 
 allowed_url ($url)
 
 allowed_email ($email)
 
 avatar_img ($email)
 
 parse_xml_string ($s, $strict=true)
 
 add_fcontact ($arr, $update=false)
 
 scale_external_images ($s, $include_link=true, $scale_replace=false)
 
 fix_contact_ssl_policy (&$contact, $new_policy)
 
 xml2array ($contents, $namespaces=true, $get_attributes=1, $priority= 'attribute')
 
 email_header_encode ($in_str, $charset)
 
 email_send ($addr, $subject, $headers, $item)
 
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
add_fcontact ( $arr,
 $update = false 
)
+
+ +
+
+ +
+
+ + + + + + + + +
allowed_email ( $email)
+
+ +

Referenced by check_account_email().

+ +
+
+ +
+
+ + + + + + + + +
allowed_url ( $url)
+
+ +

Referenced by new_contact().

+ +
+
+ +
+
+ + + + + + + + +
avatar_img ( $email)
+
+ +

Referenced by probe_url().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
convert_xml_element_to_array ( $xml_element,
& $recursion_depth = 0 
)
+
+ +

Referenced by lrdd().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
email_header_encode ( $in_str,
 $charset 
)
+
+ +

Referenced by lostpass_content(), lostpass_post(), and enotify\send().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
email_send ( $addr,
 $subject,
 $headers,
 $item 
)
+
+ +
+
+ +
+
+ + + + + + + + +
fetch_lrdd_template ( $host)
+
+ +

Referenced by webfinger().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
fetch_url ( $url,
 $binary = false,
& $redirects = 0,
 $timeout = 0,
 $accept_content = Null 
)
+
+

fetch_url is deprecated and being replaced by the more capable z_fetch_url please use that function instead. Once all occurrences of fetch_url are removed from the codebase we will remove this function and perhaps rename z_fetch_url back to fetch_url

+ +

Referenced by consume_feed(), dfrn_deliver(), dirfind_content(), fetch_xrd_links(), local_delivery(), lrdd(), oembed_fetch_url(), oexchange_content(), post_url(), probe_url(), and scale_external_images().

+ +
+
+ +
+
+ + + + + + + + +
fetch_xrd_links ( $url)
+
+ +

Referenced by fetch_lrdd_template(), lrdd(), and webfinger().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
fix_contact_ssl_policy (& $contact,
 $new_policy 
)
+
+ +
+
+ +
+
+ + + + + + + +
get_capath ()
+
+ +

Referenced by fetch_url(), post_url(), z_fetch_url(), and z_post_url().

+ +
+
+ +
+
+ + + + + + + + +
http_status_exit ( $val)
+
+ +

Referenced by _well_known_init(), and poco_init().

+ +
+
+ +
+
+ + + + + + + + +
json_return_and_die ( $x)
+
+ +

Referenced by api_export_basic(), dirsearch_content(), new_channel_init(), post_post(), register_init(), zfinger_init(), zotfeed_init(), and zperms_init().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
lrdd ( $uri,
 $debug = false 
)
+
+ +

Referenced by handle_tag(), photos_post(), probe_url(), profiles_post(), and webfinger_content().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
parse_xml_string ( $s,
 $strict = true 
)
+
+ +

Referenced by construct_activity_object(), construct_activity_target(), consume_feed(), dfrn_deliver(), local_delivery(), lrdd(), and notifications_content().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
post_url ( $url,
 $params,
 $headers = null,
& $redirects = 0,
 $timeout = 0 
)
+
+ +

Referenced by dfrn_deliver(), and match_content().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
scale_external_images ( $s,
 $include_link = true,
 $scale_replace = false 
)
+
+ +

Referenced by diaspora2bb(), and item_post().

+ +
+
+ +
+
+ + + + + + + + +
validate_email ( $addr)
+
+ +

Referenced by check_account_email(), probe_url(), and zid_init().

+ +
+
+ +
+
+ + + + + + + + +
validate_url (& $url)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
webfinger ( $s,
 $debug = false 
)
+
+ +

Referenced by lrdd(), webfinger_content(), and webfinger_dfrn().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
webfinger_dfrn ( $s,
& $hcard 
)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
xml2array ( $contents,
 $namespaces = true,
 $get_attributes = 1,
 $priority = 'attribute' 
)
+
+

xml2array() will convert the given XML text to an array in the XML structure. Link: http://www.bin-co.com/php/scripts/xml2array/ Portions significantly re-written by mike@.nosp@m.macg.nosp@m.irvin.nosp@m..com for Friendica (namespaces, lowercase tags, get_attribute default changed, more...) Arguments : $contents - The XML text $namespaces - true or false include namespace information in the returned array as array elements. $get_attributes - 1 or 0. If this is 1 the function will get the attributes as well as the tag values - this results in a different array structure in the return value. $priority - Can be 'tag' or 'attribute'. This will change the way the resulting array sturcture. For 'tag', the tags are given more importance. Return: The parsed XML in an array form. Use print_r() to see the resulting array structure. Examples: $array = xml2array(file_get_contents('feed.xml')); $array = xml2array(file_get_contents('feed.xml', true, 1, 'attribute'));

+ +

Referenced by fetch_xrd_links().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
xml_status ( $st,
 $message = '' 
)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
z_fetch_url ( $url,
 $binary = false,
 $redirects = 0,
 $opts = array() 
)
+
+ +

Referenced by check_htaccess(), directory_content(), import_post(), import_profile_photo(), navbar_complete(), oembed_fetch_url(), onepoll_run(), parseurl_getsiteinfo(), poco_load(), z_post_url(), zot_finger(), and zot_register_hub().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
z_post_url ( $url,
 $params,
 $headers = null,
 $redirects = 0,
 $timeout = 0 
)
+
+ +

Referenced by zot_finger(), zot_notify(), zot_refresh(), and zot_zot().

+ +
+
+
+
+ + + + -- cgit v1.2.3