Skip to content

CollectionsFilterValue

The CollectionsFilterValue object represents a collection filter value in the storefront.

classDiagram
  direction LR
  CollectionsFilterValue --> Url
  class CollectionsFilterValue{
    int collectionId
    string name
    bool isActive
    string urlValue
    string urlKey
    Url urlWithFilterValueRemoved
    Url urlWithSingleFilterValue
    ?Url urlWithFilterValueAdded
    ?int counter
  }
  class Url{
  }

Properties

Attribute name Type Description
collectionId int The unique identifier of the collection filter value.
name string The name of the collection filter.
isActive bool Returns true if collection filter value is active.
urlValue string Represents a value of the collection filter used to build target URL.
urlKey string Represents URL key for collection filter value.
urlWithFilterValueRemoved Url Returns Url object that represents link with collection filter value removed.
urlWithSingleFilterValue Url Returns Url object that represents link with single collection filter value.
urlWithFilterValueAdded null|Url Returns Url object that represents link with collection filter value added.
counter null|int Represents amount of found products with selected collection.

Examples

collectionId property

{{ collectionsFilterValue.collectionId }}

1

name property

{{ collectionsFilterValue.name }}

example name

isActive property

{{ collectionsFilterValue.isActive }}

true

urlValue property

{{ collectionsFilterValue.urlValue }}

1

urlKey property

{{ collectionsFilterValue.urlKey }}

f_collection_92

urlWithFilterValueRemoved property

{{ collectionsFilterValue.urlWithFilterValueRemoved }}

/url/with/filter/value/removed

urlWithSingleFilterValue property

{{ collectionsFilterValue.urlWithSingleFilterValue }}

/url/with/single/filter/value

urlWithFilterValueAdded property

{{ collectionsFilterValue.urlWithFilterValueAdded }}

/url/with/filter/value/added

counter property

{{ collectionsFilterValue.counter }}

3