summaryrefslogtreecommitdiff
path: root/app/Auth.php
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@webtrees.net>2018-07-16 08:20:33 +0100
committerGreg Roach <fisharebest@webtrees.net>2018-07-16 08:20:33 +0100
commitc1010eda29c0909ed4d5d463f32d32bfefdd4dfe (patch)
treefbb656ebc014aa1295ac8e6176f41e89f94b91e7 /app/Auth.php
parent782f08d9bd2bfa06635da947ee34f8e1afd65088 (diff)
downloadwebtrees-c1010eda29c0909ed4d5d463f32d32bfefdd4dfe.tar.gz
webtrees-c1010eda29c0909ed4d5d463f32d32bfefdd4dfe.tar.bz2
webtrees-c1010eda29c0909ed4d5d463f32d32bfefdd4dfe.zip
Use PSR2 code style
Diffstat (limited to 'app/Auth.php')
-rw-r--r--app/Auth.php300
1 files changed, 156 insertions, 144 deletions
diff --git a/app/Auth.php b/app/Auth.php
index 6ad1e48d0d..589a5d1190 100644
--- a/app/Auth.php
+++ b/app/Auth.php
@@ -18,166 +18,178 @@ namespace Fisharebest\Webtrees;
/**
* Authentication.
*/
-class Auth {
- // Privacy constants
- const PRIV_PRIVATE = 2; // Allows visitors to view the item
- const PRIV_USER = 1; // Allows members to access the item
- const PRIV_NONE = 0; // Allows managers to access the item
- const PRIV_HIDE = -1; // Hide the item to all users
+class Auth
+{
+ // Privacy constants
+ const PRIV_PRIVATE = 2; // Allows visitors to view the item
+ const PRIV_USER = 1; // Allows members to access the item
+ const PRIV_NONE = 0; // Allows managers to access the item
+ const PRIV_HIDE = -1; // Hide the item to all users
- /**
- * Are we currently logged in?
- *
- * @return bool
- */
- public static function check() {
- return self::id() !== null;
- }
+ /**
+ * Are we currently logged in?
+ *
+ * @return bool
+ */
+ public static function check()
+ {
+ return self::id() !== null;
+ }
- /**
- * Is the specified/current user an administrator?
- *
- * @param User|null $user
- *
- * @return bool
- */
- public static function isAdmin(User $user = null) {
- if ($user === null) {
- $user = self::user();
- }
+ /**
+ * Is the specified/current user an administrator?
+ *
+ * @param User|null $user
+ *
+ * @return bool
+ */
+ public static function isAdmin(User $user = null)
+ {
+ if ($user === null) {
+ $user = self::user();
+ }
- return $user && $user->getPreference('canadmin') === '1';
- }
+ return $user && $user->getPreference('canadmin') === '1';
+ }
- /**
- * Is the specified/current user a manager of a tree?
- *
- * @param Tree $tree
- * @param User|null $user
- *
- * @return bool
- */
- public static function isManager(Tree $tree, User $user = null) {
- if ($user === null) {
- $user = self::user();
- }
+ /**
+ * Is the specified/current user a manager of a tree?
+ *
+ * @param Tree $tree
+ * @param User|null $user
+ *
+ * @return bool
+ */
+ public static function isManager(Tree $tree, User $user = null)
+ {
+ if ($user === null) {
+ $user = self::user();
+ }
- return self::isAdmin($user) || $user && $tree->getUserPreference($user, 'canedit') === 'admin';
- }
+ return self::isAdmin($user) || $user && $tree->getUserPreference($user, 'canedit') === 'admin';
+ }
- /**
- * Is the specified/current user a moderator of a tree?
- *
- * @param Tree $tree
- * @param User|null $user
- *
- * @return bool
- */
- public static function isModerator(Tree $tree, User $user = null) {
- if ($user === null) {
- $user = self::user();
- }
+ /**
+ * Is the specified/current user a moderator of a tree?
+ *
+ * @param Tree $tree
+ * @param User|null $user
+ *
+ * @return bool
+ */
+ public static function isModerator(Tree $tree, User $user = null)
+ {
+ if ($user === null) {
+ $user = self::user();
+ }
- return self::isManager($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'accept';
- }
+ return self::isManager($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'accept';
+ }
- /**
- * Is the specified/current user an editor of a tree?
- *
- * @param Tree $tree
- * @param User|null $user
- *
- * @return bool
- */
- public static function isEditor(Tree $tree, User $user = null) {
- if ($user === null) {
- $user = self::user();
- }
+ /**
+ * Is the specified/current user an editor of a tree?
+ *
+ * @param Tree $tree
+ * @param User|null $user
+ *
+ * @return bool
+ */
+ public static function isEditor(Tree $tree, User $user = null)
+ {
+ if ($user === null) {
+ $user = self::user();
+ }
- return self::isModerator($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'edit';
- }
+ return self::isModerator($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'edit';
+ }
- /**
- * Is the specified/current user a member of a tree?
- *
- * @param Tree $tree
- * @param User|null $user
- *
- * @return bool
- */
- public static function isMember(Tree $tree, User $user = null) {
- if ($user === null) {
- $user = self::user();
- }
+ /**
+ * Is the specified/current user a member of a tree?
+ *
+ * @param Tree $tree
+ * @param User|null $user
+ *
+ * @return bool
+ */
+ public static function isMember(Tree $tree, User $user = null)
+ {
+ if ($user === null) {
+ $user = self::user();
+ }
- return self::isEditor($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'access';
- }
+ return self::isEditor($tree, $user) || $user && $tree->getUserPreference($user, 'canedit') === 'access';
+ }
- /**
- * What is the specified/current user's access level within a tree?
- *
- * @param Tree $tree
- * @param User|null $user
- *
- * @return int
- */
- public static function accessLevel(Tree $tree, User $user = null) {
- if ($user === null) {
- $user = self::user();
- }
+ /**
+ * What is the specified/current user's access level within a tree?
+ *
+ * @param Tree $tree
+ * @param User|null $user
+ *
+ * @return int
+ */
+ public static function accessLevel(Tree $tree, User $user = null)
+ {
+ if ($user === null) {
+ $user = self::user();
+ }
- if (self::isManager($tree, $user)) {
- return self::PRIV_NONE;
- } elseif (self::isMember($tree, $user)) {
- return self::PRIV_USER;
- } else {
- return self::PRIV_PRIVATE;
- }
- }
+ if (self::isManager($tree, $user)) {
+ return self::PRIV_NONE;
+ } elseif (self::isMember($tree, $user)) {
+ return self::PRIV_USER;
+ } else {
+ return self::PRIV_PRIVATE;
+ }
+ }
- /**
- * The ID of the authenticated user, from the current session.
- *
- * @return string|null
- */
- public static function id() {
- return Session::get('wt_user');
- }
+ /**
+ * The ID of the authenticated user, from the current session.
+ *
+ * @return string|null
+ */
+ public static function id()
+ {
+ return Session::get('wt_user');
+ }
- /**
- * The authenticated user, from the current session.
- *
- * @return User
- */
- public static function user() {
- $user = User::find(self::id());
- if ($user === null) {
- $visitor = new \stdClass;
- $visitor->user_id = '';
- $visitor->user_name = '';
- $visitor->real_name = '';
- $visitor->email = '';
+ /**
+ * The authenticated user, from the current session.
+ *
+ * @return User
+ */
+ public static function user()
+ {
+ $user = User::find(self::id());
+ if ($user === null) {
+ $visitor = new \stdClass;
+ $visitor->user_id = '';
+ $visitor->user_name = '';
+ $visitor->real_name = '';
+ $visitor->email = '';
- return new User($visitor);
- } else {
- return $user;
- }
- }
+ return new User($visitor);
+ } else {
+ return $user;
+ }
+ }
- /**
- * Login directly as an explicit user - for masquerading.
- *
- * @param User $user
- */
- public static function login(User $user) {
- Session::regenerate(false);
- Session::put('wt_user', $user->getUserId());
- }
+ /**
+ * Login directly as an explicit user - for masquerading.
+ *
+ * @param User $user
+ */
+ public static function login(User $user)
+ {
+ Session::regenerate(false);
+ Session::put('wt_user', $user->getUserId());
+ }
- /**
- * End the session for the current user.
- */
- public static function logout() {
- Session::regenerate(true);
- }
+ /**
+ * End the session for the current user.
+ */
+ public static function logout()
+ {
+ Session::regenerate(true);
+ }
}