Doc tags updated
authorRoland Häder <roland@mxchange.org>
Thu, 14 Aug 2008 18:03:40 +0000 (18:03 +0000)
committerRoland Häder <roland@mxchange.org>
Thu, 14 Aug 2008 18:03:40 +0000 (18:03 +0000)
application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php
application/ship-simu/main/user/class_ShipSimuBaseUser.php
application/ship-simu/templates/de/code/action_login_profile.ctp
inc/classes/main/filter/change/class_EmailChangeFilter.php
inc/classes/main/result/class_DatabaseResult.php
inc/classes/main/template/mail/class_MailTemplateEngine.php

index ad5c6b8..b9d0cd7 100644 (file)
@@ -83,6 +83,7 @@ class WebShipsimuProfileCommand extends BaseCommand implements Commandable {
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
+        * @todo        Add functionality here
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                // Make sure only allowed values are comming through
@@ -90,7 +91,7 @@ class WebShipsimuProfileCommand extends BaseCommand implements Commandable {
                        // Get data
                        $data = $requestInstance->getRequestElement($element);
 
-                       // Skip empty fields
+                       // Silently skip empty fields
                        if (empty($data)) continue;
 
                        // Do we have an alias?
index 020d035..22ccc55 100644 (file)
@@ -124,6 +124,7 @@ class ShipSimuBaseUser extends BaseUser implements Registerable, Updateable {
         * Checks wether the user can take points from the money bank
         *
         * @return      $bankLends      Wether the money bank is able to lend money
+        * @todo        Need to check the bank if they can generally lend money to the user
         */
        public function ifUserAllowedTakeCreditsFromMoneyBank () {
                // Per default the money bank cannot pay
@@ -159,6 +160,7 @@ class ShipSimuBaseUser extends BaseUser implements Registerable, Updateable {
         * credits from the bank.
         *
         * @return      $hasMaxCredits  Wether the user has maximum credits with the bank
+        * @todo        Need to check the bank if they can lend more money
         */
        public function ifUserHasMaximumCreditsWithMoneyBank () {
                // For default he can still get money
index db9afe3..4d8f3dd 100644 (file)
@@ -36,6 +36,7 @@ if ($helper->ifEmailChangeAllowed()) {
        } // END - Change requires confirmation
 } // END - email change allowed
 
+// Add form group for user profile
 $helper->addFormGroup('profile', "Hier kannst du deine Profildaten &auml;ndern.");
 
 // Persoenliche Daten mit in der Anmeldung abfragen?
@@ -51,32 +52,39 @@ if ($helper->ifRegisterIncludesPersonaData()) {
        $helper->addInputTextFieldWithDefault('city');
 } // END - Persona data
 
+// Add su group for zip code
 $helper->addFormSubGroup('zip', "Magst du uns auch deine Postleitzahl verraten?");
 $helper->addFieldText('zip', "Postleitzahl:");
 $helper->addInputTextFieldWithDefault('zip');
 
+// Add sub group for chat protocols
 $helper->addFormSubGroup('chat', "Gebe hier deine Nicknames bzw. Nummern an:");
 
+// Add ICQ chat?
 if ($helper->ifChatEnabled('icq')) {
        $helper->addFieldText('icq', "ICQ-Nummer:");
        $helper->addInputTextFieldWithDefault('icq');
 } // END - if
 
+// Add Jabber chat?
 if ($helper->ifChatEnabled('jabber')) {
        $helper->addFieldText('jabber', "Jabber:");
        $helper->addInputTextFieldWithDefault('jabber');
 } // END - if
 
+// Add Yahoo! chat?
 if ($helper->ifChatEnabled('yahoo')) {
        $helper->addFieldText('yahoo', "Yahoo!:");
        $helper->addInputTextFieldWithDefault('yahoo');
 } // END - if
 
+// Add AOL chat?
 if ($helper->ifChatEnabled('aol')) {
        $helper->addFieldText('aol', "AOL-Screenname:");
        $helper->addInputTextFieldWithDefault('aol');
 } // END - if
 
+// Add MSN chat?
 if ($helper->ifChatEnabled('msn')) {
        $helper->addFieldText('msn', "MSN:");
        $helper->addInputTextFieldWithDefault('msn');
index e64c2f1..4e75421 100644 (file)
@@ -101,7 +101,7 @@ class EmailChangeFilter extends BaseFrameworkSystem implements Filterable {
                $userEmail = $userInstance->getField('email');
 
                // Are they different?
-               if ($email != $email1) {
+               if ($userEmail != $email1) {
                        // Update the "new_email" field
                        $this->partialStub("Unfinished part.");
                } // END - if
index 694f13a..f7b1648 100644 (file)
@@ -221,6 +221,7 @@ class DatabaseResult extends BaseFrameworkSystem implements SearchableResult, Up
         *
         * @param       $criteriaInstance       The criteria to look inside the data set
         * @return      $result                         Found result entry
+        * @todo        0% done
         */
        public function searchEntry (LocalSearchCriteria $criteriaInstance) {
                die(__METHOD__.": Unfinished!");
index 948dd60..fbe229d 100644 (file)
@@ -312,9 +312,10 @@ class MailTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * Getter for image cache file (FQFN)
         *
         * @return      $fqfn   Full-qualified file name of the image cache
+        * @todo        0% done
         */
        public function getMailCacheFqfn () {
-               // Unfinished work!
+               // Initialize FQFN
                $fqfn = "";
                $this->debugBackTrace();