diff --git a/config/schema/facetapi.facet.schema.yml b/config/schema/facetapi.facet.schema.yml index 4e01c27..8c43ce6 100644 --- a/config/schema/facetapi.facet.schema.yml +++ b/config/schema/facetapi.facet.schema.yml @@ -14,9 +14,9 @@ facetapi.facet.*: status: type: boolean label: 'Status' - url_parameter: + url_alias: type: label - label: 'URL Parameter name' + label: 'Name of the facet as used in the URL' facet_source_id: type: string label: 'Facet source id' diff --git a/src/Entity/Facet.php b/src/Entity/Facet.php index 761faa9..7af3c13 100644 --- a/src/Entity/Facet.php +++ b/src/Entity/Facet.php @@ -7,7 +7,6 @@ namespace Drupal\facetapi\Entity; -use Drupal\Component\Utility\Xss; use Drupal\Core\Config\Entity\ConfigEntityBase; use Drupal\facetapi\FacetInterface; @@ -77,7 +76,7 @@ class Facet extends ConfigEntityBase implements FacetInterface { * * @var string */ - protected $url_parameter; + protected $url_alias; /** * A string describing the index. @@ -468,15 +467,15 @@ class Facet extends ConfigEntityBase implements FacetInterface { /** * {@inheritdoc} */ - public function getUrlParameter() { - return $this->url_parameter; + public function getUrlAlias() { + return $this->url_alias; } /** * {@inheritdoc} */ - public function setUrlParameter($url_parameter) { - $this->url_parameter = Xss::filter($url_parameter); + public function setUrlAlias($url_alias) { + $this->url_alias = $url_alias; } /** diff --git a/src/FacetInterface.php b/src/FacetInterface.php index 0095dd3..ca905eb 100644 --- a/src/FacetInterface.php +++ b/src/FacetInterface.php @@ -63,14 +63,14 @@ interface FacetInterface extends ConfigEntityInterface { * * @param string $url_parameter */ - public function getUrlParameter(); + public function getUrlAlias(); /** * Sets the name of the facet for use in the URL. * - * @param string $url_parameter + * @param string $url_alias */ - public function setUrlParameter($url_parameter); + public function setUrlAlias($url_alias); /** * Sets an item with value to active. diff --git a/src/Form/FacetForm.php b/src/Form/FacetForm.php index 4a5be4e..6c5dc35 100644 --- a/src/Form/FacetForm.php +++ b/src/Form/FacetForm.php @@ -174,10 +174,10 @@ class FacetForm extends EntityForm { ], ]; - $form['url_parameter'] = [ + $form['url_alias'] = [ '#type' => 'textfield', '#title' => $this->t('The name of the facet for usage in URLs'), - '#default_value' => $facet->getUrlParameter(), + '#default_value' => $facet->getUrlAlias(), '#maxlength' => 50, '#required' => TRUE, ]; diff --git a/src/Plugin/facetapi/processor/QueryStringUrlProcessor.php b/src/Plugin/facetapi/processor/QueryStringUrlProcessor.php index 1b22481..80db124 100644 --- a/src/Plugin/facetapi/processor/QueryStringUrlProcessor.php +++ b/src/Plugin/facetapi/processor/QueryStringUrlProcessor.php @@ -36,7 +36,7 @@ class QueryStringUrlProcessor extends UrlProcessorPluginBase { * * @var string */ - protected $url_parameter; + protected $url_alias; /** * @var array @@ -56,7 +56,6 @@ class QueryStringUrlProcessor extends UrlProcessorPluginBase { * {@inheritdoc} */ public function build(FacetInterface $facet, array $results) { - // Create links for all the values. // First get the current list of get parameters. $get_params = $this->request->query; @@ -66,11 +65,11 @@ class QueryStringUrlProcessor extends UrlProcessorPluginBase { return []; } - $this->url_parameter = $facet->getUrlParameter(); + $this->url_alias = $facet->getUrlAlias(); /** @var \Drupal\facetapi\Result\ResultInterface $result */ foreach ($results as &$result) { - $filter_string = $this->url_parameter . ':' . $result->getRawValue(); + $filter_string = $this->url_alias . ':' . $result->getRawValue(); $result_get_params = clone $get_params; $filter_params = $result_get_params->get($this->filter_key, [], TRUE); @@ -106,11 +105,11 @@ class QueryStringUrlProcessor extends UrlProcessorPluginBase { */ public function preQuery(FacetInterface $facet) { - $this->url_parameter = $facet->getUrlParameter(); + $this->url_alias = $facet->getUrlAlias(); // Get the filter key of the facet. - if (isset($this->active_filters[$this->url_parameter])) { - foreach ($this->active_filters[$this->url_parameter] as $value) { + if (isset($this->active_filters[$this->url_alias])) { + foreach ($this->active_filters[$this->url_alias] as $value) { $facet->setActiveItem(trim($value, '"')); } } diff --git a/tests/src/Unit/Plugin/processor/QueryStringUrlProcessorTest.php b/tests/src/Unit/Plugin/processor/QueryStringUrlProcessorTest.php index 6000497..1e56a8a 100644 --- a/tests/src/Unit/Plugin/processor/QueryStringUrlProcessorTest.php +++ b/tests/src/Unit/Plugin/processor/QueryStringUrlProcessorTest.php @@ -52,7 +52,7 @@ class QueryStringUrlProcessorTest extends UnitTestCase { public function testSetSingleActiveItem() { $facet = new Facet([], 'facet'); $facet->setResults($this->original_results); - $facet->setFieldIdentifier('test'); + $facet->setUrlAlias('test'); $request = new Request; $request->query->set('f', ['test:badger']); @@ -66,7 +66,7 @@ class QueryStringUrlProcessorTest extends UnitTestCase { public function testSetMultipleActiveItems() { $facet = new Facet([], 'facet'); $facet->setResults($this->original_results); - $facet->setFieldIdentifier('test'); + $facet->setUrlAlias('test'); $request = new Request; $request->query->set('f', ['test:badger', 'test:mushroom', 'donkey:kong']); @@ -91,7 +91,7 @@ class QueryStringUrlProcessorTest extends UnitTestCase { public function testBuild() { $facet = new Facet([], 'facet'); - $facet->setUrlParameter('test'); + $facet->setUrlAlias('test'); $facet->setFacetSourceId('facet_source__dummy'); $request = new Request; @@ -111,7 +111,7 @@ class QueryStringUrlProcessorTest extends UnitTestCase { public function testBuildWithActiveItem() { $facet = new Facet([], 'facet'); - $facet->setFieldIdentifier('test'); + $facet->setUrlAlias('test'); $facet->setFacetSourceId('facet_source__dummy'); $original_results = $this->original_results;