Partial stub message added

[shipsimu.git] / inc / classes / main / helper / web / links / class_WebLinkHelper.php

diff --git a/inc/classes/main/helper/web/links/class_WebLinkHelper.php b/inc/classes/main/helper/web/links/class_WebLinkHelper.php
index f90636757aacf41bc76772cb20c107b02b9a6a69..d52610261fa93e8da557df1e39e4e31263f78ab8 100644 (file)
--- a/inc/classes/main/helper/web/links/class_WebLinkHelper.php
+++ b/inc/classes/main/helper/web/links/class_WebLinkHelper.php
@@ -27,6 +27,11 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
         */
        private $linkName = "";
 
+       /**
+        * Base of the link
+        */
+       private $linkBase = "";
+
        /**
         * Protected constructor
         *
@@ -42,18 +47,22 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
         *
         * @param       $templateInstance       An instance of a template engine
         * @param       $linkName                       Name of the link we shall generate
+        * @param       $linkBase                       Link base for all generated links
         * @return      $helperInstance         A prepared instance of this helper
         */
-       public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName) {
+       public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase) {
                // Get new instance
                $helperInstance = new WebLinkHelper();
 
                // Set template instance
                $helperInstance->setTemplateInstance($templateInstance);
 
-               // Set Link name
+               // Set link name
                $helperInstance->setLinkName($linkName);
 
+               // Set link base
+               $helperInstance->setLinkBase($linkBase);
+
                // Return the prepared instance
                return $helperInstance;
        }
@@ -77,6 +86,25 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                return $this->linkName;
        }
 
+       /**
+        * Setter for link base
+        *
+        * @param       $linkBase       Base of the link we shall generate
+        * @return      void
+        */
+       protected final function setLinkBase ($linkBase) {
+               $this->linkBase = (string) $linkBase;
+       }
+
+       /**
+        * Getter for link base
+        *
+        * @return      $linkBase       Base of the link we shall generate
+        */
+       public final function getLinkBase () {
+               return $this->linkBase;
+       }
+
        /**
         * Flush the content out,e g. to a template variable
         *
@@ -102,7 +130,7 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                        $this->closeGroupById($groupId);
                } else {
                        // Open the new group
-                       $this->openGroupByIdText($groupId, $groupText);
+                       $this->openGroupByIdContent($groupId, $groupText);
                }
        }
 
@@ -113,6 +141,7 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
         * @param       $groupNote      Note to be added to a group
         * @return      void
         * @throws      NoGroupOpenedException  If no previous group was opened
+        * @todo        Implement adding the note to the previously opened group or sub group
         */
        public function addLinkNote ($groupNote) {
                // Check if a previous group was opened
@@ -120,6 +149,9 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                        // No group was opened before!
                        throw new NoGroupOpenedException(array($this, $groupNote), self::EXCEPTION_GROUP_NOT_OPENED);
                }
+
+               // Not fully implemented!
+               $this->partialStub();
        }
 }