class_BaseUser.php

Go to the documentation of this file.

<?php
class BaseUser extends BaseFrameworkSystem {
        // Exception constances
        const EXCEPTION_USERNAME_NOT_FOUND   = 0x150;
        const EXCEPTION_USER_EMAIL_NOT_FOUND = 0x151;
        const EXCEPTION_USER_PASS_MISMATCH   = 0x152;

        private $userName = "";

        private $userId = 0;

        private $email = "";

        protected function __construct ($className) {
                // Call parent constructor
                parent::__construct($className);

                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        public final function setUserName ($userName) {
                $this->userName = (string) $userName;
        }

        public final function getUserName () {
                return $this->userName;
        }

        public final function setUserId ($userId) {
                $this->userId = $userId;
        }

        public final function getUserId () {
                return $this->userId;
        }

        protected final function setEmail ($email) {
                $this->email = (string) $email;
        }

        public final function getEmail () {
                return $this->email;
        }

        public function ifUsernameExists () {
                // By default the username does not exist
                $exists = false;

                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
                        // Get a UserDatabaseWrapper instance
                        $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');

                        // Create a search criteria
                        $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');

                        // Add the username as a criteria and set limit to one entry
                        $criteriaInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
                        $criteriaInstance->setLimit(1);

                        // Get a search result
                        $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);

                        // Set the index "solver"
                        $resultInstance->solveResultIndex(UserDatabaseWrapper::DB_COLUMN_USERID, $wrapperInstance, array($this, 'setUserId'));

                        // And finally set it
                        $this->setResultInstance($resultInstance);
                } // END - if

                // Rewind it
                $this->getResultInstance()->rewind();

                // Search for it
                if ($this->getResultInstance()->next()) {
                        // Entry found
                        $exists = true;
                } // END - if

                // Return the status
                return $exists;
        }

        public function ifEmailAddressExists () {
                // By default the email does not exist
                $exists = false;

                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
                        // Get a UserDatabaseWrapper instance
                        $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');

                        // Create a search criteria
                        $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');

                        // Add the username as a criteria and set limit to one entry
                        $criteriaInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_EMAIL, $this->getEmail());
                        $criteriaInstance->setLimit(1);

                        // Get a search result
                        $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);

                        // Set the index "solver"
                        $resultInstance->solveResultIndex(UserDatabaseWrapper::DB_COLUMN_USERID, $wrapperInstance, array($this, 'setUserId'));

                        // And finally set it
                        $this->setResultInstance($resultInstance);
                } // END - if

                // Rewind it
                $this->getResultInstance()->rewind();

                // Search for it
                if ($this->getResultInstance()->next()) {
                        // Entry found
                        $exists = true;

                        // Is the username set?
                        if ($this->getUserName() == "") {
                                // Get current entry
                                $currEntry = $this->getResultInstance()->current();

                                // Set the username
                                $this->setUserName($currEntry['username']);
                        } // END - if
                } // END - if

                // Return the status
                return $exists;
        }

        public function ifPasswordHashMatches (Requestable $requestInstance) {
                // By default nothing matches... ;)
                $matches = false;

                // Is a previous result there?
                if (is_null($this->getResultInstance())) {
                        // Get a UserDatabaseWrapper instance
                        $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');

                        // Create a search criteria
                        $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');

                        // Add the username as a criteria and set limit to one entry
                        $criteriaInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
                        $criteriaInstance->setLimit(1);

                        // Get a search result
                        $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);

                        // Set the index "solver"
                        $resultInstance->solveResultIndex(UserDatabaseWrapper::DB_COLUMN_USERID, $wrapperInstance, array($this, 'setUserId'));

                        // And finally set it
                        $this->setResultInstance($resultInstance);
                } // END - if

                // Rewind it
                $this->getResultInstance()->rewind();

                // Search for it
                if ($this->getResultInstance()->find('pass_hash')) {
                        // So does the hashes match?
                        //* DEBUG: */ echo $requestInstance->getRequestElement('pass_hash')."/".$entry['pass_hash'];
                        $matches = ($requestInstance->getRequestElement('pass_hash') === $this->getResultInstance()->getFoundValue());
                } // END - if

                // Return the status
                return $matches;
        }

        public final function getPasswordHash () {
                // Default is missing password hash
                $passHash = null;

                // Get a database entry
                $entry = $this->getDatabaseEntry();

                // Is the password hash there?
                if (isset($entry['pass_hash'])) {
                        // Get it
                        $passHash = $entry['pass_hash'];
                } // END - if

                // And return the hash
                return $passHash;
        }

        public final function getPrimaryKey () {
                // Get a user database wrapper
                $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');

                // Get the primary key back from the wrapper
                $primaryKey = $wrapperInstance->getPrimaryKeyValue();

                // Get that field
                $primaryValue = $this->getField($primaryKey);

                // Return the value
                return $primaryValue;
        }

        public function updateDatabaseField ($fieldName, $fieldValue) {
                // Is updating database fields allowed by interface?
                if (!$this instanceof Updateable) {
                        // Update not supported!
                        throw new DatabaseUpdateSupportException($this, self::EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED);
                } // 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($fieldName, $fieldValue);

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

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

// [EOF]
?>