Some minor improvements

[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 bbec50a6f9fe28e2180859a31acb32db8e49a7c7..4ea1819b1b40d7a425690948a2566fca79a9d2ff 100644 (file)
--- a/inc/classes/main/helper/web/links/class_WebLinkHelper.php
+++ b/inc/classes/main/helper/web/links/class_WebLinkHelper.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -35,12 +35,12 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
        /**
         * First parameter seperator
         */
-       private $firstParameter = '?';
+       const FIRST_PARAMETER_SEPERATOR = '?';
 
        /**
         * Seperator for more paraemters
         */
-       private $parameterSeperator = '&amp;';
+       const EXTRA_PARAMETER_SEPERATOR = '&amp;';
 
        /**
         * Protected constructor
@@ -59,10 +59,9 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
         * @param       $linkName                       Name of the link we shall generate
         * @param       $linkBase                       Link base for the link. This parameter is deprecated.
         * @return      $helperInstance         A prepared instance of this helper
-        * @throws      NullPointerException    Thrown if an instance is null
-        * @throws      ConfigEntryNotFoundException    A deprecated exception at this point
+        * @throws      NoConfigEntryException  A deprecated exception at this point
         */
-       public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase = null) {
+       public static final function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase = NULL) {
                // Get new instance
                $helperInstance = new WebLinkHelper();
 
@@ -75,12 +74,6 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                // Get the application instance
                $applicationInstance = Registry::getRegistry()->getInstance('application');
 
-               // Sanity-check on it
-               if (is_null($applicationInstance)) {
-                       // Throw an exception here
-                       throw new NullPointerException($helperInstance, self::EXCEPTION_IS_NULL_POINTER);
-               } // END - if
-
                // Get the request instance
                $requestInstance = $applicationInstance->getRequestInstance();
 
@@ -94,23 +87,23 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                $page = $helperInstance->convertDashesToUnderscores($requestInstance->getRequestElement('page'));
 
                // Construct config entry
-               $configEntry = $page . '_' . $linkName;
+               $configEntry = $page . '_' . $linkName . '_action_url';
 
                // 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
                try {
-                       $newLinkBase = $helperInstance->getConfigInstance()->readConfig($configEntry);
+                       $newLinkBase = $helperInstance->getConfigInstance()->getConfigEntry($configEntry);
                        $linkBase = $newLinkBase;
-               } catch (ConfigEntryNotFoundException $e) {
+               } catch (NoConfigEntryException $e) {
                        // Is the deprecated linkBase not set?
                        if (is_null($linkBase)) {
                                // Then throw again the exception
-                               throw new ConfigEntryNotFoundException(array(__CLASS__, ($configEntry)), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
+                               throw new NoConfigEntryException(array(__CLASS__, ($configEntry)), FrameworkConfiguration::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
                        } // END - if
                }
 
@@ -284,13 +277,13 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                } // END - if
 
                // Default parameter seperator is &amp;
-               $seperator = $this->parameterSeperator;
+               $seperator = self::EXTRA_PARAMETER_SEPERATOR;
 
                // Is there a question mark in?
-               $linkArray = explode($this->firstParameter, $this->getLinkBase());
+               $linkArray = explode(self::FIRST_PARAMETER_SEPERATOR, $this->getLinkBase());
                if (count($linkArray) == 0) {
                        // No question mark
-                       $seperator = $this->firstParameter;
+                       $seperator = self::FIRST_PARAMETER_SEPERATOR;
                } // END - if
 
                // Prepare action