DataSetup Class Reference

Inheritance diagram for DataSetup:

Public Member Functions
	__construct (\Magento\Framework\Module\Setup\Context $context, $connectionName=ModuleDataSetupInterface::DEFAULT_SETUP_CONNECTION)
	getSetupCache ()
	getTableRow ($table, $idField, $rowId, $field=null, $parentField=null, $parentId=0)
	deleteTableRow ($table, $idField, $rowId, $parentField=null, $parentId=0)
	updateTableRow ($table, $idField, $rowId, $field, $value=null, $parentField=null, $parentId=0)
	getEventManager ()
	getFilesystem ()
	createMigrationSetup (array $data=[])
Public Member Functions inherited from Setup
	__construct (\Magento\Framework\App\ResourceConnection $resource, $connectionName=ModuleDataSetupInterface::DEFAULT_SETUP_CONNECTION)
	getConnection ($connectionName=null)
	setTable ($tableName, $realTableName)
	getTablePlaceholder ($tableName)
	getTable ($tableName, $connectionName=ResourceConnection::DEFAULT_CONNECTION)
	tableExists ($table, $connectionName=ResourceConnection::DEFAULT_CONNECTION)
	run ($sql)
	startSetup ()
	endSetup ()
Public Member Functions inherited from SetupInterface
	getConnection ()
	getTable ($tableName)
	tableExists ($table)

Additional Inherited Members
Data Fields inherited from ModuleDataSetupInterface
const	DEFAULT_SETUP_CONNECTION = 'default_setup'
const	VERSION_COMPARE_EQUAL = 0
const	VERSION_COMPARE_LOWER = -1
const	VERSION_COMPARE_GREATER = 1
const	TYPE_DATA_INSTALL = 'data-install'
const	TYPE_DATA_UPGRADE = 'data-upgrade'

Detailed Description

@api

Definition at line 17 of file DataSetup.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Module\Setup\Context	$context,
			$connectionName = ModuleDataSetupInterface::DEFAULT_SETUP_CONNECTION
	)

Init

Parameters

\Magento\Framework\Module\Setup\Context	$context
string	$connectionName

Definition at line 60 of file DataSetup.php.

      {
        parent::__construct($context->getResourceModel(), $connectionName);
        $this->_eventManager = $context->getEventManager();
        $this->_logger = $context->getLogger();
        $this->_migrationFactory = $context->getMigrationFactory();
        $this->filesystem = $context->getFilesystem();
        $this->setupCache = new SetupCache();
    }

Member Function Documentation

createMigrationSetup()

createMigrationSetup

(

array

$data = []

)

Create migration setup

Parameters

array

$data

Returns

\Magento\Framework\Module\Setup\Migration

Implements ModuleDataSetupInterface.

Definition at line 201 of file DataSetup.php.

    {
        $data['setup'] = $this;
        return $this->_migrationFactory->create($data);
    }

deleteTableRow()

deleteTableRow	(		$table,
			$idField,
			$rowId,
			$parentField = null,
			$parentId = 0
	)

Delete table row

Parameters

string	$table
string	$idField
string | int	$rowId
null | string	$parentField
int | string	$parentId

Returns

$this

Implements ModuleDataSetupInterface.

Definition at line 120 of file DataSetup.php.

    {
        $table = $this->getTable($table);
        $connection = $this->getConnection();
        $where = [$connection->quoteIdentifier($idField) . '=?' => $rowId];
        if (null !== $parentField) {
            $where[$connection->quoteIdentifier($parentField) . '=?'] = $parentId;
        }

        $connection->delete($table, $where);

        $this->setupCache->remove($table, $parentId, $rowId);

        return $this;
    }

getEventManager()

getEventManager

(

)

Gets event manager

Returns

\Magento\Framework\Event\ManagerInterface

Implements ModuleDataSetupInterface.

Definition at line 180 of file DataSetup.php.

    {
        return $this->_eventManager;
    }

getFilesystem()

getFilesystem

(

)

Gets filesystem

Returns

\Magento\Framework\Filesystem

Implements ModuleDataSetupInterface.

Definition at line 190 of file DataSetup.php.

    {
        return $this->filesystem;
    }

getSetupCache()

getSetupCache

(

)

{Gets setup cache

Returns

DataCacheInterface

}

Implements ModuleDataSetupInterface.

Definition at line 75 of file DataSetup.php.

    {
        return $this->setupCache;
    }

getTableRow()

getTableRow	(		$table,
			$idField,
			$rowId,
			$field = null,
			$parentField = null,
			$parentId = 0
	)

Retrieve row or field from table by id or string and parent id

Parameters

string	$table
string	$idField
string | integer	$rowId
string | null	$field
string | null	$parentField
string | integer	$parentId

Returns

mixed

Implements ModuleDataSetupInterface.

Definition at line 91 of file DataSetup.php.

    {
        $table = $this->getTable($table);
        if (!$this->setupCache->has($table, $parentId, $rowId)) {
            $connection = $this->getConnection();
            $bind = ['id_field' => $rowId];
            $select = $connection->select()
                ->from($table)
                ->where($connection->quoteIdentifier($idField) . '= :id_field');
            if (null !== $parentField) {
                $select->where($connection->quoteIdentifier($parentField) . '= :parent_id');
                $bind['parent_id'] = $parentId;
            }
            $this->setupCache->setRow($table, $parentId, $rowId, $connection->fetchRow($select, $bind));
        }

        return $this->setupCache->get($table, $parentId, $rowId, $field);
    }

updateTableRow()

updateTableRow	(		$table,
			$idField,
			$rowId,
			$field,
			$value = null,
			$parentField = null,
			$parentId = 0
	)

Update one or more fields of table row

Parameters

string	$table
string	$idField
string | integer	$rowId
string | array	$field
mixed | null	$value
string	$parentField
string | integer	$parentId

Returns

$this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements ModuleDataSetupInterface.

Definition at line 149 of file DataSetup.php.

    {
        $table = $this->getTable($table);
        if (is_array($field)) {
            $data = $field;
        } else {
            $data = [$field => $value];
        }

        $connection = $this->getConnection();
        $where = [$connection->quoteIdentifier($idField) . '=?' => $rowId];
        $connection->update($table, $data, $where);

        if (is_array($field)) {
            $oldRow = $this->setupCache->has($table, $parentId, $rowId) ?
                $this->setupCache->get($table, $parentId, $rowId) :
                [];
            $newRowData = array_merge($oldRow, $field);
            $this->setupCache->setRow($table, $parentId, $rowId, $newRowData);
        } else {
            $this->setupCache->setField($table, $parentId, $rowId, $field, $value);
        }

        return $this;
    }

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Module/DataSetup.php