Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
Group Class Reference
Inheritance diagram for Group:
AbstractModel DataObject

Public Member Functions

 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Store\Model\StoresConfig $storesConfig, \Magento\Framework\Reflection\DataObjectProcessor $dataObjectProcessor, \Magento\Tax\Model\ClassModelFactory $classModelFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
 
 setCode ($value)
 
 getCode ()
 
 getTaxClassName ()
 
 usesAsDefault ()
 
 beforeSave ()
 
- 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 NOT_LOGGED_IN_ID = 0
 
const CUST_GROUP_ALL = 32000
 
const ENTITY = 'customer_group'
 
const GROUP_CODE_MAX_LENGTH = 32
 

Protected Member Functions

 _construct ()
 
 _prepareData ()
 
- 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

 $_eventPrefix = 'customer_group'
 
 $_eventObject = 'object'
 
 $_storesConfig
 
 $dataObjectProcessor
 
 $classModelFactory
 
- 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

Customer group model

@api @method string getCustomerGroupCode() @method \Magento\Customer\Model\Group setCustomerGroupCode(string $value) @method \Magento\Customer\Model\Group setTaxClassId(int $value) @method Group setTaxClassName(string $value)

Since
100.0.2

Definition at line 18 of file Group.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\Model\Context  $context,
\Magento\Framework\Registry  $registry,
\Magento\Store\Model\StoresConfig  $storesConfig,
\Magento\Framework\Reflection\DataObjectProcessor  $dataObjectProcessor,
\Magento\Tax\Model\ClassModelFactory  $classModelFactory,
\Magento\Framework\Model\ResourceModel\AbstractResource  $resource = null,
\Magento\Framework\Data\Collection\AbstractDb  $resourceCollection = null,
array  $data = [] 
)

Constructor

Parameters
\Magento\Framework\Model\Context$context
\Magento\Framework\Registry$registry
\Magento\Store\Model\StoresConfig$storesConfig
\Magento\Framework\Reflection\DataObjectProcessor$dataObjectProcessor
\Magento\Tax\Model\ClassModelFactory$classModelFactory
\Magento\Framework\Model\ResourceModel\AbstractResource$resource
\Magento\Framework\Data\Collection\AbstractDb$resourceCollection
array$data@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 72 of file Group.php.

81  {
82  $this->_storesConfig = $storesConfig;
83  $this->dataObjectProcessor = $dataObjectProcessor;
84  $this->classModelFactory = $classModelFactory;
85  parent::__construct(
86  $context,
87  $registry,
88  $resource,
89  $resourceCollection,
90  $data
91  );
92  }
$resource
Definition: bulk.php:12

Member Function Documentation

◆ _construct()

_construct ( )
protected
Returns
void

Definition at line 97 of file Group.php.

98  {
99  $this->_init(\Magento\Customer\Model\ResourceModel\Group::class);
100  }

◆ _prepareData()

_prepareData ( )
protected

Prepare customer group data

Returns
$this

Definition at line 173 of file Group.php.

174  {
175  $this->setCode(substr($this->getCode(), 0, self::GROUP_CODE_MAX_LENGTH));
176  return $this;
177  }

◆ beforeSave()

beforeSave ( )

Prepare data before save

Returns
$this

Definition at line 162 of file Group.php.

163  {
164  $this->_prepareData();
165  return parent::beforeSave();
166  }

◆ getCode()

getCode ( )

Alias for getCustomerGroupCode

Returns
string

Definition at line 118 of file Group.php.

119  {
120  return $this->getCustomerGroupCode();
121  }

◆ getTaxClassName()

getTaxClassName ( )

Get tax class name

Returns
string

Definition at line 128 of file Group.php.

129  {
130  $taxClassName = $this->getData('tax_class_name');
131  if ($taxClassName) {
132  return $taxClassName;
133  }
134  $classModel = $this->classModelFactory->create();
135  $classModel->load($this->getTaxClassId());
136  $taxClassName = $classModel->getClassName();
137  $this->setData('tax_class_name', $taxClassName);
138  return $taxClassName;
139  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ setCode()

setCode (   $value)

Alias for setCustomerGroupCode

Parameters
string$value
Returns
$this

Definition at line 108 of file Group.php.

109  {
110  return $this->setCustomerGroupCode($value);
111  }
$value
Definition: gender.phtml:16

◆ usesAsDefault()

usesAsDefault ( )

Determine if this group is used as the create account default group

Returns
bool

Definition at line 146 of file Group.php.

147  {
148  $data = $this->_storesConfig->getStoresConfigByPath(
150  );
151  if (in_array($this->getId(), $data)) {
152  return true;
153  }
154  return false;
155  }

Field Documentation

◆ $_eventObject

$_eventObject = 'object'
protected

Definition at line 42 of file Group.php.

◆ $_eventPrefix

$_eventPrefix = 'customer_group'
protected

Definition at line 33 of file Group.php.

◆ $_storesConfig

$_storesConfig
protected

Definition at line 47 of file Group.php.

◆ $classModelFactory

$classModelFactory
protected

Definition at line 57 of file Group.php.

◆ $dataObjectProcessor

$dataObjectProcessor
protected

Definition at line 52 of file Group.php.

◆ CUST_GROUP_ALL

const CUST_GROUP_ALL = 32000

Definition at line 22 of file Group.php.

◆ ENTITY

const ENTITY = 'customer_group'

Definition at line 24 of file Group.php.

◆ GROUP_CODE_MAX_LENGTH

const GROUP_CODE_MAX_LENGTH = 32

Definition at line 26 of file Group.php.

◆ NOT_LOGGED_IN_ID

const NOT_LOGGED_IN_ID = 0

Definition at line 20 of file Group.php.


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