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 7943b7c27fb93749734c2975405f6b421a66614c..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 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
@@ -51,10 +51,6 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
        protected function __construct ($className) {
                // Call parent constructor
                parent::__construct($className);
-
-               // Clean up a little
-               $this->removeNumberFormaters();
-               $this->removeSystemArray();
        }
 
        /**
@@ -116,13 +112,13 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
        }
 
        /**
-        * Determines wether the username exists or not
+        * Determines whether the username exists or not
         *
-        * @return      $exists         Wether the username exists
+        * @return      $exists         Whether the username exists
         */
        public function ifUsernameExists () {
                // By default the username does not exist
-               $exists = false;
+               $exists = FALSE;
 
                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
@@ -152,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
@@ -160,13 +156,13 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
        }
 
        /**
-        * Determines wether the email exists or not
+        * Determines whether the email exists or not
         *
-        * @return      $exists         Wether the email exists
+        * @return      $exists         Whether the email exists
         */
        public function ifEmailAddressExists () {
                // By default the email does not exist
-               $exists = false;
+               $exists = FALSE;
 
                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
@@ -196,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,11 +213,11 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
         * database.
         *
         * @param       $requestInstance        A requestable class instance
-        * @return      $matches                        Wether the supplied password hash matches
+        * @return      $matches                        Whether the supplied password hash matches
         */
        public function ifPasswordHashMatches (Requestable $requestInstance) {
                // By default nothing matches... ;)
-               $matches = false;
+               $matches = FALSE;
 
                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
@@ -245,13 +241,16 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
                        $this->setResultInstance($resultInstance);
                } // END - if
 
-               // Rewind it
+               // Rewind it and advance to first entry
                $this->getResultInstance()->rewind();
 
+               // This call set the result instance to a clean state
+               $this->getResultInstance()->next();
+
                // Search for it
                if ($this->getResultInstance()->find('pass_hash')) {
                        // So does the hashes match?
-                       //* DEBUG: */ echo $requestInstance->getRequestElement('pass_hash').'/'.$entry['pass_hash'];
+                       //* DEBUG: */ echo $requestInstance->getRequestElement('pass_hash') . '<br />' . $this->getResultInstance()->getFoundValue() . '<br />';
                        $matches = ($requestInstance->getRequestElement('pass_hash') === $this->getResultInstance()->getFoundValue());
                } // END - if
 
@@ -266,7 +265,7 @@ class BaseUser extends BaseFrameworkSystem implements Updateable {
         */
        public final function getPasswordHash () {
                // Default is missing password hash
-               $passHash = null;
+               $passHash = NULL;
 
                // Get a database entry
                $entry = $this->getDatabaseEntry();
@@ -331,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]