Skip to content

OptionsFilterValue

The OptionsFilterValue object represents an options filter value in the storefront.

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

Properties

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

Examples

optionValueId property

{{ optionsFilterValue.optionValueId }}

2

name property

{{ optionsFilterValue.name }}

example name

isActive property

{{ optionsFilterValue.isActive }}

true

urlValue property

{{ optionsFilterValue.urlValue }}

2

urlKey property

{{ optionsFilterValue.urlKey }}

f_at_11_211

counter property

{{ optionsFilterValue.counter }}

3

urlWithFilterValueRemoved property

{{ optionsFilterValue.urlWithFilterValueRemoved }}

/url/with/filter/value/removed

urlWithSingleFilterValue property

{{ optionsFilterValue.urlWithSingleFilterValue }}

/url/with/single/filter/value

urlWithFilterValueAdded property

{{ optionsFilterValue.urlWithFilterValueAdded }}

/url/with/filter/value/added