From eaff07e2c0275cb65a526fab89d15c72d879edfc Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Tue, 7 Feb 2017 15:20:05 -0500
Subject: [PATCH] Inject hierarchical facet helper through factory.
---
module/VuFind/config/module.config.php | 3 +
.../src/VuFind/Search/Params/Factory.php | 57 +++++++++++++++++++
.../VuFind/Search/Params/PluginFactory.php | 12 ++--
.../VuFind/src/VuFind/Search/Solr/Params.php | 24 +++++---
4 files changed, 82 insertions(+), 14 deletions(-)
create mode 100644 module/VuFind/src/VuFind/Search/Params/Factory.php
diff --git a/module/VuFind/config/module.config.php b/module/VuFind/config/module.config.php
index 50236a6b063..b2308287836 100644
--- a/module/VuFind/config/module.config.php
+++ b/module/VuFind/config/module.config.php
@@ -602,6 +602,9 @@ $config = [
],
'search_params' => [
'abstract_factories' => ['VuFind\Search\Params\PluginFactory'],
+ 'factories' => [
+ 'solr' => 'VuFind\Search\Params\Factory::getSolr',
+ ],
],
'search_results' => [
'abstract_factories' => ['VuFind\Search\Results\PluginFactory'],
diff --git a/module/VuFind/src/VuFind/Search/Params/Factory.php b/module/VuFind/src/VuFind/Search/Params/Factory.php
new file mode 100644
index 00000000000..aea1efa416d
--- /dev/null
+++ b/module/VuFind/src/VuFind/Search/Params/Factory.php
@@ -0,0 +1,57 @@
+<?php
+/**
+ * Search Params Object Factory Class
+ *
+ * PHP version 5
+ *
+ * Copyright (C) Villanova University 2017.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * @category VuFind
+ * @package Search
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://vufind.org/wiki/development:plugins:hierarchy_components Wiki
+ */
+namespace VuFind\Search\Params;
+use Zend\ServiceManager\ServiceManager;
+
+/**
+ * Search Params Object Factory Class
+ *
+ * @category VuFind
+ * @package Search
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://vufind.org/wiki/development:plugins:hierarchy_components Wiki
+ *
+ * @codeCoverageIgnore
+ */
+class Factory
+{
+ /**
+ * Factory for Solr results object.
+ *
+ * @param ServiceManager $sm Service manager.
+ *
+ * @return \VuFind\Search\Solr\Results
+ */
+ public static function getSolr(ServiceManager $sm)
+ {
+ $factory = new PluginFactory();
+ $helper = $sm->getServiceLocator()->get('VuFind\HierarchicalFacetHelper');
+ return $factory->createServiceWithName($sm, 'solr', 'Solr', [$helper]);
+ }
+}
diff --git a/module/VuFind/src/VuFind/Search/Params/PluginFactory.php b/module/VuFind/src/VuFind/Search/Params/PluginFactory.php
index 4caff16388b..cc12adc1424 100644
--- a/module/VuFind/src/VuFind/Search/Params/PluginFactory.php
+++ b/module/VuFind/src/VuFind/Search/Params/PluginFactory.php
@@ -54,19 +54,21 @@ class PluginFactory extends \VuFind\ServiceManager\AbstractPluginFactory
* @param ServiceLocatorInterface $serviceLocator Service locator
* @param string $name Name of service
* @param string $requestedName Unfiltered name of service
+ * @param array $extraParams Extra constructor parameters
+ * (to follow the Options object and config loader)
*
* @return object
*/
public function createServiceWithName(ServiceLocatorInterface $serviceLocator,
- $name, $requestedName
+ $name, $requestedName, array $extraParams = []
) {
$options = $serviceLocator->getServiceLocator()
->get('VuFind\SearchOptionsPluginManager')->get($requestedName);
$class = $this->getClassName($name, $requestedName);
+ $configLoader = $serviceLocator->getServiceLocator()->get('VuFind\Config');
+ array_unshift($extraParams, $configLoader);
// Clone the options instance in case caller modifies it:
- return new $class(
- clone($options),
- $serviceLocator->getServiceLocator()->get('VuFind\Config')
- );
+ array_unshift($extraParams, clone($options));
+ return new $class(...$extraParams);
}
}
diff --git a/module/VuFind/src/VuFind/Search/Solr/Params.php b/module/VuFind/src/VuFind/Search/Solr/Params.php
index e234c2f863f..9aa8e56d2e5 100644
--- a/module/VuFind/src/VuFind/Search/Solr/Params.php
+++ b/module/VuFind/src/VuFind/Search/Solr/Params.php
@@ -88,15 +88,26 @@ class Params extends \VuFind\Search\Base\Params
*/
protected $pivotFacets = null;
+ /**
+ * Hierarchical Facet Helper
+ *
+ * @var HierarchicalFacetHelper
+ */
+ protected $facetHelper;
+
/**
* Constructor
*
* @param \VuFind\Search\Base\Options $options Options to use
* @param \VuFind\Config\PluginManager $configLoader Config loader
+ * @param HierarchicalFacetHelper $facetHelper Hierarchical facet helper
*/
- public function __construct($options, \VuFind\Config\PluginManager $configLoader)
- {
+ public function __construct($options, \VuFind\Config\PluginManager $configLoader,
+ HierarchicalFacetHelper $facetHelper = null
+ ) {
parent::__construct($options, $configLoader);
+ $this->facetHelper = $facetHelper;
+
// Use basic facet limit by default, if set:
$config = $configLoader->get($options->getFacetsIni());
if (isset($config->Results_Settings->facet_limit)
@@ -589,11 +600,6 @@ class Params extends \VuFind\Search\Base\Params
$hierarchicalFacets = $this->getOptions()->getHierarchicalFacets();
$hierarchicalFacetSeparators
= $this->getOptions()->getHierarchicalFacetSeparators();
- $facetHelper = null;
- if (!empty($hierarchicalFacets)) {
- $facetHelper = $this->getServiceLocator()
- ->get('VuFind\HierarchicalFacetHelper');
- }
// Convert range queries to a language-non-specific format:
$caseInsensitiveRegex = '/^\(\[(.*) TO (.*)\] OR \[(.*) TO (.*)\]\)$/';
if (preg_match('/^\[(.*) TO (.*)\]$/', $value, $matches)) {
@@ -607,12 +613,12 @@ class Params extends \VuFind\Search\Base\Params
) {
$filter['displayText'] = $matches[1] . '-' . $matches[2];
}
- } else if (in_array($field, $hierarchicalFacets)) {
+ } else if ($this->facetHelper && in_array($field, $hierarchicalFacets)) {
// Display hierarchical facet levels nicely
$separator = isset($hierarchicalFacetSeparators[$field])
? $hierarchicalFacetSeparators[$field]
: '/';
- $filter['displayText'] = $facetHelper->formatDisplayText(
+ $filter['displayText'] = $this->facetHelper->formatDisplayText(
$filter['displayText'], true, $separator
);
if ($translate) {
--
GitLab