Merge pull request GOCDB#436 from rowan04/433-outdated-links-to-be-configurable

GT-127 Outdated links to be configurable

Author: gregcorbett

config/local_info.xml

@@ -15,6 +15,19 @@
     <!-- If page_banner is not empty the text is used to create a page banner strip -->
     <page_banner></page_banner>
 
+    <!-- Documentation links to be configurable -->
+    <project>
+        <doc_link></doc_link>
+    </project>
+
+    <ngi>
+        <doc_link></doc_link>
+    </ngi>
+
+    <service_group>
+        <doc_link></doc_link>
+    </service_group>
+
     <!-- Email addresses to send from and reply to -->
     <email_from>no-reply@localhost</email_from>
     <email_to>gocdb-admins@localhost</email_to>

config/local_info.xsd

@@ -121,6 +121,31 @@
                 </xs:complexType>
               </xs:element>
               <xs:element name="send_email" type="xs:boolean" minOccurs="0"/>
+
+              <xs:element name="project" minOccurs="0">
+                <xs:complexType>
+                  <xs:all>
+                    <xs:element name="doc_link" type="xs:string"/>
+                  </xs:all>
+                </xs:complexType>
+              </xs:element>
+
+              <xs:element name="ngi" minOccurs="0">
+                <xs:complexType>
+                  <xs:all>
+                    <xs:element name="doc_link" type="xs:string"/>
+                  </xs:all>
+                </xs:complexType>
+              </xs:element>
+
+              <xs:element name="service_group" minOccurs="0">
+                <xs:complexType>
+                  <xs:all>
+                    <xs:element name="doc_link" type="xs:string"/>
+                  </xs:all>
+                </xs:complexType>
+              </xs:element>
+
             </xs:all>
             <xs:attribute name="url" type="xs:anyURI"/>
           </xs:complexType>

htdocs/web_portal/controllers/ngi/view_ngis.php

@@ -25,6 +25,8 @@ function view_ngis() {
     require_once __DIR__ . '/../utils.php';
     require_once __DIR__.'/../../../../lib/Gocdb_Services/Factory.php';
 
+    $configService = \Factory::getConfigservice();
+
     $filterParams = array();
 
 //    $scope = '%%';
@@ -68,6 +70,11 @@ function view_ngis() {
     $params['ngis'] = $ngis;
     $params['scopes']=$scopes;
     $params['selectedScopes']=$selectedScopes;
+
+    // adding the configurable ngi documentation link to the params array
+    $ngiDocLink = $configService->getNgiDocLink();
+    $params['ngiDocLink'] = $ngiDocLink;
+
     show_view('ngi/view_ngis.php', $params, "NGIs");
 }
 

htdocs/web_portal/controllers/project/view_all.php

@@ -22,9 +22,20 @@
 
 function show_all_projects() {
     require_once __DIR__.'/../../../../lib/Gocdb_Services/Factory.php';
-    $projects = \Factory::getProjectService()->getProjects();
+
+    $params = array();
+
+    $configService = \Factory::getConfigService();
+    $projectService = \Factory::getProjectService();
+
+    $projects = $projectService->getProjects();
     $params['Projects'] = $projects;
+
+    // adding the configurable project documentation link to the params array
+    $projectDocLink = $configService->getProjectDocLink();
+    $params['projectDocLink'] = $projectDocLink;
+
     show_view('project/view_all.php', $params, "Projects");
 }
 
-?>
+?>

htdocs/web_portal/controllers/service_group/view_all.php

@@ -22,6 +22,8 @@
 function showAllServiceGroups(){
     require_once __DIR__.'/../../../../lib/Gocdb_Services/Factory.php';
 
+    $configService = \Factory::getConfigService();
+
     $filterParams = array();
 
     // Scope parameters
@@ -90,5 +92,11 @@ function showAllServiceGroups(){
     $params['selectedExtKeyName'] = $extensionPropName; //$sgKeyNames;
     $params['selectedExtKeyValue'] = $extensionPropValue; //$sgKeyValues;
     $params['extKeyName'] = $keynames;
+
+    // adding the configurable service group documentation link
+    // to the params array.
+    $serviceGroupDocLink = $configService->getServiceGroupDocLink();
+    $params['serviceGroupDocLink'] = $serviceGroupDocLink;
+
     show_view("service_group/view_all.php", $params);
 }

htdocs/web_portal/views/ngi/view_ngis.php

@@ -13,7 +13,7 @@
             National Grid Initiatives
         </span>
         <span style="clear: both; float: left; padding-bottom: 0.4em;">
-            <a style="float: left; padding-top: 0.3em;" href="http://www.egi.eu/about/glossary/glossary_N.html">What is an NGI?</a>
+            <a style="float: left; padding-top: 0.3em;" href="<?php echo $params['ngiDocLink'] ?>">What is an NGI?</a>
         </span>
     </div>
 

htdocs/web_portal/views/project/view_all.php

@@ -11,7 +11,7 @@
         </span>
         <span style="clear: both; float: left; padding-bottom: 0.4em;">
 <!-- TODO: link            -->
-            <a style="float: left; padding-top: 0.3em;" href="https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Projects">
+            <a style="float: left; padding-top: 0.3em;" href="<?php echo $params['projectDocLink'] ?>">
                 What is a project?
             </a>
         </span>

htdocs/web_portal/views/service_group/view_all.php

@@ -10,7 +10,7 @@
             All Service Groups in GOCDB.
         </span>
         <span style="clear: both; float: left; padding-bottom: 0.4em;">
-            <a style="float: left; padding-top: 0.3em;" href="https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Service_Groups">
+            <a style="float: left; padding-top: 0.3em;" href="<?php echo $params['serviceGroupDocLink'] ?>">
                 What is a service group?
             </a>
         </span>

lib/Gocdb_Services/Config.php

@@ -567,4 +567,26 @@ public function getEmailTo()
 
         return $emailTo;
     }
+
+    public function getProjectDocLink()
+    {
+        $projectDocLink = $this->GetLocalInfoXML()->project->doc_link;
+
+        return $projectDocLink;
+    }
+
+    public function getNgiDocLink()
+    {
+        $ngiDocLink = $this->GetLocalInfoXML()->ngi->doc_link;
+
+        return $ngiDocLink;
+    }
+
+    public function getServiceGroupDocLink()
+    {
+        $localInfo = $this->GetLocalInfoXML();
+        $serviceGroupDocLink = $localInfo->service_group->doc_link;
+
+        return $serviceGroupDocLink;
+    }
 }