class_ShipSimuMember.php

Go to the documentation of this file.

<?php
class ShipSimuMember extends ShipSimuBaseUser implements ManageableMember {
        protected function __construct ($className = __CLASS__) {
                // Call parent constructor
                parent::__construct($className);
        }

        public function __destruct () {
                // Flush any updated entries to the database
                $this->flushPendingUpdates();

                // Call parent destructor
                parent::__destruct();
        }

        public final static function createMemberByUsername ($userName) {
                // Get a new instance
                $userInstance = new ShipSimuMember();

                // Set the username
                $userInstance->setUserName($userName);

                // Check if username exists
                if ($userInstance->ifUsernameExists() === false) {
                        // Throw an exception here
                        throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
                } // END - if

                // Return the instance
                return $userInstance;
        }

        public final static function createMemberByEmail ($email) {
                // Get a new instance
                $userInstance = new ShipSimuMember();

                // Set the username
                $userInstance->setEmail($email);

                // Return the instance
                return $userInstance;
        }

        public final static function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username
                if (!is_null($requestInstance->getRequestElement('username'))) {
                        // Username supplied
                        $userInstance = self::createMemberByUserName($requestInstance->getRequestElement('username'));
                } elseif (!is_null($requestInstance->getRequestElement('email'))) {
                        // Email supplied
                        $userInstance = self::createMemberByEmail($requestInstance->getRequestElement('email'));
                } else {
                        // Unsupported mode
                        $userInstance = new ShipSimuMember();
                        $userInstance->partialStub("We need to add more ways of creating user classes here.");
                        $userInstance->debugBackTrace();
                        exit();
                }

                // Return the prepared instance
                return $userInstance;
        }

        public function updateLastActivity (Requestable $requestInstance) {
                // Set last action
                $lastAction = $requestInstance->getRequestElement('action');

                // If there is no action use the default on
                if (is_null($lastAction)) {
                        $lastAction = $this->getConfigInstance()->readConfig('login_default_action');
                } // END - if

                // Get a critieria instance
                $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');

                // Add search criteria
                $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
                $searchInstance->setLimit(1);

                // Now get another criteria
                $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);

                // Add the search criteria for searching for the right entry
                $updateInstance->setSearchInstance($searchInstance);

                // Remember the update in database result
                $this->getResultInstance()->add2UpdateQueue($updateInstance);
        }

        public function flushPendingUpdates () {
                // Is the object valid?
                if (!$this->getResultInstance() instanceof SearchableResult) {
                        // Abort here
                        return;
                } // END - if

                // 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]
?>