QuoteSetup Class Reference

Inheritance diagram for QuoteSetup:

Public Member Functions
	__construct (ModuleDataSetupInterface $setup, Context $context, CacheInterface $cache, CollectionFactory $attrGroupCollectionFactory, ScopeConfigInterface $config)
	addAttribute ($entityTypeId, $code, array $attr)
	getConfigModel ()
	getEncryptor ()
	getConnection ()
	getTable ($table)
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)

Protected Member Functions
	_flatTableExist ($table)
	_addFlatAttribute ($table, $attribute, $attr)
	_getAttributeColumnDefinition ($code, $data)

Protected Attributes
	$_config
	$_encryptor
	$_flatEntityTables

Detailed Description

Quote module setup class

@SuppressWarnings(PHPMD.CyclomaticComplexity) @codeCoverageIgnore

Definition at line 21 of file QuoteSetup.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

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

Definition at line 45 of file QuoteSetup.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 117 of file QuoteSetup.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;
    }

_flatTableExist()

_flatTableExist (   $table )

protected

Check if table exist for flat entity

Parameters

string

$table

Returns

bool

Definition at line 77 of file QuoteSetup.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.NPathComplexity)

Definition at line 141 of file QuoteSetup.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 94 of file QuoteSetup.php.

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

getConfigModel()

getConfigModel

(

)

Get config model

Returns

ScopeConfigInterface

Definition at line 186 of file QuoteSetup.php.

    {
        return $this->_config;
    }

getConnection()

getConnection

(

)

Get quote connection

Returns

\Magento\Framework\DB\Adapter\AdapterInterface

Definition at line 204 of file QuoteSetup.php.

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

getEncryptor()

getEncryptor

(

)

Returns

\Magento\Framework\Encryption\EncryptorInterface

Definition at line 194 of file QuoteSetup.php.

    {
        return $this->_encryptor;
    }

getTable()

getTable

(

$table

)

Get table name

Parameters

string

$table

Returns

string

Definition at line 215 of file QuoteSetup.php.

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

Field Documentation

$_config

$_config

protected

Definition at line 26 of file QuoteSetup.php.

$_encryptor

$_encryptor

protected

Definition at line 31 of file QuoteSetup.php.

$_flatEntityTables

$_flatEntityTables

protected

Initial value:

= [
        'quote' => 'quote',
        'quote_item' => 'quote_item',
        'quote_address' => 'quote_address',
        'quote_address_item' => 'quote_address_item',
        'quote_address_rate' => 'quote_shipping_rate',
        'quote_payment' => 'quote_payment',
    ]

Definition at line 62 of file QuoteSetup.php.

---

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

• vendor/magento/module-quote/Setup/QuoteSetup.php