aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2015-02-18 13:04:54 +0100
committerKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2015-02-18 13:11:15 +0100
commit2fc61e780a87d3280e99c6f64943426f454d7b80 (patch)
tree3e69d3e438e43c19fe9841b7538110a06c419ecc
parent2fbb6a5ff5c2b097e42e41ff73587127998ae86e (diff)
downloadvolse-hubzilla-2fc61e780a87d3280e99c6f64943426f454d7b80.tar.gz
volse-hubzilla-2fc61e780a87d3280e99c6f64943426f454d7b80.tar.bz2
volse-hubzilla-2fc61e780a87d3280e99c6f64943426f454d7b80.zip
Updated doxygen docu about deperecated functions.
Corrected wrong return types in doxygen docu and add a deprecation log entry.
-rwxr-xr-xboot.php32
1 files changed, 27 insertions, 5 deletions
diff --git a/boot.php b/boot.php
index 7e3a2a6d4..4009f63dd 100755
--- a/boot.php
+++ b/boot.php
@@ -1598,11 +1598,14 @@ function get_account_id() {
}
/**
- * @brief Returns the entity id (channel_id) of locally logged in user or false.
+ * @brief Returns the entity id (channel_id) of locally logged in channel or false.
*
* Returns authenticated numeric channel_id if authenticated and connected to
* a channel or 0. Sometimes referred to as $uid in the code.
*
+ * Before 2.1 this function was called local_user().
+ *
+ * @since 2.1
* @return int|bool channel_id or false
*/
function local_channel() {
@@ -1612,16 +1615,29 @@ function local_channel() {
return false;
}
+/**
+ * local_user() got deprecated and replaced by local_channel().
+ *
+ * @deprecated since v2.1, use local_channel()
+ * @see local_channel()
+ */
function local_user() {
- // DEPRECATED
+ logger('local_user() is DEPRECATED, use local_channel()');
return local_channel();
}
/**
- * @brief Returns contact id (visitor_id) of authenticated site visitor or false.
+ * @brief Returns a xchan_hash (visitor_id) of remote authenticated visitor
+ * or false.
+ *
+ * Returns authenticated string hash of Red global identifier (xchan_hash), if
+ * authenticated via remote auth, or an empty string.
*
- * @return int|bool visitor_id or false
+ * Before 2.1 this function was called remote_user().
+ *
+ * @since 2.1
+ * @return string|bool visitor_id or false
*/
function remote_channel() {
if((x($_SESSION, 'authenticated')) && (x($_SESSION, 'visitor_id')))
@@ -1630,8 +1646,14 @@ function remote_channel() {
return false;
}
+/**
+ * remote_user() got deprecated and replaced by remote_channel().
+ *
+ * @deprecated since v2.1, use remote_channel()
+ * @see remote_channel()
+ */
function remote_user() {
- // DEPRECATED
+ logger('remote_user() is DEPRECATED, use remote_channel()');
return remote_channel();
}