oxmodulefilesvalidator.php

Go to the documentation of this file.

<?php

class oxModuleFilesValidator implements oxIModuleValidator
{

    private $_aMissingFiles = array();

    private $_sPathToModuleDirectory = null;

    public function getPathToModuleDirectory()
    {
        if (is_null($this->_sPathToModuleDirectory)) {
            $this->setPathToModuleDirectory(oxRegistry::getConfig()->getModulesDir());
        }

        return $this->_sPathToModuleDirectory;
    }

    public function setPathToModuleDirectory($sPathToModuleDirectory)
    {
        $this->_sPathToModuleDirectory = $sPathToModuleDirectory;
    }

    public function validate(oxModule $oModule)
    {
        $this->_resetMissingFiles();
        $blModuleValid = $this->_allModuleExtensionsExists($oModule);
        $blModuleValid = $this->_allModuleFilesExists($oModule) && $blModuleValid;

        return $blModuleValid;
    }

    public function getMissingFiles()
    {
        return $this->_aMissingFiles;
    }

    protected function _resetMissingFiles()
    {
        $this->_aMissingFiles = array();
    }

    protected function _allModuleExtensionsExists($oModule)
    {
        $aModuleExtendedFiles = $oModule->getExtensions();
        $blAllModuleExtensionsExists = $this->_allFilesExists($aModuleExtendedFiles, true, 'extensions');

        return $blAllModuleExtensionsExists;
    }

    protected function _allModuleFilesExists($oModule)
    {
        $aModuleExtendedFiles = $oModule->getFiles();
        $blAllModuleFilesExists = $this->_allFilesExists($aModuleExtendedFiles);

        return $blAllModuleFilesExists;

    }

    private function _allFilesExists($aModuleExtendedFiles, $blAddExtension = false, $sListName = 'files')
    {
        $blAllModuleFilesExists = true;
        foreach ($aModuleExtendedFiles as $sModuleName => $sModulePath) {
            $sPathToModuleDirectory = $this->getPathToModuleDirectory();
            $sPathToModuleDirectory = $this->_addDirectorySeparatorAtTheEndIfNeeded($sPathToModuleDirectory);
            $sExtPath = $sPathToModuleDirectory . $sModulePath;
            if ($blAddExtension) {
                $sExtPath .= '.php';
            }
            if (!file_exists($sExtPath)) {
                $blAllModuleFilesExists = false;
                $this->_aMissingFiles[$sListName][$sModuleName] = $sModulePath;
            }
        }

        return $blAllModuleFilesExists;
    }

    private function _addDirectorySeparatorAtTheEndIfNeeded($sPathToModuleDirectory)
    {
        if (substr($sPathToModuleDirectory, -1) != DIRECTORY_SEPARATOR) {
            $sPathToModuleDirectory .= DIRECTORY_SEPARATOR;

            return $sPathToModuleDirectory;
        }

        return $sPathToModuleDirectory;
    }
}