From 9074f002ad0603014c90b12aaaf2c51d740638e9 Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Tue, 8 Feb 2011 19:11:48 +0000
Subject: Deprecated isadminloggedin(), isloggedin(), get_loggedin_user(), and
 get_loggedin_userid() because they melt my brain each time I see them. This
 commit breaks trunk. Wait for the incoming commit to fix it.

git-svn-id: http://code.elgg.org/elgg/trunk@8077 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/lib/deprecated-1.8.php | 50 +++++++++++++++++++++++++++++++++++++++++++
 engine/lib/sessions.php       | 25 ++++++++++------------
 2 files changed, 61 insertions(+), 14 deletions(-)

(limited to 'engine/lib')

diff --git a/engine/lib/deprecated-1.8.php b/engine/lib/deprecated-1.8.php
index f293c178f..bf474abc2 100644
--- a/engine/lib/deprecated-1.8.php
+++ b/engine/lib/deprecated-1.8.php
@@ -2912,3 +2912,53 @@ function get_entity_icon_url(ElggEntity $entity, $size = 'medium') {
 
 	return elgg_normalize_url($url);
 }
+
+/**
+ * Return the current logged in user, or NULL if no user is logged in.
+ *
+ * If no user can be found in the current session, a plugin
+ * hook - 'session:get' 'user' to give plugin authors another
+ * way to provide user details to the ACL system without touching the session.
+ *
+ * @deprecated 1.8 Use elgg_get_logged_in_user_entity()
+ * @return ElggUser|NULL
+ */
+function get_loggedin_user() {
+	elgg_deprecated_notice('get_loggedin_user() is deprecated by elgg_get_logged_in_user_entity()', 1.8);
+	return elgg_get_logged_in_user_entity();
+}
+
+/**
+ * Return the current logged in user by id.
+ *
+ * @deprecated 1.8 Use elgg_get_logged_in_user_guid()
+ * @see elgg_get_logged_in_user_entity()
+ * @return int
+ */
+function get_loggedin_userid() {
+	elgg_deprecated_notice('get_loggedin_userid() is deprecated by elgg_get_logged_in_user_guid()', 1.8);
+	return elgg_get_logged_in_user_guid();
+}
+
+
+/**
+ * Returns whether or not the user is currently logged in
+ *
+ * @deprecated 1.8 Use elgg_is_logged_in();
+ * @return bool
+ */
+function isloggedin() {
+	elgg_deprecated_notice('isloggedin() is deprecated by elgg_is_logged_in()', 1.8);
+	return elgg_is_logged_in();
+}
+
+/**
+ * Returns whether or not the user is currently logged in and that they are an admin user.
+ *
+ * @deprecated 1.8 Use elgg_is_admin_logged_in()
+ * @return bool
+ */
+function isadminloggedin() {
+	elgg_deprecated_notice('isadminloggedin() is deprecated by elgg_is_admin_logged_in()', 1.8);
+	return elgg_is_admin_logged_in();
+}
\ No newline at end of file
diff --git a/engine/lib/sessions.php b/engine/lib/sessions.php
index 46912a152..d91ede9f5 100644
--- a/engine/lib/sessions.php
+++ b/engine/lib/sessions.php
@@ -20,7 +20,7 @@ global $SESSION;
  *
  * @return ElggUser|NULL
  */
-function get_loggedin_user() {
+function elgg_get_logged_in_user_entity() {
 	global $SESSION;
 
 	if (isset($SESSION)) {
@@ -33,11 +33,11 @@ function get_loggedin_user() {
 /**
  * Return the current logged in user by id.
  *
- * @see get_loggedin_user()
+ * @see elgg_get_logged_in_user_entity()
  * @return int
  */
-function get_loggedin_userid() {
-	$user = get_loggedin_user();
+function elgg_get_logged_in_user_guid() {
+	$user = elgg_get_logged_in_user_entity();
 	if ($user) {
 		return $user->guid;
 	}
@@ -50,9 +50,8 @@ function get_loggedin_userid() {
  *
  * @return bool
  */
-function isloggedin() {
-
-	$user = get_loggedin_user();
+function elgg_is_logged_in() {
+	$user = elgg_get_logged_in_user_entity();
 
 	if ((isset($user)) && ($user instanceof ElggUser) && ($user->guid > 0)) {
 		return true;
@@ -64,14 +63,12 @@ function isloggedin() {
 /**
  * Returns whether or not the user is currently logged in and that they are an admin user.
  *
- * @uses isloggedin()
  * @return bool
  */
-function isadminloggedin() {
-
-	$user = get_loggedin_user();
+function elgg_is_admin_logged_in() {
+	$user = elgg_get_logged_in_user_entity();
 
-	if ((isloggedin()) && $user->isAdmin()) {
+	if ((elgg_is_logged_in()) && $user->isAdmin()) {
 		return TRUE;
 	}
 
@@ -176,7 +173,7 @@ function pam_auth_userpass($credentials = NULL) {
 	if ($user->password !== generate_user_password($user, $credentials['password'])) {
 		log_login_failure($user->guid);
 		throw new LoginException(elgg_echo('LoginException:PasswordFailure'));
-	} 
+	}
 
 	return true;
 }
@@ -347,7 +344,7 @@ function logout() {
 	unset($_SESSION['guid']);
 	unset($_SESSION['id']);
 	unset($_SESSION['user']);
-	
+
 	setcookie("elggperm", "", (time() - (86400 * 30)), "/");
 
 	// pass along any messages
-- 
cgit v1.2.3