ModuleResource Class Reference

Inheritance diagram for ModuleResource:

Public Member Functions
	getDbVersion ($moduleName)
	setDbVersion ($moduleName, $version)
	getDataVersion ($moduleName)
	setDataVersion ($moduleName, $version)
Public Member Functions inherited from AbstractDb
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, $connectionName=null)
	__sleep ()
	__wakeup ()
	getIdFieldName ()
	getMainTable ()
	getTable ($tableName)
	getConnection ()
	load (\Magento\Framework\Model\AbstractModel $object, $value, $field=null)
	save (\Magento\Framework\Model\AbstractModel $object)
	delete (\Magento\Framework\Model\AbstractModel $object)
	addUniqueField ($field)
	resetUniqueField ()
	unserializeFields (\Magento\Framework\Model\AbstractModel $object)
	getUniqueFields ()
	hasDataChanged ($object)
	getChecksum ($table)
	afterLoad (\Magento\Framework\DataObject $object)
	beforeSave (\Magento\Framework\DataObject $object)
	afterSave (\Magento\Framework\DataObject $object)
	beforeDelete (\Magento\Framework\DataObject $object)
	afterDelete (\Magento\Framework\DataObject $object)
	serializeFields (\Magento\Framework\Model\AbstractModel $object)
Public Member Functions inherited from AbstractResource
	__construct ()
	getConnection ()
	beginTransaction ()
	addCommitCallback ($callback)
	commit ()
	rollBack ()
	getValidationRulesBeforeSave ()

Static Public Member Functions
static	flush ()

Protected Member Functions
	_construct ()
	_loadVersion ($needType)
Protected Member Functions inherited from AbstractDb
	_init ($mainTable, $idFieldName)
	_setResource ($connections, $tables=null)
	_setMainTable ($mainTable, $idFieldName=null)
	_getConnection ($resourceName)
	_getLoadSelect ($field, $value, $object)
	_initUniqueFields ()
	_prepareDataForSave (\Magento\Framework\Model\AbstractModel $object)
	_prepareValueForSave ($value, $type)
	_checkUnique (\Magento\Framework\Model\AbstractModel $object)
	_afterLoad (\Magento\Framework\Model\AbstractModel $object)
	_beforeSave (\Magento\Framework\Model\AbstractModel $object)
	_afterSave (\Magento\Framework\Model\AbstractModel $object)
	_beforeDelete (\Magento\Framework\Model\AbstractModel $object)
	_afterDelete (\Magento\Framework\Model\AbstractModel $object)
	_serializeFields (\Magento\Framework\Model\AbstractModel $object)
	prepareDataForUpdate ($object)
	isObjectNotNew (\Magento\Framework\Model\AbstractModel $object)
	saveNewObject (\Magento\Framework\Model\AbstractModel $object)
	updateObject (\Magento\Framework\Model\AbstractModel $object)
	processAfterSaves (\Magento\Framework\Model\AbstractModel $object)
	isModified (\Magento\Framework\Model\AbstractModel $object)
	processNotModifiedSave (\Magento\Framework\Model\AbstractModel $object)
Protected Member Functions inherited from AbstractResource
	_construct ()
	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)
	_unserializeField (DataObject $object, $field, $defaultValue=null)
	_prepareDataForTable (DataObject $object, $table)
	_prepareTableValueForSave ($value, $type)
	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)
	getSerializer ()

Static Protected Attributes
static	$schemaVersions = null
static	$dataVersions = null

Additional Inherited Members
Protected Attributes inherited from AbstractDb
	$_resources
	$connectionName = \Magento\Framework\App\ResourceConnection::DEFAULT_CONNECTION
	$_connections = []
	$_resourceModel
	$_tables = []
	$_mainTable
	$_idFieldName
	$_isPkAutoIncrement = true
	$_useIsObjectNew = false
	$_mainTableFields
	$_uniqueFields = null
	$_serializableFields = []
	$transactionManager
	$objectRelationProcessor
Protected Attributes inherited from AbstractResource
	$serializer
	$_logger

Detailed Description

Resource Model

Deprecated:

Declarative schema and data patches replace old functionality and setup_module table So all resources related to this table, will be deprecated since 2.3.0

Definition at line 17 of file ModuleResource.php.

Member Function Documentation

_construct()

_construct ( )

protected

Define main table

Returns

void

Definition at line 38 of file ModuleResource.php.

    {
        $this->_init('setup_module', 'module');
    }

_loadVersion()

_loadVersion (   $needType )

protected

Fill static versions arrays. This routine fetches Db and Data versions of at once to optimize sql requests. However, when upgrading, it's possible that 'data' column will be created only after all Db installs are passed. So $neededType contains information on main purpose of calling this routine, and even when 'data' column is absent - it won't require reissuing new sql just to get 'db' version of module.

Parameters

string

$needType

Can be 'db' or 'data'

Returns

$this

Definition at line 53 of file ModuleResource.php.

    {
        if ($needType == 'db' && self::$schemaVersions === null ||
            $needType == 'data' && self::$dataVersions === null
        ) {
            self::$schemaVersions = [];
            // Db version column always exists
            self::$dataVersions = null;
            // Data version array will be filled only if Data column exist

            if ($this->getConnection()->isTableExists($this->getMainTable())) {
                $select = $this->getConnection()->select()->from($this->getMainTable(), '*');
                $rowset = $this->getConnection()->fetchAll($select);
                foreach ($rowset as $row) {
                    self::$schemaVersions[$row['module']] = $row['schema_version'];
                    if (array_key_exists('data_version', $row)) {
                        if (self::$dataVersions === null) {
                            self::$dataVersions = [];
                        }
                        self::$dataVersions[$row['module']] = $row['data_version'];
                    }
                }
            }
        }

        return $this;
    }

flush()

static flush ( )

static

Flush all class cache

Deprecated:

This method was added as temporary solution, to increase modularity: Because before new modules appears in resource only on next bootstrap

Returns

void

Definition at line 148 of file ModuleResource.php.

    {
        self::$dataVersions = null;
        self::$schemaVersions = [];
    }

getDataVersion()

getDataVersion

(

$moduleName

)

{Get resource data version

Parameters

string

$moduleName

Returns

string|false

}

Implements ResourceInterface.

Definition at line 116 of file ModuleResource.php.

    {
        if (!$this->getConnection()) {
            return false;
        }
        $this->_loadVersion('data');
        return self::$dataVersions[$moduleName] ?? false;
    }

getDbVersion()

getDbVersion

(

$moduleName

)

{Get Module version from DB

Parameters

string

$moduleName

Returns

false|string

}

Implements ResourceInterface.

Definition at line 84 of file ModuleResource.php.

    {
        if (!$this->getConnection()) {
            return false;
        }
        $this->_loadVersion('db');
        return self::$schemaVersions[$moduleName] ?? false;
    }

setDataVersion()

setDataVersion	(		$moduleName,
			$version
	)

{Set resource data version

Parameters

string	$moduleName
string	$version

Returns

void

}

Implements ResourceInterface.

Definition at line 128 of file ModuleResource.php.

    {
        $data = ['module' => $moduleName, 'data_version' => $version];

        if ($this->getDbVersion($moduleName) || $this->getDataVersion($moduleName)) {
            self::$dataVersions[$moduleName] = $version;
            $this->getConnection()->update($this->getMainTable(), $data, ['module = ?' => $moduleName]);
        } else {
            self::$dataVersions[$moduleName] = $version;
            $this->getConnection()->insert($this->getMainTable(), $data);
        }
    }

setDbVersion()

setDbVersion	(		$moduleName,
			$version
	)

{Set Module version

Parameters

string	$moduleName
string	$version

Returns

int

}

Implements ResourceInterface.

Definition at line 96 of file ModuleResource.php.

    {
        $dbModuleInfo = ['module' => $moduleName, 'schema_version' => $version];

        if ($this->getDbVersion($moduleName)) {
            self::$schemaVersions[$moduleName] = $version;
            return $this->getConnection()->update(
                $this->getMainTable(),
                $dbModuleInfo,
                ['module = ?' => $moduleName]
            );
        } else {
            self::$schemaVersions[$moduleName] = $version;
            return $this->getConnection()->insert($this->getMainTable(), $dbModuleInfo);
        }
    }

Field Documentation

$dataVersions

$dataVersions = null

staticprotected

Definition at line 31 of file ModuleResource.php.

$schemaVersions

$schemaVersions = null

staticprotected

Definition at line 24 of file ModuleResource.php.

---

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

• vendor/magento/framework/Module/ModuleResource.php