Typos fixed and special command resolver are now possible
[shipsimu.git] / application / ship-simu / main / registration / class_ShipSimuRegistration.php
index 1ad97313716eb84008af5695ac96c2f0939e7c10..5778665388ab19a56880d639541ed25f3eb703de 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * A user registration specially for Ship-Simu
+ * A user registration class specially for Ship-Simu
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
@@ -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 ShipSimuRegistration extends BaseRegistration {
+class ShipSimuRegistration extends BaseRegistration implements UserRegister {
        /**
         * Hashed password
         */
@@ -73,14 +73,14 @@ class ShipSimuRegistration extends BaseRegistration {
        }
 
        /**
-        * Encrypt the given request key or throw an exception if the key was not
-        * found in the request
+        * Encrypt given request key or throw an exception if key was not found in
+        * request
         *
         * @param       $requestKey             Key in request class
         * @return      void
         */
        public function encryptPassword ($requestKey) {
-               // Check if the password is found in the request
+               // Check if password is found in request
                if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
                        // So encrypt the password and store it for later usage in
                        // the request:
@@ -91,7 +91,7 @@ class ShipSimuRegistration extends BaseRegistration {
                        // 2. Get a crypto helper and hash the password
                        $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword);
 
-                       // 3. Store the hash back in the request
+                       // 3. Store the hash back in request
                        $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
                }
        }
@@ -101,6 +101,7 @@ class ShipSimuRegistration extends BaseRegistration {
         * before registration
         *
         * @return      void
+        * @todo        Maybe add more things to perform
         */
        public function doPreRegistration () {
                // First run all pre filters
@@ -112,6 +113,7 @@ class ShipSimuRegistration extends BaseRegistration {
         * database and paying some start credits or throw exceptions if this fails
         *
         * @return      void
+        * @todo        Maybe add more things to perform
         */
        public function registerNewUser () {
                // Get a user database wrapper
@@ -125,6 +127,7 @@ class ShipSimuRegistration extends BaseRegistration {
         * Perform things like notifying partner websites after registration is done
         *
         * @return      void
+        * @todo        Maybe add more things to perform
         */
        public function doPostRegistration () {
                // First run all post filters