Inheritance diagram for AbstractGroupPrice:

Public Member Functions
	__construct (\Magento\Directory\Model\CurrencyFactory $currencyFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Helper\Data $catalogData, \Magento\Framework\App\Config\ScopeConfigInterface $config, \Magento\Framework\Locale\FormatInterface $localeFormat, \Magento\Catalog\Model\Product\Type $catalogProductType, GroupManagementInterface $groupManagement, ScopeOverriddenValue $scopeOverriddenValue=null)

	validate ($object)

	preparePriceData (array $priceData, $productTypeId, $websiteId)

	afterLoad ($object)

	setPriceData ($object, $priceData)

	afterSave ($object)

	getAffectedFields ($object)

	getResource ()

Public Member Functions inherited from Price
	__construct (\Magento\Directory\Model\CurrencyFactory $currencyFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Helper\Data $catalogData, \Magento\Framework\App\Config\ScopeConfigInterface $config, \Magento\Framework\Locale\FormatInterface $localeFormat, ScopeOverriddenValue $scopeOverriddenValue=null)

	setAttribute ($attribute)

	setScope ($attribute)

	validate ($object)

Public Member Functions inherited from AbstractBackend
	setAttribute ($attribute)

	getAttribute ()

	getType ()

	isStatic ()

	getTable ()

	getEntityIdField ()

	setValueId ($valueId)

	setEntityValueId ($entity, $valueId)

	getValueId ()

	getEntityValueId ($entity)

	getDefaultValue ()

	validate ($object)

	afterLoad ($object)

	beforeSave ($object)

	afterSave ($object)

	beforeDelete ($object)

	afterDelete ($object)

	getAffectedFields ($object)

	isScalar ()

Protected Member Functions
	_getDuplicateErrorMessage ()

	_getWebsiteCurrencyRates ()

	_getResource ()

	_getAdditionalUniqueFields ($objectArray)

	getAdditionalFields ($objectArray)

	_isPriceFixed ($priceObject)

	validatePrice (array $priceRow)

	updateValues (array $valuesToUpdate, array $oldValues)

Protected Member Functions inherited from Price
	isPositiveOrZero ($value)

Protected Attributes
	$metadataPool

	$_rates

	$_catalogProductType

	$_groupManagement

Protected Attributes inherited from Price
	$_helper

	$_storeManager

	$_currencyFactory

	$_config

	$localeFormat

Protected Attributes inherited from AbstractBackend
	$_attribute

	$_valueId

	$_valueIds = []

	$_table

	$_entityIdField

	$_defaultValue = null

Detailed Description

Catalog product abstract group price backend attribute model

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 19 of file AbstractGroupPrice.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Directory\Model\CurrencyFactory	$currencyFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Helper\Data	$catalogData,
		\Magento\Framework\App\Config\ScopeConfigInterface	$config,
		\Magento\Framework\Locale\FormatInterface	$localeFormat,
		\Magento\Catalog\Model\Product\Type	$catalogProductType,
		GroupManagementInterface	$groupManagement,
		ScopeOverriddenValue	$scopeOverriddenValue = `null`
	)

Parameters

\Magento\Directory\Model\CurrencyFactory	$currencyFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Helper\Data	$catalogData
\Magento\Framework\App\Config\ScopeConfigInterface	$config
\Magento\Framework\Locale\FormatInterface	$localeFormat
\Magento\Catalog\Model\Product\Type	$catalogProductType
GroupManagementInterface	$groupManagement
ScopeOverriddenValue \| null	$scopeOverriddenValue

Definition at line 63 of file AbstractGroupPrice.php.

       {
         $this->_catalogProductType = $catalogProductType;
         $this->_groupManagement = $groupManagement;
         parent::__construct(
             $currencyFactory,
             $storeManager,
             $catalogData,
             $config,
             $localeFormat,
             $scopeOverriddenValue
         );
     }

Member Function Documentation

◆ _getAdditionalUniqueFields()

_getAdditionalUniqueFields ( $objectArray )

protected

Get additional unique fields

Parameters

array $objectArray

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 135 of file AbstractGroupPrice.php.

     {
         return [];
     }

◆ _getDuplicateErrorMessage()

_getDuplicateErrorMessage ( )

abstractprotected

Error message when duplicates

@abstract

Returns: string

◆ _getResource()

_getResource ( )

abstractprotected

Retrieve resource instance

Returns: \Magento\Catalog\Model\ResourceModel\Product\Attribute\Backend\Tierprice

◆ _getWebsiteCurrencyRates()

_getWebsiteCurrencyRates ( )

protected

Retrieve websites currency rates and base currency codes

Returns: array

Definition at line 90 of file AbstractGroupPrice.php.

     {
         if ($this->_rates === null) {
             $this->_rates = [];
             $baseCurrency = $this->_config->getValue(
                 \Magento\Directory\Model\Currency::XML_PATH_CURRENCY_BASE,
                 'default'
             );
             foreach ($this->_storeManager->getWebsites() as $website) {
                 /* @var $website \Magento\Store\Model\Website */
                 if ($website->getBaseCurrencyCode() != $baseCurrency) {
                     $rate = $this->_currencyFactory->create()->load(
                         $baseCurrency
                     )->getRate(
                         $website->getBaseCurrencyCode()
                     );
                     if (!$rate) {
                         $rate = 1;
                     }
                     $this->_rates[$website->getId()] = [
                         'code' => $website->getBaseCurrencyCode(),
                         'rate' => $rate,
                     ];
                 } else {
                     $this->_rates[$website->getId()] = ['code' => $baseCurrency, 'rate' => 1];
                 }
             }
         }
         return $this->_rates;
     }

◆ _isPriceFixed()

_isPriceFixed ( $priceObject )

protected

Whether group price value fixed or percent of original price

Parameters

\Magento\Catalog\Model\Product\Type\Price $priceObject

Returns: bool

Definition at line 158 of file AbstractGroupPrice.php.

     {
         return $priceObject->isGroupPriceFixed();
     }

◆ afterLoad()

afterLoad ( $object )

Assign group prices to product data

Parameters

\Magento\Catalog\Model\Product $object

Returns: $this

Implements BackendInterface.

Definition at line 305 of file AbstractGroupPrice.php.

     {
         $data = $this->_getResource()->loadPriceData(
             $object->getData($this->getMetadataPool()->getMetadata(ProductInterface::class)->getLinkField()),
             $this->getWebsiteId($object->getStoreId())
         );
         $this->setPriceData($object, $data);
 
         return $this;
     }

◆ afterSave()

afterSave ( $object )

After Save Attribute manipulation

Parameters

\Magento\Catalog\Model\Product $object

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements BackendInterface.

Definition at line 384 of file AbstractGroupPrice.php.

     {
         return $this;
     }

◆ getAdditionalFields()

getAdditionalFields ( $objectArray )

protected

Get additional fields

Parameters

array $objectArray

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 147 of file AbstractGroupPrice.php.

     {
         return [];
     }

◆ getAffectedFields()

getAffectedFields ( $object )

Retrieve data for update attribute

Parameters

\Magento\Catalog\Model\Product $object

Returns: array

Definition at line 420 of file AbstractGroupPrice.php.

     {
         $data = [];
         $prices = (array)$object->getData($this->getAttribute()->getName());
         $tableName = $this->_getResource()->getMainTable();
         foreach ($prices as $value) {
             $data[$tableName][] = [
                 'attribute_id' => $this->getAttribute()->getAttributeId(),
                 'entity_id' => $object->getId(),
                 'value_id' => $value['price_id'],
             ];
         }
 
         return $data;
     }

◆ getResource()

getResource ( )

Get resource model instance

Returns: \Magento\Catalog\Model\ResourceModel\Product\Attribute\Backend\GroupPrice\AbstractGroupPrice

Definition at line 441 of file AbstractGroupPrice.php.

     {
         return $this->_getResource();
     }

◆ preparePriceData()

preparePriceData	(	array	$priceData,
			$productTypeId,
			$websiteId
	)

Prepare group prices data for website

Parameters

array	$priceData
string	$productTypeId
int	$websiteId

Returns: array

Definition at line 273 of file AbstractGroupPrice.php.

     {
         $rates = $this->_getWebsiteCurrencyRates();
         $data = [];
         $price = $this->_catalogProductType->priceFactory($productTypeId);
         foreach ($priceData as $v) {
             if (!array_filter($v)) {
                 continue;
             }
             $key = implode('-', array_merge([$v['cust_group']], $this->_getAdditionalUniqueFields($v)));
             if ($v['website_id'] == $websiteId) {
                 $data[$key] = $v;
                 $data[$key]['website_price'] = $v['price'];
             } elseif ($v['website_id'] == 0 && !isset($data[$key])) {
                 $data[$key] = $v;
                 $data[$key]['website_id'] = $websiteId;
                 if ($this->_isPriceFixed($price)) {
                     $data[$key]['price'] = $v['price'] * $rates[$websiteId]['rate'];
                     $data[$key]['website_price'] = $v['price'] * $rates[$websiteId]['rate'];
                 }
             }
         }
 
         return $data;
     }

◆ setPriceData()

setPriceData	(	$object,
		$priceData
	)

Set price data.

Parameters

\Magento\Catalog\Model\Product	$object
array	$priceData

Definition at line 339 of file AbstractGroupPrice.php.

     {
         $priceData = $this->modifyPriceData($object, $priceData);
         $websiteId = $this->getWebsiteId($object->getStoreId());
         if (!$object->getData('_edit_mode') && $websiteId) {
             $priceData = $this->preparePriceData($priceData, $object->getTypeId(), $websiteId);
         }
 
         $object->setData($this->getAttribute()->getName(), $priceData);
         $object->setOrigData($this->getAttribute()->getName(), $priceData);
 
         $valueChangedKey = $this->getAttribute()->getName() . '_changed';
         $object->setOrigData($valueChangedKey, 0);
         $object->setData($valueChangedKey, 0);
     }

◆ updateValues()

updateValues	(	array	$valuesToUpdate,
		array	$oldValues
	)

protected

Update values.

Parameters

array	$valuesToUpdate
array	$oldValues

Returns: boolean

Definition at line 396 of file AbstractGroupPrice.php.

     {
         $isChanged = false;
         foreach ($valuesToUpdate as $key => $value) {
             if ($oldValues[$key]['price'] != $value['value']) {
                 $price = new \Magento\Framework\DataObject(
                     [
                         'value_id' => $oldValues[$key]['price_id'],
                         'value' => $value['value']
                     ]
                 );
                 $this->_getResource()->savePriceData($price);
                 $isChanged = true;
             }
         }
         return $isChanged;
     }

◆ validate()

validate ( $object )

Validate group price data

Parameters

\Magento\Catalog\Model\Product $object

Exceptions

Definition at line 172 of file AbstractGroupPrice.php.

     {
         $attribute = $this->getAttribute();
         $priceRows = $object->getData($attribute->getName());
         $priceRows = array_filter((array)$priceRows);
 
         if (empty($priceRows)) {
             return true;
         }
 
         // validate per website
         $duplicates = [];
         foreach ($priceRows as $priceRow) {
             if (!empty($priceRow['delete'])) {
                 continue;
             }
             $compare = implode(
                 '-',
                 array_merge(
                     [$priceRow['website_id'], $priceRow['cust_group']],
                     $this->_getAdditionalUniqueFields($priceRow)
                 )
             );
             if (isset($duplicates[$compare])) {
                 throw new \Magento\Framework\Exception\LocalizedException(__($this->_getDuplicateErrorMessage()));
             }
 
             $this->validatePrice($priceRow);
 
             $duplicates[$compare] = true;
         }
 
         // if attribute scope is website and edit in store view scope
         // add global group prices for duplicates find
         if (!$attribute->isScopeGlobal() && $object->getStoreId()) {
             $origPrices = $object->getOrigData($attribute->getName());
             if ($origPrices) {
                 foreach ($origPrices as $price) {
                     if ($price['website_id'] == 0) {
                         $compare = implode(
                             '-',
                             array_merge(
                                 [$price['website_id'], $price['cust_group']],
                                 $this->_getAdditionalUniqueFields($price)
                             )
                         );
                         $duplicates[$compare] = true;
                     }
                 }
             }
         }
 
         // validate currency
         $baseCurrency = $this->_config->getValue(\Magento\Directory\Model\Currency::XML_PATH_CURRENCY_BASE, 'default');
         $rates = $this->_getWebsiteCurrencyRates();
         foreach ($priceRows as $priceRow) {
             if (!empty($priceRow['delete'])) {
                 continue;
             }
             if ($priceRow['website_id'] == 0) {
                 continue;
             }
 
             $globalCompare = implode(
                 '-',
                 array_merge([0, $priceRow['cust_group']], $this->_getAdditionalUniqueFields($priceRow))
             );
             $websiteCurrency = $rates[$priceRow['website_id']]['code'];
 
             if ($baseCurrency == $websiteCurrency && isset($duplicates[$globalCompare])) {
                 throw new \Magento\Framework\Exception\LocalizedException(__($this->_getDuplicateErrorMessage()));
             }
         }
 
         return true;
     }

◆ validatePrice()

validatePrice ( array $priceRow )

protected

Validate price.

Parameters

array $priceRow

Returns: void

Exceptions

Definition at line 256 of file AbstractGroupPrice.php.

     {
         if (!isset($priceRow['price']) || !$this->isPositiveOrZero($priceRow['price'])) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Group price must be a number greater than 0.')
             );
         }
     }

Field Documentation

◆ $_catalogProductType

$_catalogProductType

protected

Definition at line 46 of file AbstractGroupPrice.php.

◆ $_groupManagement

$_groupManagement

protected

Definition at line 51 of file AbstractGroupPrice.php.

◆ $_rates

$_rates

protected

Definition at line 31 of file AbstractGroupPrice.php.

◆ $metadataPool

$metadataPool

protected

Definition at line 24 of file AbstractGroupPrice.php.

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

vendor/magento/module-catalog/Model/Product/Attribute/Backend/GroupPrice/AbstractGroupPrice.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getAdditionalUniqueFields()

◆ _getDuplicateErrorMessage()

◆ _getResource()

◆ _getWebsiteCurrencyRates()

◆ _isPriceFixed()

◆ afterLoad()

◆ afterSave()

◆ getAdditionalFields()

◆ getAffectedFields()

◆ getResource()

◆ preparePriceData()

◆ setPriceData()

◆ updateValues()

◆ validate()

◆ validatePrice()

Field Documentation

◆ $_catalogProductType

◆ $_groupManagement

◆ $_rates

◆ $metadataPool