From 2374d7e0b1de7c589f61ecd4830ec1be2012e3a8 Mon Sep 17 00:00:00 2001
From: Chris Hallberg <crhallberg@gmail.com>
Date: Thu, 13 Sep 2012 19:07:40 -0400
Subject: [PATCH] Doc Blocks Part 1
---
module/VuFind/src/VuFind/Search/Manager.php | 9 +++++++++
module/VuFind/src/VuFind/Search/Minified.php | 9 +++++++++
.../src/VuFind/Search/MixedList/Params.php | 3 +++
module/VuFind/src/VuFind/Search/Solr/Params.php | 17 +++++++++++++++--
.../VuFind/src/VuFind/Search/Solr/Results.php | 4 +++-
.../VuFind/src/VuFind/Search/Summon/Options.php | 3 +++
.../VuFind/src/VuFind/Search/Summon/Params.php | 6 ++++++
.../VuFind/src/VuFind/Search/Summon/Results.php | 4 +++-
.../VuFind/src/VuFind/Search/UrlQueryHelper.php | 9 +++++++++
.../src/VuFind/Search/WorldCat/Params.php | 4 +++-
.../src/VuFind/Search/WorldCat/Results.php | 4 +++-
11 files changed, 66 insertions(+), 6 deletions(-)
diff --git a/module/VuFind/src/VuFind/Search/Manager.php b/module/VuFind/src/VuFind/Search/Manager.php
index 05e9354da24..7fa4554d9bc 100644
--- a/module/VuFind/src/VuFind/Search/Manager.php
+++ b/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();
/**
diff --git a/module/VuFind/src/VuFind/Search/Minified.php b/module/VuFind/src/VuFind/Search/Minified.php
index fc9491c4ab8..dd4d4625f81 100644
--- a/module/VuFind/src/VuFind/Search/Minified.php
+++ b/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;
/**
diff --git a/module/VuFind/src/VuFind/Search/MixedList/Params.php b/module/VuFind/src/VuFind/Search/MixedList/Params.php
index 2c383d1b67b..3bcd546011e 100644
--- a/module/VuFind/src/VuFind/Search/MixedList/Params.php
+++ b/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;
/**
diff --git a/module/VuFind/src/VuFind/Search/Solr/Params.php b/module/VuFind/src/VuFind/Search/Solr/Params.php
index a33a427046b..03be2c5ad3d 100644
--- a/module/VuFind/src/VuFind/Search/Solr/Params.php
+++ b/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;
/**
diff --git a/module/VuFind/src/VuFind/Search/Solr/Results.php b/module/VuFind/src/VuFind/Search/Solr/Results.php
index 393dffcdd0e..3e5b0bf6ed2 100644
--- a/module/VuFind/src/VuFind/Search/Solr/Results.php
+++ b/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;
/**
diff --git a/module/VuFind/src/VuFind/Search/Summon/Options.php b/module/VuFind/src/VuFind/Search/Summon/Options.php
index 8bddbba2c78..201c8c9c6b9 100644
--- a/module/VuFind/src/VuFind/Search/Summon/Options.php
+++ b/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;
/**
diff --git a/module/VuFind/src/VuFind/Search/Summon/Params.php b/module/VuFind/src/VuFind/Search/Summon/Params.php
index 008236c3435..149a298cdce 100644
--- a/module/VuFind/src/VuFind/Search/Summon/Params.php
+++ b/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();
/**
diff --git a/module/VuFind/src/VuFind/Search/Summon/Results.php b/module/VuFind/src/VuFind/Search/Summon/Results.php
index ffd5424e7fb..8bf28e69283 100644
--- a/module/VuFind/src/VuFind/Search/Summon/Results.php
+++ b/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;
/**
diff --git a/module/VuFind/src/VuFind/Search/UrlQueryHelper.php b/module/VuFind/src/VuFind/Search/UrlQueryHelper.php
index 634577d9ea0..03d849835ca 100644
--- a/module/VuFind/src/VuFind/Search/UrlQueryHelper.php
+++ b/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();
/**
diff --git a/module/VuFind/src/VuFind/Search/WorldCat/Params.php b/module/VuFind/src/VuFind/Search/WorldCat/Params.php
index 562355f0606..f3a05652528 100644
--- a/module/VuFind/src/VuFind/Search/WorldCat/Params.php
+++ b/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;
/**
diff --git a/module/VuFind/src/VuFind/Search/WorldCat/Results.php b/module/VuFind/src/VuFind/Search/WorldCat/Results.php
index 5e08e1b665c..f5cd79d3ee2 100644
--- a/module/VuFind/src/VuFind/Search/WorldCat/Results.php
+++ b/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;
/**
--
GitLab