Added new interfaces Handleable/-DataSet and ProtocolHandler (no content yet).

[core.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 1c32fc0540d1b4c4ab85b0fd476ad6c9fe4436a8..88a23eb0865b17b2cef10310d729cb6cd29c159f 100644 (file)
--- a/inc/classes/main/helper/web/links/class_WebLinkHelper.php
+++ b/inc/classes/main/helper/web/links/class_WebLinkHelper.php
@@ -2,11 +2,11 @@
 /**
  * A helper for web links
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -33,14 +33,14 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
        private $linkBase = '';
 
        /**
-        * First parameter seperator
+        * First parameter separator
         */
-       private $firstParameter = '?';
+       const FIRST_PARAMETER_SEPARATOR = '?';
 
        /**
-        * Seperator for more paraemters
+        * SEPARATOR for more paraemters
         */
-       private $parameterSeperator = '&amp;';
+       const EXTRA_PARAMETER_SEPARATOR = '&amp;';
 
        /**
         * Protected constructor
@@ -61,7 +61,7 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
         * @return      $helperInstance         A prepared instance of this helper
         * @throws      NoConfigEntryException  A deprecated exception at this point
         */
-       public static final function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase = null) {
+       public static final function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase = NULL) {
                // Get new instance
                $helperInstance = new WebLinkHelper();
 
@@ -92,7 +92,7 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                // Is the deprecated parameter set?
                if (!is_null($linkBase)) {
                        // Then output a deprecation message
-                       $helperInstance->deprecationWarning(__METHOD__ . ': linkBase is deprecated. Please remove it from your templates and add a config entry ' . $configEntry . ' in your config.php file.');
+                       $helperInstance->deprecationWarning('[' . __METHOD__ . ':' . __LINE__ . ']:  linkBase is deprecated. Please remove it from your templates and add a config entry ' . $configEntry . ' in your config.php file.');
                } // END - if
 
                // Determine link base from config now and 'page' request
@@ -239,7 +239,7 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
         */
        public function addLinkNote ($groupId, $groupNote, $groupCode = "div") {
                // Check if a previous group was opened
-               if ($this->ifGroupOpenedPreviously() === false) {
+               if ($this->ifGroupOpenedPreviously() === FALSE) {
                        // No group was opened before!
                        throw new NoGroupOpenedException(array($this, $groupNote), self::EXCEPTION_GROUP_NOT_OPENED);
                } // END - if
@@ -271,24 +271,24 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
         */
        protected function addActionLink ($linkAction, $linkText, $linkTitle) {
                // Check if a previous group was opened
-               if ($this->ifGroupOpenedPreviously() === false) {
+               if ($this->ifGroupOpenedPreviously() === FALSE) {
                        // No group was opened before!
                        throw new NoGroupOpenedException(array($this, $linkAction . '(' . $linkText . ')'), self::EXCEPTION_GROUP_NOT_OPENED);
                } // END - if
 
-               // Default parameter seperator is &amp;
-               $seperator = $this->parameterSeperator;
+               // Default parameter SEPARATOR is &amp;
+               $separator = self::EXTRA_PARAMETER_SEPARATOR;
 
                // Is there a question mark in?
-               $linkArray = explode($this->firstParameter, $this->getLinkBase());
+               $linkArray = explode(self::FIRST_PARAMETER_SEPARATOR, $this->getLinkBase());
                if (count($linkArray) == 0) {
                        // No question mark
-                       $seperator = $this->firstParameter;
+                       $separator = self::FIRST_PARAMETER_SEPARATOR;
                } // END - if
 
                // Prepare action
-               $action = sprintf("%saction=%s",
-                       $seperator,
+               $action = sprintf('%saction=%s',
+                       $separator,
                        $linkAction
                );