Inheritance diagram for SalesSetup:

Public Member Functions
	__construct (ModuleDataSetupInterface $setup, Context $context, CacheInterface $cache, CollectionFactory $attrGroupCollectionFactory, ScopeConfigInterface $config)

	addAttribute ($entityTypeId, $code, array $attr)

	getDefaultEntities ()

	getConfigModel ()

	getEncryptor ()

	getConnection ()

	getTable ($table)

	updateEntityTypes ()

Public Member Functions inherited from EavSetup
	__construct (ModuleDataSetupInterface $setup, Context $context, CacheInterface $cache, CollectionFactory $attrGroupCollectionFactory)

	getSetup ()

	getAttributeGroupCollectionFactory ()

	cleanCache ()

	installDefaultGroupIds ()

	addEntityType ($code, array $params)

	updateEntityType ($code, $field, $value=null)

	getEntityType ($id, $field=null)

	getEntityTypeId ($entityTypeId)

	removeEntityType ($id)

	getAttributeSetSortOrder ($entityTypeId, $sortOrder=null)

	addAttributeSet ($entityTypeId, $name, $sortOrder=null, $setId=null)

	updateAttributeSet ($entityTypeId, $id, $field, $value=null)

	getAttributeSet ($entityTypeId, $id, $field=null)

	getAttributeSetId ($entityTypeId, $setId)

	removeAttributeSet ($entityTypeId, $id)

	setDefaultSetToEntityType ($entityType, $attributeSet='Default')

	getAllAttributeSetIds ($entityTypeId=null)

	getDefaultAttributeSetId ($entityType)

	getAttributeGroupSortOrder ($entityTypeId, $setId, $sortOrder=null)

	addAttributeGroup ($entityTypeId, $setId, $name, $sortOrder=null)

	convertToAttributeGroupCode ($groupName)

	updateAttributeGroup ($entityTypeId, $setId, $id, $field, $value=null)

	getAttributeGroup ($entityTypeId, $setId, $id, $field=null)

	getAttributeGroupByCode ($entityTypeId, $setId, $code, $field=null)

	getAttributeGroupId ($entityTypeId, $setId, $groupId)

	removeAttributeGroup ($entityTypeId, $setId, $id)

	getDefaultAttributeGroupId ($entityType, $attributeSetId=null)

	getAttributesNumberInGroup ($entityTypeId, $setId, $groupId)

	addAttribute ($entityTypeId, $code, array $attr)

	addAttributeOption ($option)

	updateAttribute ($entityTypeId, $id, $field, $value=null, $sortOrder=null)

	getAttribute ($entityTypeId, $id, $field=null)

	getAttributeId ($entityTypeId, $id)

	getAttributeTable ($entityTypeId, $id)

	removeAttribute ($entityTypeId, $code)

	getAttributeSortOrder ($entityTypeId, $setId, $groupId, $sortOrder=null)

	addAttributeToSet ($entityTypeId, $setId, $groupId, $attributeId, $sortOrder=null)

	addAttributeToGroup ($entityType, $setId, $groupId, $attributeId, $sortOrder=null)

	getDefaultEntities ()

	installEntities ($entities=null)

Data Fields
const	ORDER_ENTITY_TYPE_ID = 5

const	INVOICE_PRODUCT_ENTITY_TYPE_ID = 6

const	CREDITMEMO_PRODUCT_ENTITY_TYPE_ID = 7

const	SHIPMENT_PRODUCT_ENTITY_TYPE_ID = 8

Protected Member Functions
	_flatTableExist ($table)

	_addFlatAttribute ($table, $attribute, $attr)

	_addGridAttribute ($table, $attribute, $attr, $entityTypeId)

	_getAttributeColumnDefinition ($code, $data)

Protected Attributes
	$config

	$encryptor

	$_flatEntityTables

	$_flatEntitiesGrid = ['order', 'invoice', 'shipment', 'creditmemo']

Detailed Description

Sales module setup class

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @codeCoverageIgnore

Definition at line 23 of file SalesSetup.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ModuleDataSetupInterface	$setup,
		Context	$context,
		CacheInterface	$cache,
		CollectionFactory	$attrGroupCollectionFactory,
		ScopeConfigInterface	$config
	)

Constructor

Parameters

ModuleDataSetupInterface	$setup
Context	$context
CacheInterface	$cache
CollectionFactory	$attrGroupCollectionFactory
ScopeConfigInterface	$config

Definition at line 69 of file SalesSetup.php.

       {
         $this->config = $config;
         $this->encryptor = $context->getEncryptor();
         parent::__construct($setup, $context, $cache, $attrGroupCollectionFactory);
     }

Member Function Documentation

◆ _addFlatAttribute()

_addFlatAttribute	(	$table,
		$attribute,
		$attr
	)

protected

Add attribute as separate column in the table

Parameters

string	$table
string	$attribute
array	$attr

Returns: $this

Definition at line 159 of file SalesSetup.php.

     {
         $tableInfo = $this->getConnection()
             ->describeTable($this->getTable($table));
         if (isset($tableInfo[$attribute])) {
             return $this;
         }
         $columnDefinition = $this->_getAttributeColumnDefinition($attribute, $attr);
         $this->getConnection()->addColumn(
             $this->getTable($table),
             $attribute,
             $columnDefinition
         );
         return $this;
     }

◆ _addGridAttribute()

_addGridAttribute	(	$table,
		$attribute,
		$attr,
		$entityTypeId
	)

protected

Add attribute to grid table if necessary

Parameters

string	$table
string	$attribute
array	$attr
string	$entityTypeId

Returns: $this

Definition at line 184 of file SalesSetup.php.

     {
         if (in_array($entityTypeId, $this->_flatEntitiesGrid) && !empty($attr['grid'])) {
             $columnDefinition = $this->_getAttributeColumnDefinition($attribute, $attr);
             $this->getConnection()->addColumn(
                 $this->getTable($table . '_grid'),
                 $attribute,
                 $columnDefinition
             );
         }
         return $this;
     }

◆ _flatTableExist()

_flatTableExist ( $table )

protected

Check if table exist for flat entity

Parameters

string $table

Returns: bool

Definition at line 117 of file SalesSetup.php.

     {
         $tablesList = $this->getConnection()
             ->listTables();
         return in_array(
             strtoupper($this->getTable($table)),
             array_map('strtoupper', $tablesList)
         );
     }

◆ _getAttributeColumnDefinition()

_getAttributeColumnDefinition	(	$code,
		$data
	)

protected

Retrieve definition of column for create in flat table

Parameters

string	$code
array	$data

Returns: array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 206 of file SalesSetup.php.

     {
         // Convert attribute type to column info
         $data['type'] = isset($data['type']) ? $data['type'] : 'varchar';
         $type = null;
         $length = null;
         switch ($data['type']) {
             case 'timestamp':
                 $type = \Magento\Framework\DB\Ddl\Table::TYPE_TIMESTAMP;
                 break;
             case 'datetime':
                 $type = \Magento\Framework\DB\Ddl\Table::TYPE_DATETIME;
                 break;
             case 'decimal':
                 $type = \Magento\Framework\DB\Ddl\Table::TYPE_DECIMAL;
                 $length = '12,4';
                 break;
             case 'int':
                 $type = \Magento\Framework\DB\Ddl\Table::TYPE_INTEGER;
                 break;
             case 'text':
                 $type = \Magento\Framework\DB\Ddl\Table::TYPE_TEXT;
                 $length = 65536;
                 break;
             case 'char':
             case 'varchar':
                 $type = \Magento\Framework\DB\Ddl\Table::TYPE_TEXT;
                 $length = 255;
                 break;
         }
         if ($type !== null) {
             $data['type'] = $type;
             $data['length'] = $length;
         }
 
         $data['nullable'] = isset($data['required']) ? !$data['required'] : true;
         $data['comment'] = isset($data['comment']) ? $data['comment'] : ucwords(str_replace('_', ' ', $code));
         return $data;
     }

◆ addAttribute()

addAttribute	(		$entityTypeId,
			$code,
		array	$attr
	)

Add entity attribute. Overwritten for flat entities support

Parameters

int \| string	$entityTypeId
string	$code
array	$attr

Returns: $this

Definition at line 135 of file SalesSetup.php.

     {
         if (isset(
             $this->_flatEntityTables[$entityTypeId]
         ) && $this->_flatTableExist(
             $this->_flatEntityTables[$entityTypeId]
         )
         ) {
             $this->_addFlatAttribute($this->_flatEntityTables[$entityTypeId], $code, $attr);
             $this->_addGridAttribute($this->_flatEntityTables[$entityTypeId], $code, $attr, $entityTypeId);
         } else {
             parent::addAttribute($entityTypeId, $code, $attr);
         }
         return $this;
     }

◆ getConfigModel()

getConfigModel ( )

Get config model

Returns: ScopeConfigInterface

Definition at line 293 of file SalesSetup.php.

     {
         return $this->config;
     }

◆ getConnection()

getConnection ( )

Returns: \Magento\Framework\DB\Adapter\AdapterInterface

Definition at line 309 of file SalesSetup.php.

     {
         return $this->getSetup()->getConnection(self::$connectionName);
     }

◆ getDefaultEntities()

getDefaultEntities ( )

Returns: array

Definition at line 249 of file SalesSetup.php.

     {
         $entities = [
             'order' => [
                 'entity_type_id' => self::ORDER_ENTITY_TYPE_ID,
                 'entity_model' => \Magento\Sales\Model\ResourceModel\Order::class,
                 'table' => 'sales_order',
                 'increment_model' => \Magento\Eav\Model\Entity\Increment\NumericValue::class,
                 'increment_per_store' => true,
                 'attributes' => [],
             ],
             'invoice' => [
                 'entity_type_id' => self::INVOICE_PRODUCT_ENTITY_TYPE_ID,
                 'entity_model' => \Magento\Sales\Model\ResourceModel\Order\Invoice::class,
                 'table' => 'sales_invoice',
                 'increment_model' => \Magento\Eav\Model\Entity\Increment\NumericValue::class,
                 'increment_per_store' => true,
                 'attributes' => [],
             ],
             'creditmemo' => [
                 'entity_type_id' => self::CREDITMEMO_PRODUCT_ENTITY_TYPE_ID,
                 'entity_model' => \Magento\Sales\Model\ResourceModel\Order\Creditmemo::class,
                 'table' => 'sales_creditmemo',
                 'increment_model' => \Magento\Eav\Model\Entity\Increment\NumericValue::class,
                 'increment_per_store' => true,
                 'attributes' => [],
             ],
             'shipment' => [
                 'entity_type_id' => self::SHIPMENT_PRODUCT_ENTITY_TYPE_ID,
                 'entity_model' => \Magento\Sales\Model\ResourceModel\Order\Shipment::class,
                 'table' => 'sales_shipment',
                 'increment_model' => \Magento\Eav\Model\Entity\Increment\NumericValue::class,
                 'increment_per_store' => true,
                 'attributes' => [],
             ],
         ];
         return $entities;
     }

◆ getEncryptor()

getEncryptor ( )

Returns: EncryptorInterface

Definition at line 301 of file SalesSetup.php.

     {
         return $this->encryptor;
     }

◆ getTable()

getTable ( $table )

Get table name

Parameters

string $table

Returns: string

Definition at line 320 of file SalesSetup.php.

     {
         return $this->getSetup()->getTable($table, self::$connectionName);
     }

◆ updateEntityTypes()

updateEntityTypes ( )

Update entity types

Returns: void

Definition at line 330 of file SalesSetup.php.

     {
         $this->updateEntityType(
             \Magento\Sales\Model\Order::ENTITY,
             'entity_model',
             \Magento\Sales\Model\ResourceModel\Order::class
         );
         $this->updateEntityType(
             \Magento\Sales\Model\Order::ENTITY,
             'increment_model',
             \Magento\Eav\Model\Entity\Increment\NumericValue::class
         );
         $this->updateEntityType(
             'invoice',
             'entity_model',
             \Magento\Sales\Model\ResourceModel\Order::class
         );
         $this->updateEntityType(
             'invoice',
             'increment_model',
             \Magento\Eav\Model\Entity\Increment\NumericValue::class
         );
         $this->updateEntityType(
             'creditmemo',
             'entity_model',
             \Magento\Sales\Model\ResourceModel\Order\Creditmemo::class
         );
         $this->updateEntityType(
             'creditmemo',
             'increment_model',
             \Magento\Eav\Model\Entity\Increment\NumericValue::class
         );
         $this->updateEntityType(
             'shipment',
             'entity_model',
             \Magento\Sales\Model\ResourceModel\Order\Shipment::class
         );
         $this->updateEntityType(
             'shipment',
             'increment_model',
             \Magento\Eav\Model\Entity\Increment\NumericValue::class
         );
     }

Field Documentation

◆ $_flatEntitiesGrid

$_flatEntitiesGrid = ['order', 'invoice', 'shipment', 'creditmemo']

protected

Definition at line 109 of file SalesSetup.php.

◆ $_flatEntityTables

$_flatEntityTables

protected

Initial value:

= [
        'order' => 'sales_order',
        'order_payment' => 'sales_order_payment',
        'order_item' => 'sales_order_item',
        'order_address' => 'sales_order_address',
        'order_status_history' => 'sales_order_status_history',
        'invoice' => 'sales_invoice',
        'invoice_item' => 'sales_invoice_item',
        'invoice_comment' => 'sales_invoice_comment',
        'creditmemo' => 'sales_creditmemo',
        'creditmemo_item' => 'sales_creditmemo_item',
        'creditmemo_comment' => 'sales_creditmemo_comment',
        'shipment' => 'sales_shipment',
        'shipment_item' => 'sales_shipment_item',
        'shipment_track' => 'sales_shipment_track',
        'shipment_comment' => 'sales_shipment_comment',
    ]

Definition at line 86 of file SalesSetup.php.

◆ $config

$config

protected

Definition at line 48 of file SalesSetup.php.

◆ $encryptor

$encryptor

protected

Definition at line 53 of file SalesSetup.php.

◆ CREDITMEMO_PRODUCT_ENTITY_TYPE_ID

const CREDITMEMO_PRODUCT_ENTITY_TYPE_ID = 7

This should be set explicitly

Definition at line 38 of file SalesSetup.php.

◆ INVOICE_PRODUCT_ENTITY_TYPE_ID

const INVOICE_PRODUCT_ENTITY_TYPE_ID = 6

This should be set explicitly

Definition at line 33 of file SalesSetup.php.

◆ ORDER_ENTITY_TYPE_ID

const ORDER_ENTITY_TYPE_ID = 5

This should be set explicitly

Definition at line 28 of file SalesSetup.php.

◆ SHIPMENT_PRODUCT_ENTITY_TYPE_ID

const SHIPMENT_PRODUCT_ENTITY_TYPE_ID = 8

This should be set explicitly

Definition at line 43 of file SalesSetup.php.

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

vendor/magento/module-sales/Setup/SalesSetup.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addFlatAttribute()

◆ _addGridAttribute()

◆ _flatTableExist()

◆ _getAttributeColumnDefinition()

◆ addAttribute()

◆ getConfigModel()

◆ getConnection()

◆ getDefaultEntities()

◆ getEncryptor()

◆ getTable()

◆ updateEntityTypes()

Field Documentation

◆ $_flatEntitiesGrid

◆ $_flatEntityTables

◆ $config

◆ $encryptor

◆ CREDITMEMO_PRODUCT_ENTITY_TYPE_ID

◆ INVOICE_PRODUCT_ENTITY_TYPE_ID

◆ ORDER_ENTITY_TYPE_ID

◆ SHIPMENT_PRODUCT_ENTITY_TYPE_ID