Improve documentation of visitor-related functions
This commit is contained in:
parent
ae23c69303
commit
470079c37c
2
boot.php
2
boot.php
|
@ -266,7 +266,7 @@ function public_contact()
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns contact id of authenticated site visitor or false
|
* Returns public contact id of authenticated site visitor or false
|
||||||
*
|
*
|
||||||
* @return int|bool visitor_id or false
|
* @return int|bool visitor_id or false
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -65,10 +65,10 @@ class Session
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns contact ID for given user ID
|
* Return the user contact ID of a visitor for the given user ID they are visiting
|
||||||
*
|
*
|
||||||
* @param integer $uid User ID
|
* @param integer $uid User ID
|
||||||
* @return integer Contact ID of visitor for given user ID
|
* @return integer
|
||||||
*/
|
*/
|
||||||
public static function getRemoteContactID($uid)
|
public static function getRemoteContactID($uid)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in a new issue