Inheritance diagram for TaxRuleCollection:

Public Member Functions
	__construct (EntityFactory $entityFactory, FilterBuilder $filterBuilder, SearchCriteriaBuilder $searchCriteriaBuilder, SortOrderBuilder $sortOrderBuilder, TaxRuleRepositoryInterface $ruleService)

	loadData ($printQuery=false, $logQuery=false)

Public Member Functions inherited from AbstractServiceCollection
	__construct (EntityFactoryInterface $entityFactory, FilterBuilder $filterBuilder, SearchCriteriaBuilder $searchCriteriaBuilder, SortOrderBuilder $sortOrderBuilder)

	addFieldToFilter ($field, $condition)

Public Member Functions inherited from Collection
	__construct (EntityFactoryInterface $entityFactory)

	addFilter ($field, $value, $type='and')

	addFieldToFilter ($field, $condition)

	getFilter ($field)

	isLoaded ()

	getCurPage ($displacement=0)

	getLastPageNumber ()

	getPageSize ()

	getSize ()

	getFirstItem ()

	getLastItem ()

	getItems ()

	getColumnValues ($colName)

	getItemsByColumnValue ($column, $value)

	getItemByColumnValue ($column, $value)

	addItem (\Magento\Framework\DataObject $item)

	getAllIds ()

	removeItemByKey ($key)

	removeAllItems ()

	clear ()

	walk ($callback, array $args=[])

	each ($objMethod, $args=[])

	setDataToAll ($key, $value=null)

	setCurPage ($page)

	setPageSize ($size)

	setOrder ($field, $direction=self::SORT_ORDER_DESC)

	setItemObjectClass ($className)

	getNewEmptyItem ()

	distinct ($flag)

	loadData ($printQuery=false, $logQuery=false)

	load ($printQuery=false, $logQuery=false)

	loadWithFilter ($printQuery=false, $logQuery=false)

	toXml ()

	toArray ($arrRequiredFields=[])

	toOptionArray ()

	toOptionHash ()

	getItemById ($idValue)

	getIterator ()

	count ()

	getFlag ($flag)

	setFlag ($flag, $value=null)

	hasFlag ($flag)

	__sleep ()

	__wakeup ()

Protected Member Functions
	createTaxRuleCollectionItem (TaxRuleInterface $taxRule)

Protected Member Functions inherited from AbstractServiceCollection
	createFilterData ($field, $condition)

Protected Member Functions inherited from Collection
	_setIsLoaded ($flag=true)

	_addItem ($item)

	_getItemId (\Magento\Framework\DataObject $item)

	_renderFilters ()

	_renderOrders ()

	_renderLimit ()

	_toOptionArray ($valueField='id', $labelField='name', $additional=[])

	_toOptionHash ($valueField='id', $labelField='name')

Protected Attributes
	$ruleService

Protected Attributes inherited from AbstractServiceCollection
	$fieldFilters = []

	$filterBuilder

	$searchCriteriaBuilder

	$sortOrderBuilder

Protected Attributes inherited from Collection
	$_items = []

	$_itemObjectClass = \Magento\Framework\DataObject::class

	$_orders = []

	$_filters = []

	$_isFiltersRendered = false

	$_curPage = 1

	$_pageSize = false

	$_totalRecords

	$_isCollectionLoaded

	$_flags = []

	$_entityFactory

Additional Inherited Members
Data Fields inherited from Collection
const	SORT_ORDER_ASC = 'ASC'

const	SORT_ORDER_DESC = 'DESC'

Detailed Description

Tax rule collection for a grid backed by Services

Definition at line 20 of file TaxRuleCollection.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	EntityFactory	$entityFactory,
		FilterBuilder	$filterBuilder,
		SearchCriteriaBuilder	$searchCriteriaBuilder,
		SortOrderBuilder	$sortOrderBuilder,
		TaxRuleRepositoryInterface	$ruleService
	)

Initialize dependencies.

Parameters

EntityFactory	$entityFactory
FilterBuilder	$filterBuilder
SearchCriteriaBuilder	$searchCriteriaBuilder
SortOrderBuilder	$sortOrderBuilder
TaxRuleRepositoryInterface	$ruleService

Definition at line 36 of file TaxRuleCollection.php.

       {
         parent::__construct($entityFactory, $filterBuilder, $searchCriteriaBuilder, $sortOrderBuilder);
         $this->ruleService = $ruleService;
     }

Member Function Documentation

◆ createTaxRuleCollectionItem()

createTaxRuleCollectionItem ( TaxRuleInterface $taxRule )

protected

Creates a collection item that represents a tax rule for the tax rules grid.

Parameters

TaxRuleInterface $taxRule Input data for creating the item.

Returns: \Magento\Framework\DataObject Collection item that represents a tax rule

Definition at line 70 of file TaxRuleCollection.php.

     {
         $collectionItem = new \Magento\Framework\DataObject();
         $collectionItem->setTaxCalculationRuleId($taxRule->getId());
         $collectionItem->setCode($taxRule->getCode());
         /* should cast to string so that some optional fields won't be null on the collection grid pages */
         $collectionItem->setPriority((string)$taxRule->getPriority());
         $collectionItem->setPosition((string)$taxRule->getPosition());
         $collectionItem->setCalculateSubtotal($taxRule->getCalculateSubtotal() ? '1' : '0');
         $collectionItem->setCustomerTaxClasses($taxRule->getCustomerTaxClassIds());
         $collectionItem->setProductTaxClasses($taxRule->getProductTaxClassIds());
         $collectionItem->setTaxRatesCodes($taxRule->getTaxRatesCodes());
         $collectionItem->setTaxRates($taxRule->getTaxRateIds());
         return $collectionItem;
     }

◆ loadData()

loadData	(	$printQuery = `false`,
		$logQuery = `false`
	)

{}

Definition at line 50 of file TaxRuleCollection.php.

     {
         if (!$this->isLoaded()) {
             $searchCriteria = $this->getSearchCriteria();
             $searchResults = $this->ruleService->getList($searchCriteria);
             $this->_totalRecords = $searchResults->getTotalCount();
             foreach ($searchResults->getItems() as $taxRule) {
                 $this->_addItem($this->createTaxRuleCollectionItem($taxRule));
             }
             $this->_setIsLoaded();
         }
         return $this;
     }

Field Documentation

◆ $ruleService

$ruleService

protected

Definition at line 25 of file TaxRuleCollection.php.

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

vendor/magento/module-tax/Model/TaxRuleCollection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members