Skip to content

AvailabilitiesFilterValue

The AvailabilitiesFilterValue object represents an availability filter value in the storefront.

classDiagram
  direction LR
  AvailabilitiesFilterValue --> Url
  class AvailabilitiesFilterValue{
    string name
    bool isActive
    bool isAvailable
    string value
    string urlKey
    ?int counter
    Url urlWithFilterValueRemoved
    Url urlWithSingleFilterValue
    ?Url urlWithFilterValueAdded
  }
  class Url{
  }

Properties

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

Examples

name property

{{ availabilitiesFilterValue.name }}

example name

isActive property

{{ availabilitiesFilterValue.isActive }}

true

isAvailable property

{{ availabilitiesFilterValue.isAvailable }}

true

urlValue property

{{ availabilitiesFilterValue.urlValue }}

3

urlKey property

{{ availabilitiesFilterValue.urlKey }}

f_availability_50

counter property

{{ availabilitiesFilterValue.counter }}

3

urlWithFilterValueRemoved property

{{ availabilitiesFilterValue.urlWithFilterValueRemoved }}

/url/with/filter/value/removed

urlWithSingleFilterValue property

{{ availabilitiesFilterValue.urlWithSingleFilterValue }}

/url/with/single/filter/value

urlWithFilterValueAdded property

{{ availabilitiesFilterValue.urlWithFilterValueAdded }}

/url/with/filter/value/added