From b0f26f3f7b9b43bd4389170ccc12de34d22fc84d Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Fri, 17 Aug 2012 10:32:36 -0400
Subject: [PATCH] Fixed some outdated comments.
---
.../VuFind/src/VuFind/Controller/Plugin/ResultScroller.php | 6 +++---
module/VuFind/src/VuFind/Db/Table/Search.php | 6 +++---
module/VuFind/src/VuFind/Recommend/SearchObject.php | 2 +-
module/VuFind/src/VuFind/Search/Base/Params.php | 5 +++--
module/VuFind/src/VuFind/Search/Base/Results.php | 4 ++--
module/VuFind/src/VuFind/Search/Favorites/Params.php | 3 ++-
module/VuFind/src/VuFind/Search/Options.php | 2 +-
module/VuFind/src/VuFind/Search/SolrAuth/Results.php | 7 ++++---
module/VuFind/src/VuFind/Search/SolrAuthor/Results.php | 2 +-
module/VuFind/src/VuFind/Search/UrlHelper.php | 2 +-
module/VuFind/src/VuFind/Statistics/Record.php | 2 +-
module/VuFind/src/VuFind/Statistics/Search.php | 2 +-
module/VuFind/src/VuFind/Theme/Root/Helper/OfflineMode.php | 4 ++--
.../VuFind/src/VuFind/Theme/Root/Helper/SearchOptions.php | 4 ++--
14 files changed, 27 insertions(+), 24 deletions(-)
diff --git a/module/VuFind/src/VuFind/Controller/Plugin/ResultScroller.php b/module/VuFind/src/VuFind/Controller/Plugin/ResultScroller.php
index 201e9006aed..4893b48dbab 100644
--- a/module/VuFind/src/VuFind/Controller/Plugin/ResultScroller.php
+++ b/module/VuFind/src/VuFind/Controller/Plugin/ResultScroller.php
@@ -62,7 +62,7 @@ class ResultScroller extends AbstractPlugin
* Initialize this result set scroller. This should only be called
* prior to displaying the results of a new search.
*
- * @param VF_Search_Base_Results $searchObject The search object that was
+ * @param \VuFind\Search\Base\Results $searchObject The search object that was
* used to execute the last search.
*
* @return bool
@@ -324,7 +324,7 @@ class ResultScroller extends AbstractPlugin
/**
* Restore the last saved search.
*
- * @return VF_Search_Base_Results
+ * @return \VuFind\Search\Base\Results
*/
protected function restoreLastSearch()
{
@@ -342,7 +342,7 @@ class ResultScroller extends AbstractPlugin
/**
* Update the remembered "last search" in the session.
*
- * @param VF_Search_Base_Results $search Search object to remember.
+ * @param \VuFind\Search\Base\Results $search Search object to remember.
*
* @return void
*/
diff --git a/module/VuFind/src/VuFind/Db/Table/Search.php b/module/VuFind/src/VuFind/Db/Table/Search.php
index f9b6206edb0..f8e385da1df 100644
--- a/module/VuFind/src/VuFind/Db/Table/Search.php
+++ b/module/VuFind/src/VuFind/Db/Table/Search.php
@@ -140,9 +140,9 @@ class Search extends Gateway
/**
* Add a search into the search table (history)
*
- * @param VF_Search_Base_Results $newSearch Search to save
- * @param string $sessionId Current session ID
- * @param array $searchHistory Existing saved searches (for
+ * @param \VuFind\Search\Base\Results $newSearch Search to save
+ * @param string $sessionId Current session ID
+ * @param array $searchHistory Existing saved searches (for
* deduplication purposes)
*
* @return void
diff --git a/module/VuFind/src/VuFind/Recommend/SearchObject.php b/module/VuFind/src/VuFind/Recommend/SearchObject.php
index 59723cc0eab..70a3c9271d7 100644
--- a/module/VuFind/src/VuFind/Recommend/SearchObject.php
+++ b/module/VuFind/src/VuFind/Recommend/SearchObject.php
@@ -108,7 +108,7 @@ abstract class SearchObject implements RecommendInterface
/**
* Get search results.
*
- * @return VF_Search_Base_Results
+ * @return \VuFind\Search\Base\Results
*/
public function getResults()
{
diff --git a/module/VuFind/src/VuFind/Search/Base/Params.php b/module/VuFind/src/VuFind/Search/Base/Params.php
index 17f1debc799..d8ab6da9668 100644
--- a/module/VuFind/src/VuFind/Search/Base/Params.php
+++ b/module/VuFind/src/VuFind/Search/Base/Params.php
@@ -56,7 +56,7 @@ class Params
protected $selectedShards = array();
// View
protected $view = null;
- // VF_Search_Base_Options subclass
+ // \VuFind\Search\Base\Options subclass
protected $options;
// Recommendation settings
protected $recommend = array();
@@ -69,7 +69,8 @@ class Params
/**
* Constructor
*
- * @param VF_Search_Base_Options $options Options to use (null to load defaults)
+ * @param \VuFind\Search\Base\Options $options Options to use (null to load
+ * defaults)
*/
public function __construct($options = null)
{
diff --git a/module/VuFind/src/VuFind/Search/Base/Results.php b/module/VuFind/src/VuFind/Search/Base/Results.php
index af4af4689f3..bf9e4e2f98d 100644
--- a/module/VuFind/src/VuFind/Search/Base/Results.php
+++ b/module/VuFind/src/VuFind/Search/Base/Results.php
@@ -64,7 +64,7 @@ abstract class Results
/**
* Constructor
*
- * @param VF_Search_Base_Params $params Object representing user search
+ * @param \VuFind\Search\Base\Params $params Object representing user search
* parameters.
*/
public function __construct(Params $params)
@@ -86,7 +86,7 @@ abstract class Results
/**
* Get the URL helper for this object.
*
- * @return VF_Search_UrlHelper
+ * @return UrlHelper
*/
public function getUrl()
{
diff --git a/module/VuFind/src/VuFind/Search/Favorites/Params.php b/module/VuFind/src/VuFind/Search/Favorites/Params.php
index d71072c99aa..a2fe228fa46 100644
--- a/module/VuFind/src/VuFind/Search/Favorites/Params.php
+++ b/module/VuFind/src/VuFind/Search/Favorites/Params.php
@@ -44,7 +44,8 @@ class Params extends BaseParams
/**
* Constructor
*
- * @param VF_Search_Base_Options $options Options to use (null to load defaults)
+ * @param \VuFind\Search\Base\Options $options Options to use (null to load
+ * defaults)
*/
public function __construct($options = null)
{
diff --git a/module/VuFind/src/VuFind/Search/Options.php b/module/VuFind/src/VuFind/Search/Options.php
index a5e0b189372..9c95b53bd7e 100644
--- a/module/VuFind/src/VuFind/Search/Options.php
+++ b/module/VuFind/src/VuFind/Search/Options.php
@@ -43,7 +43,7 @@ class Options
*
* @param string $type The search type of the object to retrieve
*
- * @return VF_Search_Base_Options
+ * @return \VuFind\Search\Base\Options
*/
public static function getInstance($type)
{
diff --git a/module/VuFind/src/VuFind/Search/SolrAuth/Results.php b/module/VuFind/src/VuFind/Search/SolrAuth/Results.php
index 755eff52ade..21f7e7ddede 100644
--- a/module/VuFind/src/VuFind/Search/SolrAuth/Results.php
+++ b/module/VuFind/src/VuFind/Search/SolrAuth/Results.php
@@ -44,7 +44,7 @@ class Results extends SolrResults
/**
* Constructor
*
- * @param VF_Search_Base_Params $params Object representing user search
+ * @param \VuFind\Search\Base\Params $params Object representing user search
* parameters.
*/
public function __construct(BaseParams $params)
@@ -57,9 +57,10 @@ class Results extends SolrResults
*
* @param null|array $shards Selected shards to use (null for defaults)
* @param string $index ID of index/search classes to use (this assumes
- * that VF_Search_$index_Options and VF_Connection_$index are both valid classes)
+ * that \VuFind\Search\$index\Options and VuFind\Connection\$index are both
+ * valid classes)
*
- * @return VF_Connection_Solr
+ * @return VuFind\Connection\Solr
*/
public static function getSolrConnection($shards = null, $index = 'SolrAuth')
{
diff --git a/module/VuFind/src/VuFind/Search/SolrAuthor/Results.php b/module/VuFind/src/VuFind/Search/SolrAuthor/Results.php
index 937812610b9..26256969ef0 100644
--- a/module/VuFind/src/VuFind/Search/SolrAuthor/Results.php
+++ b/module/VuFind/src/VuFind/Search/SolrAuthor/Results.php
@@ -43,7 +43,7 @@ class Results extends SolrResults
/**
* Constructor
*
- * @param VF_Search_Base_Params $params Object representing user search
+ * @param \VuFind\Search\Base\Params $params Object representing user search
* parameters.
*/
public function __construct($params)
diff --git a/module/VuFind/src/VuFind/Search/UrlHelper.php b/module/VuFind/src/VuFind/Search/UrlHelper.php
index 62244a6494e..31ad91cefcd 100644
--- a/module/VuFind/src/VuFind/Search/UrlHelper.php
+++ b/module/VuFind/src/VuFind/Search/UrlHelper.php
@@ -45,7 +45,7 @@ class UrlHelper
/**
* Constructor
*
- * @param VF_Search_Base_Results $results VuFind search results object.
+ * @param \VuFind\Search\Base\Results $results VuFind search results object.
*/
public function __construct($results)
{
diff --git a/module/VuFind/src/VuFind/Statistics/Record.php b/module/VuFind/src/VuFind/Statistics/Record.php
index 200b9137646..d4bf0f9789b 100644
--- a/module/VuFind/src/VuFind/Statistics/Record.php
+++ b/module/VuFind/src/VuFind/Statistics/Record.php
@@ -41,7 +41,7 @@ class Record extends AbstractBase
/**
* Saves the record view to wherever the config [Statistics] says so
*
- * @param VF_Search_Solr_Results $data Results from Search controller
+ * @param \VuFind\Search\Base\Results $data Results from Search controller
* @param Zend_Controller_Request_Http $request Request data
*
* @return void
diff --git a/module/VuFind/src/VuFind/Statistics/Search.php b/module/VuFind/src/VuFind/Statistics/Search.php
index 7cd3e3c0b91..246819fbe13 100644
--- a/module/VuFind/src/VuFind/Statistics/Search.php
+++ b/module/VuFind/src/VuFind/Statistics/Search.php
@@ -41,7 +41,7 @@ class Search extends AbstractBase
/**
* Saves the search to wherever the config [Statistics] says so
*
- * @param VF_Search_Solr_Results $data Results from Search controller
+ * @param \VuFind\Search\Base\Results $data Results from Search controller
* @param Zend_Controller_Request_Http $request Request data from the controller
*
* @return void
diff --git a/module/VuFind/src/VuFind/Theme/Root/Helper/OfflineMode.php b/module/VuFind/src/VuFind/Theme/Root/Helper/OfflineMode.php
index ef5c135fd9d..1d23c17a1ce 100644
--- a/module/VuFind/src/VuFind/Theme/Root/Helper/OfflineMode.php
+++ b/module/VuFind/src/VuFind/Theme/Root/Helper/OfflineMode.php
@@ -41,9 +41,9 @@ use VuFind\Connection\Manager as ConnectionManager,
class OfflineMode extends AbstractHelper
{
/**
- * Wrapper function to the VF_Search_Options getInstance function
+ * Wrapper function to the get the catalog's current offline mode.
*
- * @return SearchOptions
+ * @return string
*/
public function __invoke()
{
diff --git a/module/VuFind/src/VuFind/Theme/Root/Helper/SearchOptions.php b/module/VuFind/src/VuFind/Theme/Root/Helper/SearchOptions.php
index e71341e525f..5b796e3bc47 100644
--- a/module/VuFind/src/VuFind/Theme/Root/Helper/SearchOptions.php
+++ b/module/VuFind/src/VuFind/Theme/Root/Helper/SearchOptions.php
@@ -40,11 +40,11 @@ use VuFind\Search\Options, Zend\View\Helper\AbstractHelper;
class SearchOptions extends AbstractHelper
{
/**
- * Wrapper function to the VF_Search_Options getInstance function
+ * Wrapper function to the \VuFind\Search\Options getInstance function
*
* @param string $type The search type of the object to retrieve
*
- * @return SearchOptions
+ * @return \VuFind\Search\Base\Options
*/
public function __invoke($type = 'Solr')
{
--
GitLab