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

[core.git] / inc / classes / main / user / member / class_Member.php

diff --git a/inc/classes/main/user/member/class_Member.php b/inc/classes/main/user/member/class_Member.php
index b67ad88b9274bbc1f2ebc48759a49ab2ac47663f..1b939c2013035a4962f3e559d8ed6cba9bfea7b1 100644 (file)
--- a/inc/classes/main/user/member/class_Member.php
+++ b/inc/classes/main/user/member/class_Member.php
@@ -2,11 +2,11 @@
 /**
  * A generic class for handling users
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @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
@@ -21,7 +21,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class Member extends BaseUser implements ManageableMember, Registerable, Updateable {
+class Member extends BaseUser implements ManageableMember, Registerable {
        /**
         * Protected constructor
         *
@@ -32,19 +32,6 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
                parent::__construct(__CLASS__);
        }
 
-       /**
-        * Destructor to always flush updates
-        *
-        * @return      void
-        */
-       public function __destruct () {
-               // Flush any updated entries to the database
-               $this->flushPendingUpdates();
-
-               // Call parent destructor
-               parent::__destruct();
-       }
-
        /**
         * Creates an instance of this user class by a provided username. This
         * factory method will check if username is already taken and if not so it
@@ -53,8 +40,9 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
         * @param       $userName               Username we need a class instance for
         * @return      $userInstance   An instance of this user class
         * @throws      UsernameMissingException        If the username does not exist
+        * @throws      UnexpectedGuestAccountException         If the user status is 'guest'
         */
-       public final static function createMemberByUsername ($userName) {
+       public static final function createMemberByUsername ($userName) {
                // Get a new instance
                $userInstance = new Member();
 
@@ -62,10 +50,13 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
                $userInstance->setUserName($userName);
 
                // Check if username exists
-               if ($userInstance->ifUsernameExists() === false) {
+               if ($userInstance->ifUsernameExists() === FALSE) {
                        // Throw an exception here
                        throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
-               } // END - if
+               } elseif ($userInstance->isGuest()) === TRUE) {
+                       // User should not be a guest here
+                       throw new UnexpectedGuestAccountException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
+               }
 
                // Return the instance
                return $userInstance;
@@ -78,7 +69,7 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
         * @param       $email                  Email address of the user
         * @return      $userInstance   An instance of this user class
         */
-       public final static function createMemberByEmail ($email) {
+       public static final function createMemberByEmail ($email) {
                // Get a new instance
                $userInstance = new Member();
 
@@ -96,7 +87,7 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
         * @return      $userInstance           An instance of this user class
         * @todo        Add more ways over creating user classes
         */
-       public final static function createMemberByRequest (Requestable $requestInstance) {
+       public static final function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username
                if (!is_null($requestInstance->getRequestElement('username'))) {
                        // Username supplied
@@ -107,8 +98,7 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
                } else {
                        // Unsupported mode
                        $userInstance = new Member();
-                       $userInstance->partialStub("We need to add more ways of creating user classes here.");
-                       $userInstance->debugBackTrace();
+                       $userInstance->debugBackTrace('More ways of creating user classes are needed here.');
                        exit();
                }
 
@@ -130,7 +120,7 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
 
                // If there is no action use the default on
                if (is_null($lastAction)) {
-                       $lastAction = $this->getConfigInstance()->readConfig('login_default_action');
+                       $lastAction = $this->getConfigInstance()->getConfigEntry('login_default_action');
                } // END - if
 
                // Get a critieria instance
@@ -144,31 +134,18 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
                $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
 
                // And add our both entries
-               $updateInstance->addCriteria("last_activity", date("Y-m-d H:i:s", time()));
-               $updateInstance->addCriteria("last_action", $lastAction);
+               $updateInstance->addCriteria('last_activity', date('Y-m-d H:i:s', time()));
+               $updateInstance->addCriteria('last_action', $lastAction);
 
                // Add the search criteria for searching for the right entry
                $updateInstance->setSearchInstance($searchInstance);
 
+               // Set wrapper class name
+               $updateInstance->setWrapperConfigEntry('user_db_wrapper_class');
+
                // Remember the update in database result
                $this->getResultInstance()->add2UpdateQueue($updateInstance);
        }
-
-       /**
-        * Flushs all pending updates to the database layer
-        *
-        * @return      void
-        */
-       public function flushPendingUpdates () {
-               // Do we have data to update?
-               if ($this->getResultInstance()->ifDataNeedsFlush()) {
-                       // Get a database wrapper
-                       $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
-
-                       // Yes, then send the whole result to the database layer
-                       $wrapperInstance->doUpdateByResult($this->getResultInstance());
-               } // END - if
-       }
 }
 
 // [EOF]