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/zot_8php.html | 788 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 788 insertions(+) create mode 100644 doc/html/zot_8php.html (limited to 'doc/html/zot_8php.html') diff --git a/doc/html/zot_8php.html b/doc/html/zot_8php.html new file mode 100644 index 000000000..c1af15435 --- /dev/null +++ b/doc/html/zot_8php.html @@ -0,0 +1,788 @@ + + + + + + +The Red Project: include/zot.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Project +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
zot.php File Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

 zot_new_uid ($channel_nick)
 
 zot_get_hubloc ($arr, $primary=false)
 
 zot_notify ($channel, $url, $type= 'notify', $recipients=null, $remote_key=null)
 
 zot_build_packet ($channel, $type= 'notify', $recipients=null, $remote_key=null, $secret=null)
 
 zot_zot ($url, $data)
 
 zot_finger ($webbie, $channel)
 
 zot_refresh ($them, $channel=null)
 
 zot_gethub ($arr)
 
 zot_register_hub ($arr)
 
 import_xchan ($arr)
 
 zot_process_response ($hub, $arr, $outq)
 
 zot_fetch ($arr)
 
 zot_import ($arr)
 
 public_recips ($msg)
 
 allowed_public_recips ($msg)
 
 process_delivery ($sender, $arr, $deliveries, $relay)
 
 update_imported_item ($sender, $item, $uid)
 
 delete_imported_item ($sender, $item, $uid)
 
 process_mail_delivery ($sender, $arr, $deliveries)
 
 process_profile_delivery ($sender, $arr, $deliveries)
 
 import_directory_profile ($hash, $profile)
 
 import_directory_keywords ($hash, $keywords)
 
+

Function Documentation

+ +
+
+ + + + + + + + +
allowed_public_recips ( $msg)
+
+ +

Referenced by zot_import().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
delete_imported_item ( $sender,
 $item,
 $uid 
)
+
+ +

Referenced by process_delivery().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
import_directory_keywords ( $hash,
 $keywords 
)
+
+ +

Referenced by import_directory_profile().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
import_directory_profile ( $hash,
 $profile 
)
+
+ +

Referenced by process_profile_delivery(), syncdirs(), and zot_refresh().

+ +
+
+ +
+
+ + + + + + + + +
import_xchan ( $arr)
+
+ +

Referenced by chanview_content(), gprobe_run(), magic_init(), message_post(), new_contact(), poco_load(), post_init(), zot_refresh(), and zot_register_hub().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
process_delivery ( $sender,
 $arr,
 $deliveries,
 $relay 
)
+
+ +

Referenced by onepoll_run(), and zot_import().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
process_mail_delivery ( $sender,
 $arr,
 $deliveries 
)
+
+ +

Referenced by zot_import().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
process_profile_delivery ( $sender,
 $arr,
 $deliveries 
)
+
+ +

Referenced by zot_import().

+ +
+
+ +
+
+ + + + + + + + +
public_recips ( $msg)
+
+ +

Referenced by allowed_public_recips().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
update_imported_item ( $sender,
 $item,
 $uid 
)
+
+ +

Referenced by process_delivery().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
zot_build_packet ( $channel,
 $type = 'notify',
 $recipients = null,
 $remote_key = null,
 $secret = null 
)
+
+ +

Referenced by directory_run(), notifier_run(), and post_init().

+ +
+
+ +
+
+ + + + + + + + +
zot_fetch ( $arr)
+
+ +

Referenced by post_post().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
zot_finger ( $webbie,
 $channel 
)
+
+ +

Referenced by chanview_content(), gprobe_run(), magic_init(), message_post(), new_contact(), poco_load(), post_init(), and probe_content().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
zot_get_hubloc ( $arr,
 $primary = false 
)
+
+

Given an array of zot hashes, return all distinct hubs If primary is true, return only primary hubs Result is ordered by url to assist in batching. Return only the first primary hub as there should only be one.

+ +

Referenced by zfinger_init(), and zperms_init().

+ +
+
+ +
+
+ + + + + + + + +
zot_gethub ( $arr)
+
+ +

Referenced by import_post(), post_post(), and zot_fetch().

+ +
+
+ +
+
+ + + + + + + + +
zot_import ( $arr)
+
+ +

Referenced by deliver_run(), and zot_fetch().

+ +
+
+ +
+
+ + + + + + + + +
zot_new_uid ( $channel_nick)
+
+

zot_new_uid($channel_nick) = unique nickname of controlling entity

+
Returns
string
+ +

Referenced by create_identity().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
zot_notify ( $channel,
 $url,
 $type = 'notify',
 $recipients = null,
 $remote_key = null 
)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
zot_process_response ( $hub,
 $arr,
 $outq 
)
+
+ +

Referenced by deliver_run(), and queue_run().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
zot_refresh ( $them,
 $channel = null 
)
+
+ +

Referenced by connections_content(), import_author_xchan(), onepoll_run(), and post_post().

+ +
+
+ +
+
+ + + + + + + + +
zot_register_hub ( $arr)
+
+ +

Referenced by post_post().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
zot_zot ( $url,
 $data 
)
+
+ +

Referenced by deliver_run(), directory_run(), notifier_run(), post_init(), queue_run(), and zot_fetch().

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