Fix in CryptoHelper class, templates are now loaded from application (templates in...
[core.git] / inc / classes / main / helper / web / links / class_WebLinkHelper.php
index 5dd2ef7e0b436a29c099d621457b5058354655d0..7b2706871df3877218f52acf48babe7194a69a90 100644 (file)
@@ -57,10 +57,12 @@ 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
+        * @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
         */
-       public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase) {
+       public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase = null) {
                // Get new instance
                $helperInstance = new WebLinkHelper();
 
@@ -70,6 +72,48 @@ class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
                // Set link name
                $helperInstance->setLinkName($linkName);
 
+               // 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();
+
+               // Sanity-check on it
+               if (is_null($requestInstance)) {
+                       // Throw an exception here
+                       throw new NullPointerException($helperInstance, self::EXCEPTION_IS_NULL_POINTER);
+               } // END - if
+
+               // Get page (this will throw an exception if not set)
+               $page = $helperInstance->convertDashesToUnderscores($requestInstance->getRequestElement('page'));
+
+               // Construct config entry
+               $configEntry = $page . '_' . $linkName;
+
+               // 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.');
+               } // END - if
+
+               // Determine link base from config now and 'page' request
+               try {
+                       $newLinkBase = $helperInstance->getConfigInstance()->readConfig($configEntry);
+                       $linkBase = $newLinkBase;
+               } catch (ConfigEntryNotFoundException $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);
+                       } // END - if
+               }
+
                // Set link base
                $helperInstance->setLinkBase($linkBase);