Added isGuest() isConfirmed() to BaseUser for wrapping this type of check into

[core.git] / inc / classes / main / user / class_BaseUser.php

diff --git a/inc/classes/main/user/class_BaseUser.php b/inc/classes/main/user/class_BaseUser.php
index 247b85af29c6167248cd485fb7dab930f4fe98e3..ce67c061f9128cbde18ffbbae13484eb093e6698 100644 (file)
--- a/inc/classes/main/user/class_BaseUser.php
+++ b/inc/classes/main/user/class_BaseUser.php
@@ -2,11 +2,11 @@
 /**
  * A general user class 
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -118,7 +118,7 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
         */
        public function ifUsernameExists () {
                // By default the username does not exist
-               $exists = false;
+               $exists = FALSE;
 
                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
@@ -148,7 +148,7 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
                // Search for it
                if ($this->getResultInstance()->next()) {
                        // Entry found
-                       $exists = true;
+                       $exists = TRUE;
                } // END - if
 
                // Return the status
@@ -162,7 +162,7 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
         */
        public function ifEmailAddressExists () {
                // By default the email does not exist
-               $exists = false;
+               $exists = FALSE;
 
                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
@@ -192,7 +192,7 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
                // Search for it
                if ($this->getResultInstance()->next()) {
                        // Entry found
-                       $exists = true;
+                       $exists = TRUE;
 
                        // Is the username set?
                        if ($this->getUserName() == '') {
@@ -217,7 +217,7 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
         */
        public function ifPasswordHashMatches (Requestable $requestInstance) {
                // By default nothing matches... ;)
-               $matches = false;
+               $matches = FALSE;
 
                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
@@ -330,6 +330,32 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
                // Remember the update in database result
                $this->getResultInstance()->add2UpdateQueue($updateInstance);
        }
+
+       /**
+        * Checks whether the user status is 'confirmed'
+        *
+        * @return      $isConfirmed    Whether the user status is 'confirmed'
+        */
+       public function isConfirmed () {
+               // Determine it
+               $isConfirmed = ($this->getField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) == $this->getConfigInstance()->getConfigEntry('user_status_confirmed'));
+
+               // Return it
+               return $isConfirmed;
+       }
+
+       /**
+        * Checks whether the user status is 'guest'
+        *
+        * @return      $isGuest        Whether the user status is 'guest'
+        */
+       public function isGuest () {
+               // Determine it
+               $isGuest = ($this->getField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) == $this->getConfigInstance()->getConfigEntry('user_status_guest'));
+
+               // Return it
+               return $isGuest;
+       }
 }
 
 // [EOF]