Fix styles and add missing comments

vufind-org · Oct 8, 2024 · ec2dc6c · ec2dc6c
1 parent 86abb67
commit ec2dc6c
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 17 deletions.
diff --git a/module/VuFind/src/VuFind/Controller/ProQuestFSGrecordController.php b/module/VuFind/src/VuFind/Controller/ProQuestFSGrecordController.php
@@ -31,7 +31,6 @@
 namespace VuFind\Controller;
 
 use Laminas\ServiceManager\ServiceLocatorInterface;
-use VuFindSearch\ParamBag;
 
 /**
  * ProQuest Federated Search Gateway Record Controller

diff --git a/module/VuFind/src/VuFind/Search/ProQuestFSG/Options.php b/module/VuFind/src/VuFind/Search/ProQuestFSG/Options.php
@@ -64,7 +64,7 @@ public function __construct(\VuFind\Config\PluginManager $configLoader)
         if (isset($searchSettings->General->limit_options)) {
             $this->limitOptions = $this->explodeListSetting($searchSettings->General->limit_options);
         }
-        
+
         // Search handler setup:
         $this->defaultHandler = 'cql.serverChoice';
         if (isset($searchSettings->Basic_Searches)) {

diff --git a/module/VuFind/src/VuFind/Search/ProQuestFSG/Params.php b/module/VuFind/src/VuFind/Search/ProQuestFSG/Params.php
@@ -71,7 +71,6 @@ public function getBackendParameters()
             }
         }
 
-
         return $backendParams;
     }
 
@@ -88,5 +87,4 @@ public function getFacetValueRawDisplayText(string $field, string $value): strin
         $parts = explode('|', $value);
         return end($parts);
     }
-
 }
diff --git a/module/VuFind/src/VuFind/Search/ProQuestFSG/Results.php b/module/VuFind/src/VuFind/Search/ProQuestFSG/Results.php
@@ -49,8 +49,18 @@ class Results extends \VuFind\Search\Base\Results
      */
     protected $backendId = 'ProQuestFSG';
 
+    /**
+     * Facets returned in search response.
+     *
+     * @var array
+     */
     protected $responseFacets = null;
 
+    /**
+     * Simplified version of result facets.
+     *
+     * @var array
+     */
     protected $simplifiedResponseFacets = null;
 
     /**
@@ -94,6 +104,13 @@ public function getFacetList($filter = null)
         return $this->buildFacetList($this->simplifiedResponseFacets, $filter);
     }
 
+    /**
+     * Simply raw ProQuestFSG facets to the form that VuFind templates expect.
+     *
+     * @param array $rawFacets Raw facts returned from the record collection
+     *
+     * @return array Simple format of facets
+     */
     protected function simplifyFacets($rawFacets)
     {
         $simpleFacets = [];
@@ -107,5 +124,4 @@ protected function simplifyFacets($rawFacets)
         }
         return $simpleFacets;
     }
-
 }
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/ProQuestFSG/Connector.php b/module/VuFindSearch/src/VuFindSearch/Backend/ProQuestFSG/Connector.php
@@ -32,6 +32,9 @@
 
 use VuFindSearch\ParamBag;
 
+use function intval;
+use function strval;
+
 /**
  * WorldCat SRU Search Interface
  *
@@ -57,13 +60,16 @@ class Connector extends \VuFindSearch\Backend\SRU\Connector
      */
     protected $sruVersion = '1.2';
 
+    /**
+     * The default path, if a particular database target is not indicated.
+     *
+     * @var string
+     */
     protected $defaultPath = '/all_subscribed';
 
-
     /**
      * Constructor
      *
-     * @param string               $wsKey   Web services key
      * @param \Laminas\Http\Client $client  An HTTP client object
      * @param array                $options Additional config settings
      */
@@ -119,8 +125,7 @@ public function search(ParamBag $params, $offset, $limit)
             [$filterKey, $filterValue] = explode(':', $filter, 2);
             if ('Databases' == $filterKey) {
                 $path = '/' . $filterValue;
-            }
-            else {
+            } else {
                 $filterRelationValue = $filterValue ?
                     '=' . $filterValue :
                     '=1';

diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/ProQuestFSG/QueryBuilder.php b/module/VuFindSearch/src/VuFindSearch/Backend/ProQuestFSG/QueryBuilder.php
@@ -53,13 +53,6 @@
  */
 class QueryBuilder
 {
-    /**
-     * OCLC code to exclude from results
-     *
-     * @var string
-     */
-    protected $oclcCodeToExclude;
-
     /// Public API
 
     /**

diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/SRU/Connector.php b/module/VuFindSearch/src/VuFindSearch/Backend/SRU/Connector.php
@@ -201,6 +201,7 @@ public function checkForHttpError($result)
      * Submit REST Request
      *
      * @param string $method  HTTP Method to use: GET or POST
+     * @param string $path    URL path following $this->host
      * @param array  $params  An array of parameters for the request
      * @param bool   $process Should we convert the MARCXML?
      *
@@ -246,7 +247,7 @@ protected function call($method = 'GET', $path = '', $params = null, $process =
             $resultBody = $result->getBody();
             if ($cacheKey) {
                 $this->putCachedData($cacheKey, $resultBody);
-            }    
+            }
         }
 
         // Return processed or unprocessed response, as appropriate:
-Original file line number
+Diff line change
@@ Expand Up / @@ -71,7 +71,6 @@ public function getBackendParameters() @@
                 }
             }
             return $backendParams;
         }
@@ Expand All @@
             $parts = explode('|', $value);
             return end($parts);
         }
     }