class_UserDatabaseWrapper.php

Go to the documentation of this file.

<?php
class UserDatabaseWrapper extends BaseDatabaseWrapper {
        // Constants for exceptions
        const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;

        // Constants for database columns
        const DB_COLUMN_USERID       = "userid";
        const DB_COLUMN_USERNAME     = "username";
        const DB_COLUMN_EMAIL        = "email";
        const DB_COLUMN_CONFIRM_HASH = "confirm_hash";
        const DB_COLUMN_USER_STATUS  = "user_status";

        // Constants for database table names
        const DB_TABLE_USER = "user";

        protected function __construct() {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }

        public final static function createUserDatabaseWrapper () {
                // Get a new instance
                $wrapperInstance = new UserDatabaseWrapper();

                // Set (primary!) table name
                $wrapperInstance->setTableName(self::DB_TABLE_USER);

                // Return the instance
                return $wrapperInstance;
        }

        public final function getIndexKey () {
                return $this->getDatabaseInstance()->getIndexKey();
        }

        public function insertRegistrationObject (UserRegister $registrationInstance) {
                // Generate a data set for the request
                $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));

                // Set the primary key
                $dataSetInstance->setUniqueKey('username');

                // Add registration elements to the dataset
                $registrationInstance->addElementsToDataSet($dataSetInstance);

                // "Insert" this request instance completely into the database
                $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
        }

        public function doUpdateByResult (UpdateableResult $resultInstance) {
                // Generate a data set object
                $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));

                // Add all update criteria to the database set
                $resultInstance->addElementsToDataSet($dataSetInstance);

                // Add seach criteria
                $dataSetInstance->setSearchInstance($resultInstance->getSearchInstance());

                // Set the primary key
                $dataSetInstance->setUniqueKey('username');

                // "Update" this request with the database
                $this->getDatabaseInstance()->queryUpdateDataSet($dataSetInstance);
        }
}

// [EOF]
?>