Skip to content

AttributesFilterValue

The AttributesFilterValue object represents a attributes filter value in the storefront.

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

Properties

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

Examples

attributeValueId property

{{ attributesFilterValue.attributeValueId }}

1

name property

{{ attributesFilterValue.name }}

example name

isActive property

{{ attributesFilterValue.isActive }}

true

urlValue property

{{ attributesFilterValue.urlValue }}

1

urlKey property

{{ attributesFilterValue.urlKey }}

f_at_11_211

counter property

{{ attributesFilterValue.counter }}

4

urlWithFilterValueRemoved property

{{ attributesFilterValue.urlWithFilterValueRemoved }}

/link/to/filter/value/removed

urlWithSingleFilterValue property

{{ attributesFilterValue.urlWithSingleFilterValue }}

/link/to/single/filter/value

urlWithFilterValueAdded property

{{ attributesFilterValue.urlWithFilterValueAdded }}

/link/to/filter/value/added