DbVersionInfo.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Module;

use Magento\Framework\Setup\ModuleDataSetupInterface;

class DbVersionInfo
{
    const KEY_MODULE = 'module';
    const KEY_TYPE = 'type';
    const KEY_CURRENT = 'current';
    const KEY_REQUIRED = 'required';
    private $moduleList;

    private $moduleResource;

    private $dbVersionErrorsCache = null;

    public function __construct(
        ModuleListInterface $moduleList,
        ResourceInterface $moduleResource
    ) {
        $this->moduleList = $moduleList;
        $this->moduleResource = $moduleResource;
    }

    public function isSchemaUpToDate($moduleName)
    {
        $dbVer = $this->moduleResource->getDbVersion($moduleName);
        return $this->isModuleVersionEqual($moduleName, $dbVer);
    }

    public function isDataUpToDate($moduleName)
    {
        $dataVer = $this->moduleResource->getDataVersion($moduleName);
        return $this->isModuleVersionEqual($moduleName, $dataVer);
    }

    private function getSchemaInfo($moduleName)
    {
        $dbVer = $this->moduleResource->getDbVersion($moduleName); // version saved in DB
        $module = $this->moduleList->getOne($moduleName);
        $configVer = $module['setup_version'];
        $dbVer = $dbVer ?: 'none';
        return [
            self::KEY_CURRENT => $dbVer,
            self::KEY_REQUIRED => $configVer,
            self::KEY_MODULE => $moduleName,
            self::KEY_TYPE => 'schema'
        ];
    }

    public function getDbVersionErrors()
    {
        if ($this->dbVersionErrorsCache === null) {
            $this->dbVersionErrorsCache = [];
            foreach ($this->moduleList->getNames() as $moduleName) {
                if (!$this->isSchemaUpToDate($moduleName)) {
                    $this->dbVersionErrorsCache[] = $this->getSchemaInfo($moduleName);
                }
                if (!$this->isDataUpToDate($moduleName)) {
                    $this->dbVersionErrorsCache[] = $this->getDataInfo($moduleName);
                }
            }
        }

        return $this->dbVersionErrorsCache;
    }

    private function getDataInfo($moduleName)
    {
        $dataVer = $this->moduleResource->getDataVersion($moduleName);
        $module = $this->moduleList->getOne($moduleName);
        $configVer = $module['setup_version'];
        $dataVer = $dataVer ?: 'none';
        return [
            self::KEY_CURRENT => $dataVer,
            self::KEY_REQUIRED => $configVer,
            self::KEY_MODULE => $moduleName,
            self::KEY_TYPE => 'data'
        ];
    }

    private function isModuleVersionEqual($moduleName, $version)
    {
        $module = $this->moduleList->getOne($moduleName);
        $configVer = isset($module['setup_version']) ? $module['setup_version'] : null;

        if (empty($configVer)) {
            return true;
        }

        return version_compare($configVer, $version) === ModuleDataSetupInterface::VERSION_COMPARE_EQUAL;
    }
}