Doc Blocks Part 1

module/VuFind/src/VuFind/Search/Manager.php

@@ -40,8 +40,17 @@ use Zend\ServiceManager\ServiceLocatorAwareInterface,
  */
 class Manager implements ServiceLocatorAwareInterface
 {
+    /**
+     * Scoped copy of the config array
+     */
     protected $config;
+    /**
+     * Search class id
+     */
     protected $classId = 'Solr';
+    /**
+     * An array of all the current options
+     */
     protected $optionsStore = array();
 
     /**

module/VuFind/src/VuFind/Search/Minified.php

@@ -52,8 +52,17 @@ namespace VuFind\Search;
  */
 class Minified
 {
+    /**
+     * Search terms
+     */
     public $t = array();
+    /**
+     * Filters
+     */
     public $f = array();
+    /**
+     * ID, start tIme, query Speed, Result total, search TYpe, search CLass id
+     */
     public $id, $i, $s, $r, $ty, $pc, $rc;
 
     /**

module/VuFind/src/VuFind/Search/MixedList/Params.php

@@ -39,6 +39,9 @@ use VuFind\Search\Base\Params as BaseParams;
  */
 class Params extends BaseParams
 {
+    /**
+     * Array of target record ids
+     */
     protected $recordsToRequest;
 
     /**

module/VuFind/src/VuFind/Search/Solr/Params.php

@@ -39,13 +39,26 @@ use VuFind\Config\Reader as ConfigReader, VuFind\Search\Base\Params as BaseParam
  */
 class Params extends BaseParams
 {
-    // Facets
+    /**
+     * Facet result limit
+     */
     protected $facetLimit = 30;
+    /**
+     * Offset for facet results
+     */
     protected $facetOffset = null;
+    /**
+     * Prefix for facet searching
+     */
     protected $facetPrefix = null;
+    /**
+     * Sorting order for facet search results
+     */
     protected $facetSort = null;
 
-    // Override Query
+    /**
+     * Override Query
+     */
     protected $overrideQuery = false;
 
     /**

module/VuFind/src/VuFind/Search/Solr/Results.php

@@ -42,7 +42,9 @@ use VuFind\Config\Reader as ConfigReader,
  */
 class Results extends BaseResults
 {
-    // Raw Solr search response:
+    /**
+     * Raw Solr search response:
+     */
     protected $rawResponse = null;
 
     /**

module/VuFind/src/VuFind/Search/Summon/Options.php

@@ -40,6 +40,9 @@ use VuFind\Config\Reader as ConfigReader,
  */
 class Options extends BaseOptions
 {
+    /**
+     * Maximum number of results
+     */
     protected $resultLimit = 400;
 
     /**

module/VuFind/src/VuFind/Search/Summon/Params.php

@@ -39,7 +39,13 @@ use VuFind\Search\Base\Params as BaseParams;
  */
 class Params extends BaseParams
 {
+    /**
+     * Settings for all the facets
+     */
     protected $fullFacetSettings = array();
+    /**
+     * Settings for the date facet only
+     */
     protected $dateFacetSettings = array();
 
     /**

module/VuFind/src/VuFind/Search/Summon/Results.php

@@ -43,7 +43,9 @@ use VuFind\Config\Reader as ConfigReader,
  */
 class Results extends BaseResults
 {
-    // Raw search response:
+    /**
+     * Raw search response:
+     */
     protected $rawResponse = null;
 
     /**

module/VuFind/src/VuFind/Search/UrlQueryHelper.php

@@ -38,8 +38,17 @@ namespace VuFind\Search;
  */
 class UrlQueryHelper
 {
+    /**
+     * Results object
+     */
     protected $results;
+    /**
+     * URL search param
+     */
     protected $basicSearchParam = 'lookfor';
+    /**
+     * Base parameters for every search
+     */
     protected $defaultParams = array();
 
     /**

module/VuFind/src/VuFind/Search/WorldCat/Params.php

@@ -39,7 +39,9 @@ use VuFind\Search\Base\Params as BaseParams;
  */
 class Params extends BaseParams
 {
-    // Override Query
+    /**
+     * Override Query
+     */
     protected $overrideQuery = false;
 
     /**

module/VuFind/src/VuFind/Search/WorldCat/Results.php

@@ -41,7 +41,9 @@ use VuFind\Config\Reader as ConfigReader,
  */
 class Results extends BaseResults
 {
-    // Raw search response:
+    /**
+     * Raw search response:
+     */
     protected $rawResponse = null;
 
     /**