From f51f495319b708e5c60e6a0e5c110be1fe210904 Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Wed, 22 Feb 2017 15:58:46 -0500
Subject: [PATCH] Corrected/standardized comment.
---
module/VuFind/src/VuFind/Search/Base/Options.php | 6 +++---
module/VuFind/src/VuFind/Search/Solr/Options.php | 5 +++--
module/VuFind/src/VuFind/Search/SolrWeb/Options.php | 5 +++--
module/VuFind/src/VuFind/Search/Summon/Options.php | 5 +++--
4 files changed, 12 insertions(+), 9 deletions(-)
diff --git a/module/VuFind/src/VuFind/Search/Base/Options.php b/module/VuFind/src/VuFind/Search/Base/Options.php
index a02f9c418b1..468106e7f0d 100644
--- a/module/VuFind/src/VuFind/Search/Base/Options.php
+++ b/module/VuFind/src/VuFind/Search/Base/Options.php
@@ -733,10 +733,10 @@ abstract class Options implements TranslatorAwareInterface
}
/**
- * Return the route name for the search results action.
- * false to cover unimplemented drivers
+ * Return the route name for the facet list action. Returns false to cover
+ * unimplemented support.
*
- * @return false
+ * @return string|bool
*/
public function getFacetListAction()
{
diff --git a/module/VuFind/src/VuFind/Search/Solr/Options.php b/module/VuFind/src/VuFind/Search/Solr/Options.php
index 5b07bcb9335..6855645189e 100644
--- a/module/VuFind/src/VuFind/Search/Solr/Options.php
+++ b/module/VuFind/src/VuFind/Search/Solr/Options.php
@@ -272,9 +272,10 @@ class Options extends \VuFind\Search\Base\Options
}
/**
- * Return the route name for the search results action.
+ * Return the route name for the facet list action. Returns false to cover
+ * unimplemented support.
*
- * @return string
+ * @return string|bool
*/
public function getFacetListAction()
{
diff --git a/module/VuFind/src/VuFind/Search/SolrWeb/Options.php b/module/VuFind/src/VuFind/Search/SolrWeb/Options.php
index 7470651e5b2..33ab274b440 100644
--- a/module/VuFind/src/VuFind/Search/SolrWeb/Options.php
+++ b/module/VuFind/src/VuFind/Search/SolrWeb/Options.php
@@ -72,9 +72,10 @@ class Options extends \VuFind\Search\Solr\Options
}
/**
- * Return the route name for the search results action.
+ * Return the route name for the facet list action. Returns false to cover
+ * unimplemented support.
*
- * @return string
+ * @return string|bool
*/
public function getFacetListAction()
{
diff --git a/module/VuFind/src/VuFind/Search/Summon/Options.php b/module/VuFind/src/VuFind/Search/Summon/Options.php
index a8b0e20d020..9b438287149 100644
--- a/module/VuFind/src/VuFind/Search/Summon/Options.php
+++ b/module/VuFind/src/VuFind/Search/Summon/Options.php
@@ -186,9 +186,10 @@ class Options extends \VuFind\Search\Base\Options
}
/**
- * Return the route name for the search results action.
+ * Return the route name for the facet list action. Returns false to cover
+ * unimplemented support.
*
- * @return string
+ * @return string|bool
*/
public function getFacetListAction()
{
--
GitLab