diff options
Diffstat (limited to 'doc/html/identity_8php.html')
| -rw-r--r-- | doc/html/identity_8php.html | 357 |
1 files changed, 346 insertions, 11 deletions
diff --git a/doc/html/identity_8php.html b/doc/html/identity_8php.html index e48a5e79a..af9595a99 100644 --- a/doc/html/identity_8php.html +++ b/doc/html/identity_8php.html @@ -28,7 +28,7 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td id="projectlogo"><img alt="Logo" src="rhash-64.png"/></td> + <td id="projectlogo"><img alt="Logo" src="rm-64.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">The Red Matrix </div> @@ -126,10 +126,50 @@ Functions</h2></td></tr> <tr class="separator:a78151baf4407a8482d2681a91a9c486b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3570a4eb77332b292d394c4132cb8f03"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#a3570a4eb77332b292d394c4132cb8f03">identity_basic_export</a> ($channel_id)</td></tr> <tr class="separator:a3570a4eb77332b292d394c4132cb8f03"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a77ee7d66eb0758f7e7882f70ad0f9485"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#a77ee7d66eb0758f7e7882f70ad0f9485">identity_basic_import</a> ($arr, $seize_primary=false)</td></tr> -<tr class="separator:a77ee7d66eb0758f7e7882f70ad0f9485"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4751b522ea913d0e7ed43e03d22e9e68"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#a4751b522ea913d0e7ed43e03d22e9e68">profile_load</a> (&$a, $nickname, $profile= '')</td></tr> +<tr class="separator:a4751b522ea913d0e7ed43e03d22e9e68"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad4a2c8caca8f6ae93633ebeca0ed6620"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#ad4a2c8caca8f6ae93633ebeca0ed6620">profile_create_sidebar</a> (&$a, $connect=true)</td></tr> +<tr class="separator:ad4a2c8caca8f6ae93633ebeca0ed6620"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a432259b2cf5b6f59be53e71db9f2c7dc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#a432259b2cf5b6f59be53e71db9f2c7dc">profile_sidebar</a> ($profile, $block=0, $show_connect=true)</td></tr> +<tr class="separator:a432259b2cf5b6f59be53e71db9f2c7dc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad2c97627a313d53df1a1c7b4215ddb51"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#ad2c97627a313d53df1a1c7b4215ddb51">get_birthdays</a> ()</td></tr> +<tr class="separator:ad2c97627a313d53df1a1c7b4215ddb51"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae381db3d43f8e7c1da8b15d14ecf5312"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#ae381db3d43f8e7c1da8b15d14ecf5312">get_events</a> ()</td></tr> +<tr class="separator:ae381db3d43f8e7c1da8b15d14ecf5312"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa870d2c1f558cfd52bef05bc124e8fa4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#aa870d2c1f558cfd52bef05bc124e8fa4">advanced_profile</a> (&$a)</td></tr> +<tr class="separator:aa870d2c1f558cfd52bef05bc124e8fa4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa46321e1cd6a3b8dfde8bf9510112fec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#aa46321e1cd6a3b8dfde8bf9510112fec">get_my_url</a> ()</td></tr> +<tr class="separator:aa46321e1cd6a3b8dfde8bf9510112fec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a490972c02fdb638c52ec0e012a30bfd2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#a490972c02fdb638c52ec0e012a30bfd2">get_my_address</a> ()</td></tr> +<tr class="separator:a490972c02fdb638c52ec0e012a30bfd2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a680fbafc2db023c5b1309e0180e81315"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#a680fbafc2db023c5b1309e0180e81315">zid_init</a> (&$a)</td></tr> +<tr class="separator:a680fbafc2db023c5b1309e0180e81315"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5b815330f3d177ab383af37a6c12e532"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#a5b815330f3d177ab383af37a6c12e532">zid</a> ($s, $address= '')</td></tr> +<tr class="separator:a5b815330f3d177ab383af37a6c12e532"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaeb666872995e3ab8da8f7bc5f3b2bd3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#aaeb666872995e3ab8da8f7bc5f3b2bd3">get_theme_uid</a> ()</td></tr> +<tr class="separator:aaeb666872995e3ab8da8f7bc5f3b2bd3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab1485a26b032956e1496fc08c58b83ed"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="identity_8php.html#ab1485a26b032956e1496fc08c58b83ed">get_default_profile_photo</a> ($size=175)</td></tr> +<tr class="separator:ab1485a26b032956e1496fc08c58b83ed"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="aa870d2c1f558cfd52bef05bc124e8fa4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">advanced_profile </td> + <td>(</td> + <td class="paramtype">& </td> + <td class="paramname"><em>$a</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="profile_8php.html#a3775cf6eef6587e5143133356a7b76c0">profile_content()</a>.</p> + +</div> +</div> <a class="anchor" id="a77d2237f1846964634b1c99089c27c7d"></a> <div class="memitem"> <div class="memproto"> @@ -142,6 +182,8 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p>() Return the total number of channels on this site. No filtering is performed.</p> +<dl class="section return"><dt>Returns</dt><dd>int on error returns boolean false </dd></dl> <p>Referenced by <a class="el" href="zfinger_8php.html#a8139b83a22ef98869adc10aa224027a0">zfinger_init()</a>.</p> @@ -159,6 +201,8 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p><a class="el" href="identity_8php.html#abf6a9c6ed92d594f1d4513c4e22a7abd">create_dir_account()</a> Create a system channel - which has no account attached</p> +<p>Currently unused. </p> </div> </div> @@ -175,11 +219,124 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p>create_identity($arr) Create a new channel Also creates the related xchan, hubloc, profile, and "self" abook records, and an empty "Friends" group/collection for the new channel</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">array</td><td class="paramname">$arr</td><td>'name' => full name of channel 'nickname' => "email/url-compliant" nickname 'account_id' => account_id to attach with this channel [other identity fields as desired]</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>array 'success' => boolean true or false 'message' => optional error text if success is false 'channel' => if successful the created channel array </dd></dl> <p>Referenced by <a class="el" href="identity_8php.html#abf6a9c6ed92d594f1d4513c4e22a7abd">create_dir_account()</a>, and <a class="el" href="new__channel_8php.html#a180b0646957db8290482f02454ad7f23">new_channel_post()</a>.</p> </div> </div> +<a class="anchor" id="ad2c97627a313d53df1a1c7b4215ddb51"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">get_birthdays </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ab1485a26b032956e1496fc08c58b83ed"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">get_default_profile_photo </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$size</em> = <code>175</code></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>get_default_profile_photo($size = 175) Retrieves the path of the default_profile_photo for this system with the specified size. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">int</td><td class="paramname">$size</td><td>one of (175, 80, 48) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>string </dd></dl> + +<p>Referenced by <a class="el" href="include_2network_8php.html#ab07ce9d75eae559865ed90aad2154bd7">avatar_img()</a>, <a class="el" href="photo__driver_8php.html#a102f3f26f67e0e38f4322a771951c1ca">import_profile_photo()</a>, and <a class="el" href="photo_8php.html#a582779d24882b0d31ee909a91d70a448">photo_init()</a>.</p> + +</div> +</div> +<a class="anchor" id="ae381db3d43f8e7c1da8b15d14ecf5312"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">get_events </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a490972c02fdb638c52ec0e012a30bfd2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">get_my_address </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="classApp.html#a08f0537964d98958d218066364cff785">App\build_pagehead()</a>, <a class="el" href="rmagic_8php.html#a95455edd43f1bff39446a57388cdde16">rmagic_init()</a>, <a class="el" href="identity_8php.html#a5b815330f3d177ab383af37a6c12e532">zid()</a>, and <a class="el" href="identity_8php.html#a680fbafc2db023c5b1309e0180e81315">zid_init()</a>.</p> + +</div> +</div> +<a class="anchor" id="aa46321e1cd6a3b8dfde8bf9510112fec"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">get_my_url </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="nav_8php.html#a43be0df73b90647ea70947ce004e231e">nav()</a>, and <a class="el" href="identity_8php.html#a5b815330f3d177ab383af37a6c12e532">zid()</a>.</p> + +</div> +</div> +<a class="anchor" id="aaeb666872995e3ab8da8f7bc5f3b2bd3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">get_theme_uid </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> <a class="anchor" id="a3570a4eb77332b292d394c4132cb8f03"></a> <div class="memitem"> <div class="memproto"> @@ -193,26 +350,94 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p>identity_basic_export($channel_id) Create an array representing the important channel information which would be necessary to create a nomadic identity clone. This includes most channel resources and connection information with the exception of content.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">int</td><td class="paramname">$channel_id</td><td>Channel_id to export</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>array See function for details </dd></dl> <p>Referenced by <a class="el" href="include_2api_8php.html#adfc035ee6303c1d8ba5336a4ead2bd53">api_export_basic()</a>, and <a class="el" href="uexport_8php.html#a118920137dedebe0581623a2e57e7b0d">uexport_init()</a>.</p> </div> </div> -<a class="anchor" id="a77ee7d66eb0758f7e7882f70ad0f9485"></a> +<a class="anchor" id="ac9fcd5c4c371998790b5c55c3d0f4633"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">identity_check_service_class </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$account_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>identity_check_service_class($account_id) Called when creating a new channel. Checks the account's service class and number of current channels to determine whether creating a new channel is within the current service class constraints.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">int</td><td class="paramname">$account_id</td><td>Account_id used for this request</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>array 'success' => boolean true if creating a new channel is allowed for this account 'message' => if success is false, optional error text </dd></dl> + +<p>Referenced by <a class="el" href="identity_8php.html#a345f4c943d84de502ec6e72d2c813945">create_identity()</a>.</p> + +</div> +</div> +<a class="anchor" id="ad4a2c8caca8f6ae93633ebeca0ed6620"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">profile_create_sidebar </td> + <td>(</td> + <td class="paramtype">& </td> + <td class="paramname"><em>$a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$connect</em> = <code>true</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="connect_8php.html#ad46a38f32fd7a3d324b1fa26373efa36">connect_init()</a>.</p> + +</div> +</div> +<a class="anchor" id="a4751b522ea913d0e7ed43e03d22e9e68"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">identity_basic_import </td> + <td class="memname">profile_load </td> <td>(</td> + <td class="paramtype">& </td> + <td class="paramname"><em>$a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> <td class="paramtype"> </td> - <td class="paramname"><em>$arr</em>, </td> + <td class="paramname"><em>$nickname</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> - <td class="paramname"><em>$seize_primary</em> = <code>false</code> </td> + <td class="paramname"><em>$profile</em> = <code>''</code> </td> </tr> <tr> <td></td> @@ -221,24 +446,59 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p>: profile_load(&$a, $nickname, $profile) Generate </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype"><a class="el" href="classApp.html">App</a></td><td class="paramname">$a</td><td></td></tr> + <tr><td class="paramtype">string</td><td class="paramname">$nickname</td><td></td></tr> + <tr><td class="paramtype">string</td><td class="paramname">$profile</td><td>Summary: Loads a profile into the <a class="el" href="classApp.html">App</a> structure. The function requires a writeable copy of the main <a class="el" href="classApp.html">App</a> structure, and the nickname of a valid channel.</td></tr> + </table> + </dd> +</dl> +<p>Permissions of the current observer are checked. If a restricted profile is available to the current observer, that will be loaded instead of the channel default profile.</p> +<p>The channel owner can set $profile to a valid profile_guid to preview that profile.</p> +<p>The channel default theme is also selected for use, unless over-riden elsewhere. </p> +<p>load/reload current theme info</p> + +<p>Referenced by <a class="el" href="blocks_8php.html#a2531a8fd51db3cecb2eb20c002c66e12">blocks_content()</a>, <a class="el" href="channel_8php.html#ac7c8c7845741baadf87fae6bc279f3dc">channel_init()</a>, <a class="el" href="common_8php.html#aca62f113655809f41f49042ce9b123c2">common_init()</a>, <a class="el" href="connect_8php.html#ad46a38f32fd7a3d324b1fa26373efa36">connect_init()</a>, <a class="el" href="layouts_8php.html#a6e0193759ad9eef76d3df2db24237b50">layouts_content()</a>, <a class="el" href="page_8php.html#a4d89800c0366a239191b1692c09635cf">page_init()</a>, <a class="el" href="mod_2photos_8php.html#ab950295cd77626f5fe65331a87693014">photos_init()</a>, <a class="el" href="profile_8php.html#ab5d0246be0552e2182a585c1206d22a5">profile_init()</a>, <a class="el" href="profile__photo_8php.html#a140631c56438fbfacb61a1eb43067d02">profile_photo_init()</a>, <a class="el" href="profiles_8php.html#a36f71405ad536228f8bb84a551b23f7e">profiles_init()</a>, <a class="el" href="profperm_8php.html#a17fb64ec05edee1dc94d95438807d6c6">profperm_init()</a>, <a class="el" href="viewconnections_8php.html#a00163d50b17568f7b0e48b1ca9ab7330">viewconnections_init()</a>, and <a class="el" href="webpages_8php.html#af3b7397d4abc153e3d2147740ee1a41d">webpages_content()</a>.</p> </div> </div> -<a class="anchor" id="ac9fcd5c4c371998790b5c55c3d0f4633"></a> +<a class="anchor" id="a432259b2cf5b6f59be53e71db9f2c7dc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">identity_check_service_class </td> + <td class="memname">profile_sidebar </td> <td>(</td> <td class="paramtype"> </td> - <td class="paramname"><em>$account_id</em></td><td>)</td> + <td class="paramname"><em>$profile</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$block</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$show_connect</em> = <code>true</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> +<p>Function: profile_sidebar</p> +<p>Formats a profile for display in the sidebar. It is very difficult to templatise the HTML completely because of all the conditional logic.</p> +<p>: array $profile</p> +<p>Returns HTML string stuitable for sidebar inclusion Exceptions: Returns empty string if passed $profile is wrong type or not populated </p> -<p>Referenced by <a class="el" href="identity_8php.html#a345f4c943d84de502ec6e72d2c813945">create_identity()</a>.</p> +<p>Referenced by <a class="el" href="identity_8php.html#ad4a2c8caca8f6ae93633ebeca0ed6620">profile_create_sidebar()</a>, <a class="el" href="widgets_8php.html#a70442dfa079312d9d5e5ee01be51a165">widget_fullprofile()</a>, and <a class="el" href="widgets_8php.html#abd2e508a2a0b911c4a838e3cb7599923">widget_profile()</a>.</p> </div> </div> @@ -271,6 +531,16 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p>set_default_login_identity($account_id, $channel_id, $force = true) Set default channel to be used on login</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">int</td><td class="paramname">$account_id</td><td>login account </td></tr> + <tr><td class="paramtype">int</td><td class="paramname">$channel_id</td><td>channel id to set as default for this account </td></tr> + <tr><td class="paramtype"></td><td class="paramname">boolean</td><td>force if true, set this default unconditionally if $force is false only do this if there is no existing default</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>nil </dd></dl> <p>Referenced by <a class="el" href="identity_8php.html#a345f4c943d84de502ec6e72d2c813945">create_identity()</a>, and <a class="el" href="import_8php.html#af17fef0410518f7eac205d0ea416eaa2">import_post()</a>.</p> @@ -289,11 +559,76 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<p>validate_channelname($name) Determine if the channel name is allowed when creating a new channel. This action is pluggable.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$name</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>nil return if name is valid, or string describing the error state.</dd></dl> +<p>We're currently only checking for an empty name or one that exceeds our storage limit (255 chars). 255 chars is probably going to create a mess on some pages. Plugins can set additional policies such as full name requirements, character sets, multi-byte length, etc. </p> <p>Referenced by <a class="el" href="identity_8php.html#a345f4c943d84de502ec6e72d2c813945">create_identity()</a>, and <a class="el" href="settings_8php.html#aa7ee94d88ac088edb04ccf3a26de3586">settings_post()</a>.</p> </div> </div> +<a class="anchor" id="a5b815330f3d177ab383af37a6c12e532"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">zid </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$s</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$address</em> = <code>''</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>zid($s,$address = '') Adds a zid parameter to a url </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramtype">string</td><td class="paramname">$s</td><td>The url to accept the zid </td></tr> + <tr><td class="paramtype">boolean</td><td class="paramname">$address</td><td>$address to use instead of session environment </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>string</dd></dl> +<p>'zid' string url - url to accept zid string zid - urlencoded zid string result - the return string we calculated, change it if you want to return something else </p> + +<p>Referenced by <a class="el" href="conversation_8php.html#affea1afb3f32ca41e966c8ddb4204d81">conversation()</a>, <a class="el" href="text_8php.html#a3054189cff173977f4216c9a3dd29e1b">format_categories()</a>, <a class="el" href="text_8php.html#a3ef8c0cf31f35f77462067de8712fa34">get_plink()</a>, <a class="el" href="conversation_8php.html#afe5b2f38d8b803edb0d7ec5fa2868db0">like_puller()</a>, <a class="el" href="conversation_8php.html#a9bd7f9fb6678736c581bcba3b17f471c">localize_item()</a>, <a class="el" href="match_8php.html#a1dd853e959b9e70c1911bb2fb5f5130d">match_content()</a>, <a class="el" href="include_2menu_8php.html#a890cc6237971e15f15702e6b2e88502e">menu_render()</a>, <a class="el" href="include_2follow_8php.html#ae387d4ae097c23d69f3247e7f08140c7">new_contact()</a>, and <a class="el" href="viewconnections_8php.html#ab6c4d983e97b3a8a879567ff76507776">viewconnections_content()</a>.</p> + +</div> +</div> +<a class="anchor" id="a680fbafc2db023c5b1309e0180e81315"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">zid_init </td> + <td>(</td> + <td class="paramtype">& </td> + <td class="paramname"><em>$a</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>zid_init(&$a) If somebody arrives at our site using a zid, add their xchan to our DB if we don't have it already. And if they aren't already authenticated here, attempt reverse magic auth.</p> +<p>'zid_init' string 'zid' - their zid string 'url' - the destination url </p> + +</div> +</div> </div><!-- contents --> </div><!-- doc-content --> |