Inheritance diagram for ClassModel:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Tax\Model\TaxClass\Factory $classFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	_construct ()

	beforeDelete ()

	getClassId ()

	getClassName ()

	getClassType ()

	setClassId ($classId)

	setClassName ($className)

	setClassType ($classType)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Tax\Api\Data\TaxClassExtensionInterface $extensionAttributes)

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	KEY_ID = 'class_id'

const	KEY_NAME = 'class_name'

const	KEY_TYPE = 'class_type'

const	TAX_CLASS_TYPE_CUSTOMER = 'CUSTOMER'

const	TAX_CLASS_TYPE_PRODUCT = 'PRODUCT'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Protected Member Functions
	checkClassCanBeDeleted ()

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_classFactory

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Tax class model

Definition at line 15 of file ClassModel.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Tax\Model\TaxClass\Factory	$classFactory,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
TaxClass\Factory	$classFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data

Definition at line 51 of file ClassModel.php.

       {
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
         $this->_classFactory = $classFactory;
     }

Member Function Documentation

◆ _construct()

_construct ( )

Returns: void

Definition at line 76 of file ClassModel.php.

     {
         $this->_init(\Magento\Tax\Model\ResourceModel\TaxClass::class);
     }

◆ beforeDelete()

beforeDelete ( )

Validate tax class can be deleted

Returns: $this

Exceptions

Definition at line 122 of file ClassModel.php.

     {
         $this->checkClassCanBeDeleted();
         return parent::beforeDelete();
     }

◆ checkClassCanBeDeleted()

checkClassCanBeDeleted ( )

protected

Check whether this class can be deleted

Returns: bool

Exceptions

CouldNotDeleteException

Definition at line 87 of file ClassModel.php.

     {
         if (!$this->getId()) {
             throw new CouldNotDeleteException(__('This class no longer exists.'));
         }
 
         $typeModel = $this->_classFactory->create($this);
 
         if ($typeModel->getAssignedToRules()->getSize() > 0) {
             throw new CouldNotDeleteException(
                 __(
                     'You cannot delete this tax class because it is used in Tax Rules.'
                     . ' You have to delete the rules it is used in first.'
                 )
             );
         }
 
         if ($typeModel->isAssignedToObjects()) {
             throw new CouldNotDeleteException(
                 __(
                     'You cannot delete this tax class because it is used in existing %1(s).',
                     $typeModel->getObjectTypeName()
                 )
             );
         }
 
         return true;
     }

◆ getClassId()

getClassId ( )

@codeCoverageIgnoreStart {Get tax class ID.

Returns: int|null

}

Implements TaxClassInterface.

Definition at line 132 of file ClassModel.php.

     {
         return $this->getData(self::KEY_ID);
     }

◆ getClassName()

getClassName ( )

{Get tax class name.

Returns: string

}

Implements TaxClassInterface.

Definition at line 140 of file ClassModel.php.

     {
         return $this->getData(self::KEY_NAME);
     }

◆ getClassType()

getClassType ( )

{Get tax class type.

Returns: string

}

Implements TaxClassInterface.

Definition at line 148 of file ClassModel.php.

     {
         return $this->getData(self::KEY_TYPE);
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Tax\Api\Data\TaxClassExtensionInterface|null

}

Returns: \Magento\Tax\Api\Data\TaxClassExtensionInterface|null

Implements TaxClassInterface.

Definition at line 193 of file ClassModel.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ setClassId()

setClassId ( $classId )

Set tax class ID.

Parameters

int $classId

Returns: $this

Implements TaxClassInterface.

Definition at line 159 of file ClassModel.php.

     {
         return $this->setData(self::KEY_ID, $classId);
     }

◆ setClassName()

setClassName ( $className )

Set tax class name.

Parameters

string $className

Returns: $this

Implements TaxClassInterface.

Definition at line 170 of file ClassModel.php.

     {
         return $this->setData(self::KEY_NAME, $className);
     }

◆ setClassType()

setClassType ( $classType )

Set tax class type.

Parameters

string $classType

Returns: $this

Implements TaxClassInterface.

Definition at line 181 of file ClassModel.php.

     {
         return $this->setData(self::KEY_TYPE, $classType);
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Tax\Api\Data\TaxClassExtensionInterface $extensionAttributes )

{Set an extension attributes object.

Parameters

\Magento\Tax\Api\Data\TaxClassExtensionInterface $extensionAttributes

Returns: $this

}

Parameters

\Magento\Tax\Api\Data\TaxClassExtensionInterface $extensionAttributes

Returns: $this

Implements TaxClassInterface.

Definition at line 204 of file ClassModel.php.

     {
         return $this->_setExtensionAttributes($extensionAttributes);
     }

Field Documentation

◆ $_classFactory

$_classFactory

protected

Definition at line 39 of file ClassModel.php.

◆ KEY_ID

const KEY_ID = 'class_id'

#+ Constants defined for keys of array, makes typos less likely

Definition at line 21 of file ClassModel.php.

◆ KEY_NAME

const KEY_NAME = 'class_name'

Definition at line 22 of file ClassModel.php.

◆ KEY_TYPE

const KEY_TYPE = 'class_type'

Definition at line 23 of file ClassModel.php.

◆ TAX_CLASS_TYPE_CUSTOMER

const TAX_CLASS_TYPE_CUSTOMER = 'CUSTOMER'

#- Defines Customer Tax Class string

Definition at line 29 of file ClassModel.php.

◆ TAX_CLASS_TYPE_PRODUCT

const TAX_CLASS_TYPE_PRODUCT = 'PRODUCT'

Defines Product Tax Class string

Definition at line 34 of file ClassModel.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ beforeDelete()

◆ checkClassCanBeDeleted()

◆ getClassId()

◆ getClassName()

◆ getClassType()

◆ getExtensionAttributes()

◆ setClassId()

◆ setClassName()

◆ setClassType()

◆ setExtensionAttributes()

Field Documentation

◆ $_classFactory

◆ KEY_ID

◆ KEY_NAME

◆ KEY_TYPE

◆ TAX_CLASS_TYPE_CUSTOMER

◆ TAX_CLASS_TYPE_PRODUCT