Doc tags updated

diff --git a/application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php b/application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php
index ad5c6b8a91e79b234ac5adbd3bf456682588c9f6..b9d0cd7a0a3ec37c1c1e2ee8663277093dc710b6 100644 (file)
--- a/application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php
+++ b/application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php
@@ -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
         * @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
         */
        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);
 
                        // Get data
                        $data = $requestInstance->getRequestElement($element);
 

-                       // Skip empty fields
+                       // Silently skip empty fields

                        if (empty($data)) continue;
 
                        // Do we have an alias?
                        if (empty($data)) continue;
 
                        // Do we have an alias?

diff --git a/application/ship-simu/main/user/class_ShipSimuBaseUser.php b/application/ship-simu/main/user/class_ShipSimuBaseUser.php
index 020d0350474def0827b4622c098a4b93de696e53..22ccc55b401f7dc4295f7e365e68c31c86378a22 100644 (file)
--- a/application/ship-simu/main/user/class_ShipSimuBaseUser.php
+++ b/application/ship-simu/main/user/class_ShipSimuBaseUser.php
@@ -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
         * 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
         */
        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
         * 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
         */
        public function ifUserHasMaximumCreditsWithMoneyBank () {
                // For default he can still get money

diff --git a/application/ship-simu/templates/de/code/action_login_profile.ctp b/application/ship-simu/templates/de/code/action_login_profile.ctp
index db9afe3faaf9c66e06f3f99347271deaae5a731e..4d8f3ddcefffb63e5e8c5d43014feac8f9988cc2 100644 (file)
--- a/application/ship-simu/templates/de/code/action_login_profile.ctp
+++ b/application/ship-simu/templates/de/code/action_login_profile.ctp
@@ -36,6 +36,7 @@ if ($helper->ifEmailChangeAllowed()) {
        } // END - Change requires confirmation
 } // END - email change allowed
 
        } // END - Change requires confirmation
 } // END - email change allowed
 

+// Add form group for user profile

 $helper->addFormGroup('profile', "Hier kannst du deine Profildaten ändern.");
 
 // Persoenliche Daten mit in der Anmeldung abfragen?
 $helper->addFormGroup('profile', "Hier kannst du deine Profildaten ändern.");
 
 // Persoenliche Daten mit in der Anmeldung abfragen?


@@ -51,32 +52,39 @@ if ($helper->ifRegisterIncludesPersonaData()) {
        $helper->addInputTextFieldWithDefault('city');
 } // END - Persona data
 
        $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');
 
 $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:");
 
 $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
 
 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
 
 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
 
 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
 
 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');
 if ($helper->ifChatEnabled('msn')) {
        $helper->addFieldText('msn', "MSN:");
        $helper->addInputTextFieldWithDefault('msn');

diff --git a/inc/classes/main/filter/change/class_EmailChangeFilter.php b/inc/classes/main/filter/change/class_EmailChangeFilter.php
index e64c2f1fad5ac9720fc4558c7ca890cfddd96803..4e75421e1832f566291a11263478f47440a832b4 100644 (file)
--- a/inc/classes/main/filter/change/class_EmailChangeFilter.php
+++ b/inc/classes/main/filter/change/class_EmailChangeFilter.php
@@ -101,7 +101,7 @@ class EmailChangeFilter extends BaseFrameworkSystem implements Filterable {
                $userEmail = $userInstance->getField('email');
 
                // Are they different?
                $userEmail = $userInstance->getField('email');
 
                // Are they different?

-               if ($email != $email1) {
+               if ($userEmail != $email1) {

                        // Update the "new_email" field
                        $this->partialStub("Unfinished part.");
                } // END - if
                        // Update the "new_email" field
                        $this->partialStub("Unfinished part.");
                } // END - if

diff --git a/inc/classes/main/result/class_DatabaseResult.php b/inc/classes/main/result/class_DatabaseResult.php
index 694f13aca7bb5e9f28e18a05b3ebc4ae591a095a..f7b1648ff08346d7c8f359bf7a68212fccb6493e 100644 (file)
--- a/inc/classes/main/result/class_DatabaseResult.php
+++ b/inc/classes/main/result/class_DatabaseResult.php
@@ -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
         *
         * @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!");
         */
        public function searchEntry (LocalSearchCriteria $criteriaInstance) {
                die(__METHOD__.": Unfinished!");

diff --git a/inc/classes/main/template/mail/class_MailTemplateEngine.php b/inc/classes/main/template/mail/class_MailTemplateEngine.php
index 948dd60970e27126234a89831d2c69e9becc98bf..fbe229d7cf9454630a22705204104bf17dec3414 100644 (file)
--- a/inc/classes/main/template/mail/class_MailTemplateEngine.php
+++ b/inc/classes/main/template/mail/class_MailTemplateEngine.php
@@ -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
         * Getter for image cache file (FQFN)
         *
         * @return      $fqfn   Full-qualified file name of the image cache

+        * @todo        0% done

         */
        public function getMailCacheFqfn () {
         */
        public function getMailCacheFqfn () {

-               // Unfinished work!
+               // Initialize FQFN

                $fqfn = "";
                $this->debugBackTrace();
 
                $fqfn = "";
                $this->debugBackTrace();