Public Member Functions
	__construct (Layer $layer, Registry $coreRegistry, ScopeConfigInterface $scopeConfig, \Magento\Catalog\Model\ResourceModel\Layer\Filter\Price $resource)

	getInterval ()

	setInterval ($interval)

	getRangeCalculationValue ()

	getRangeStepValue ()

	getOnePriceIntervalValue ()

	getIntervalDivisionLimitValue ()

	getRangeMaxIntervalsValue ()

	getLayer ()

	getPriceRange ()

	getRangeItemCounts ($range)

	getMaxPrice ()

	getPriorFilters ($filterParams)

	validateFilter ($filter)

	getResetValue ()

	getPriorIntervals ()

	setPriorIntervals ($priorInterval)

	getResource ()

	getAdditionalRequestData ()

Data Fields
const	XML_PATH_RANGE_CALCULATION = 'catalog/layered_navigation/price_range_calculation'

const	XML_PATH_RANGE_STEP = 'catalog/layered_navigation/price_range_step'

const	XML_PATH_RANGE_MAX_INTERVALS = 'catalog/layered_navigation/price_range_max_intervals'

const	XML_PATH_ONE_PRICE_INTERVAL = 'catalog/layered_navigation/one_price_interval'

const	XML_PATH_INTERVAL_DIVISION_LIMIT = 'catalog/layered_navigation/interval_division_limit'

const	RANGE_CALCULATION_AUTO = 'auto'

const	RANGE_CALCULATION_IMPROVED = 'improved'

const	RANGE_CALCULATION_MANUAL = 'manual'

const	MIN_RANGE_POWER = 10

Detailed Description

Definition at line 13 of file Price.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Layer	$layer,
		Registry	$coreRegistry,
		ScopeConfigInterface	$scopeConfig,
		\Magento\Catalog\Model\ResourceModel\Layer\Filter\Price	$resource
	)

Parameters

Layer	$layer
Registry	$coreRegistry
ScopeConfigInterface	$scopeConfig
\Magento\Catalog\Model\ResourceModel\Layer\Filter\Price	$resource

Definition at line 93 of file Price.php.

       {
         $this->layer = $layer;
         $this->coreRegistry = $coreRegistry;
         $this->scopeConfig = $scopeConfig;
         $this->resource = $resource;
     }

Member Function Documentation

◆ getAdditionalRequestData()

getAdditionalRequestData ( )

Returns: string

Definition at line 369 of file Price.php.

     {
         $result = '';
         $appliedInterval = $this->getInterval();
         if ($appliedInterval) {
             $result = ',' . $appliedInterval[0] . '-' . $appliedInterval[1];
             $priorIntervals = $this->getResetValue();
             if ($priorIntervals) {
                 $result .= ',' . $priorIntervals;
             }
         }
 
         return $result;
     }

◆ getInterval()

getInterval ( )

Returns: array

Definition at line 108 of file Price.php.

     {
         return $this->interval;
     }

◆ getIntervalDivisionLimitValue()

getIntervalDivisionLimitValue ( )

Get interval division limit

Returns: int

Definition at line 160 of file Price.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_INTERVAL_DIVISION_LIMIT,
             ScopeInterface::SCOPE_STORE
         );
     }

◆ getLayer()

getLayer ( )

Returns: Layer

Definition at line 184 of file Price.php.

     {
         return $this->layer;
     }

◆ getMaxPrice()

getMaxPrice ( )

Get maximum price from layer products set

Returns: float

Definition at line 264 of file Price.php.

     {
         $maxPrice = $this->maxPrice;
         if ($maxPrice === null) {
             $maxPrice = $this->getLayer()
                 ->getProductCollection()
                 ->getMaxPrice();
             $maxPrice = floor($maxPrice);
             $this->maxPrice = $maxPrice;
         }
 
         return $maxPrice;
     }

◆ getOnePriceIntervalValue()

getOnePriceIntervalValue ( )

Returns: mixed

Definition at line 147 of file Price.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_ONE_PRICE_INTERVAL,
             ScopeInterface::SCOPE_STORE
         );
     }

◆ getPriceRange()

getPriceRange ( )

Get price range for building filter steps

Returns: int

Definition at line 194 of file Price.php.

     {
         $range = $this->priceRange;
         if (!$range) {
             $currentCategory = $this->coreRegistry->registry('current_category_filter');
             if ($currentCategory) {
                 $range = $currentCategory->getFilterPriceRange();
             } else {
                 $range = $this->getLayer()
                     ->getCurrentCategory()
                     ->getFilterPriceRange();
             }
 
             if (!$range) {
                 $maxPrice = $this->getMaxPrice();
                 $calculation = $this->getRangeCalculationValue();
                 if ($calculation == self::RANGE_CALCULATION_AUTO) {
                     $index = 1;
                     do {
                         $range = pow(10, strlen(floor($maxPrice)) - $index);
                         $items = $this->getRangeItemCounts($range);
                         $index++;
                     } while ($range > self::MIN_RANGE_POWER && count($items) < 2);
                 } else {
                     $range = (double)$this->getRangeStepValue();
                 }
             }
 
             $this->priceRange = $range;
         }
 
         return $range;
     }

◆ getPriorFilters()

getPriorFilters ( $filterParams )

Parameters

string $filterParams

Returns: array

Definition at line 282 of file Price.php.

     {
         $priorFilters = [];
         $count = count($filterParams);
         for ($i = 1; $i < $count; ++$i) {
             $priorFilter = $this->validateFilter($filterParams[$i]);
             if ($priorFilter) {
                 $priorFilters[] = $priorFilter;
             } else {
                 //not valid data
                 $priorFilters = [];
                 break;
             }
         }
 
         return $priorFilters;
     }

◆ getPriorIntervals()

getPriorIntervals ( )

Returns: array

Definition at line 344 of file Price.php.

     {
         return $this->priorIntervals;
     }

◆ getRangeCalculationValue()

getRangeCalculationValue ( )

Returns: mixed

Definition at line 125 of file Price.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_RANGE_CALCULATION,
             ScopeInterface::SCOPE_STORE
         );
     }

◆ getRangeItemCounts()

getRangeItemCounts ( $range )

Get information about products count in range

Parameters

int $range

Returns: int

Definition at line 234 of file Price.php.

     {
         $items = array_key_exists($range, $this->rangeItemCounts) ? $this->rangeItemCounts[$range] : null;
         if ($items === null) {
             $items = $this->resource->getCount($range);
             // checking max number of intervals
             $i = 0;
             $lastIndex = null;
             $maxIntervalsNumber = $this->getRangeMaxIntervalsValue();
             $calculation = $this->getRangeCalculationValue();
             foreach ($items as $k => $v) {
                 ++$i;
                 if ($calculation == self::RANGE_CALCULATION_MANUAL && $i > 1 && $i > $maxIntervalsNumber) {
                     $items[$lastIndex] += $v;
                     unset($items[$k]);
                 } else {
                     $lastIndex = $k;
                 }
             }
             $this->rangeItemCounts[$range] = $items;
         }
 
         return $items;
     }

◆ getRangeMaxIntervalsValue()

getRangeMaxIntervalsValue ( )

Get maximum number of intervals

Returns: mixed

Definition at line 173 of file Price.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_RANGE_MAX_INTERVALS,
             ScopeInterface::SCOPE_STORE
         );
     }

◆ getRangeStepValue()

getRangeStepValue ( )

Returns: mixed

Definition at line 136 of file Price.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_RANGE_STEP,
             ScopeInterface::SCOPE_STORE
         );
     }

◆ getResetValue()

getResetValue ( )

Get filter value for reset current filter state

Returns: null|string

Definition at line 326 of file Price.php.

     {
         $priorIntervals = $this->getPriorIntervals();
         $value = [];
         if ($priorIntervals) {
             foreach ($priorIntervals as $priorInterval) {
                 $value[] = implode('-', $priorInterval);
             }
 
             return implode(',', $value);
         }
 
         return null;
     }

◆ getResource()

getResource ( )

Returns: \Magento\Catalog\Model\ResourceModel\Layer\Filter\Price

Definition at line 361 of file Price.php.

     {
         return $this->resource;
     }

◆ setInterval()

setInterval ( $interval )

Parameters

array $interval

Returns: void

Definition at line 117 of file Price.php.

     {
         $this->interval = $interval;
     }

◆ setPriorIntervals()

setPriorIntervals ( $priorInterval )

Parameters

array $priorInterval

Returns: void

Definition at line 353 of file Price.php.

     {
         $this->priorIntervals = $priorInterval;
     }

◆ validateFilter()

validateFilter ( $filter )

Validate and parse filter request param

Parameters

string $filter

Returns: array|bool

Definition at line 306 of file Price.php.

     {
         $filter = explode('-', $filter);
         if (count($filter) != 2) {
             return false;
         }
         foreach ($filter as $v) {
             if ($v !== '' && $v !== '0' && (double)$v <= 0 || is_infinite((double)$v)) {
                 return false;
             }
         }
 
         return $filter;
     }

Field Documentation

◆ MIN_RANGE_POWER

const MIN_RANGE_POWER = 10

Minimal size of the range

Definition at line 40 of file Price.php.

◆ RANGE_CALCULATION_AUTO

const RANGE_CALCULATION_AUTO = 'auto'

Price layered navigation modes: Automatic (equalize price ranges), Automatic (equalize product counts), Manual

Definition at line 31 of file Price.php.

◆ RANGE_CALCULATION_IMPROVED

const RANGE_CALCULATION_IMPROVED = 'improved'

Definition at line 33 of file Price.php.

◆ RANGE_CALCULATION_MANUAL

const RANGE_CALCULATION_MANUAL = 'manual'

Definition at line 35 of file Price.php.

◆ XML_PATH_INTERVAL_DIVISION_LIMIT

const XML_PATH_INTERVAL_DIVISION_LIMIT = 'catalog/layered_navigation/interval_division_limit'

Definition at line 26 of file Price.php.

◆ XML_PATH_ONE_PRICE_INTERVAL

const XML_PATH_ONE_PRICE_INTERVAL = 'catalog/layered_navigation/one_price_interval'

Definition at line 24 of file Price.php.

◆ XML_PATH_RANGE_CALCULATION

const XML_PATH_RANGE_CALCULATION = 'catalog/layered_navigation/price_range_calculation'

XML configuration paths for Price Layered Navigation

Definition at line 18 of file Price.php.

◆ XML_PATH_RANGE_MAX_INTERVALS

const XML_PATH_RANGE_MAX_INTERVALS = 'catalog/layered_navigation/price_range_max_intervals'

Definition at line 22 of file Price.php.

◆ XML_PATH_RANGE_STEP

const XML_PATH_RANGE_STEP = 'catalog/layered_navigation/price_range_step'

Definition at line 20 of file Price.php.

The documentation for this class was generated from the following file:

vendor/magento/module-catalog/Model/Layer/Filter/DataProvider/Price.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAdditionalRequestData()

◆ getInterval()

◆ getIntervalDivisionLimitValue()

◆ getLayer()

◆ getMaxPrice()

◆ getOnePriceIntervalValue()

◆ getPriceRange()

◆ getPriorFilters()

◆ getPriorIntervals()

◆ getRangeCalculationValue()

◆ getRangeItemCounts()

◆ getRangeMaxIntervalsValue()

◆ getRangeStepValue()

◆ getResetValue()

◆ getResource()

◆ setInterval()

◆ setPriorIntervals()

◆ validateFilter()

Field Documentation

◆ MIN_RANGE_POWER

◆ RANGE_CALCULATION_AUTO

◆ RANGE_CALCULATION_IMPROVED

◆ RANGE_CALCULATION_MANUAL

◆ XML_PATH_INTERVAL_DIVISION_LIMIT

◆ XML_PATH_ONE_PRICE_INTERVAL

◆ XML_PATH_RANGE_CALCULATION

◆ XML_PATH_RANGE_MAX_INTERVALS

◆ XML_PATH_RANGE_STEP