oxerpgenimport.php

Go to the documentation of this file.

<?php

class oxErpGenImport extends oxErpCsv
{

    protected $_aObjects = array    (
                                'A' => 'article',
                                'K' => 'category',
                                'H' => 'vendor',
                                'C' => 'crossselling',
                                'Z' => 'accessoire',
                                'T' => 'article2category',
                                'I' => 'article2action',
                                'P' => 'scaleprice',
                                'U' => 'user',
                                'O' => 'order',
                                'R' => 'orderarticle',
                                'N' => 'country',
                                'Y' => 'artextends',
                            );
    protected $_aCsvFileFieldsOrder = array();

    protected $_blCsvContainsHeader = null;

    protected $_sDefaultStringTerminator = ";";

    protected $_sDefaultStringEncloser = '"';

    public function __call( $sMethod, $aArgs )
    {
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            if ( substr( $sMethod, 0, 4) == "UNIT" ) {
                $sMethod = str_replace( "UNIT", "_", $sMethod );
            }
            if ( method_exists( $this, $sMethod)) {
                return call_user_func_array( array( & $this, $sMethod ), $aArgs );
            }
        }

        throw new oxSystemComponentException( "Function '$sMethod' does not exist or is not accessible! (" . get_class($this) . ")".PHP_EOL);
    }

    public function __construct()
    {
        $this->_setDbLayerVersion();
    }

    public function getInstanceOfType( $sType )
    {
        return parent::_getInstanceOfType( $sType );
    }

    protected function _setDbLayerVersion()
    {
        $aVersions = array_keys(oxErpBase::$_aDbLayer2ShopDbVersions);
        $sVersion = array_pop( $aVersions) ;
        oxErpBase::setVersion( $sVersion );
    }

    protected function _modifyData($aData, $oType)
    {
        return $this->_mapFields($aData, $oType);
    }

    protected function _mapFields($aData, $oType)
    {
        $aRet = array();
        $iIndex = 0;

        foreach ( $this->_aCsvFileFieldsOrder as $sValue ) {
            if ( !empty($sValue) ) {
                if ( strtolower( $aData[$iIndex] ) == "null" ) {
                    $aRet[$sValue] = null;
                } else {
                    $aRet[$sValue] = $aData[$iIndex];
                }
            }
            $iIndex++;
        }

        return $aRet;
    }

    protected function _getImportType( & $aData )
    {
        $sType = $this->_sImportTypePrefix;

        if ( strlen($sType) != 1 || !array_key_exists($sType, $this->_aObjects) ) {
            throw new Exception("Error unknown command: ".$sType);
        } else {
            return $this->_aObjects[$sType];
        }
    }

    protected function _getImportMode( $aData )
    {
        return oxERPBase::$MODE_IMPORT;
    }

    public function getImportObject( $sType )
    {
        $this->_sImportTypePrefix = $sType;
        try {
            $sImportType = $this->_getImportType( $this->_aData );
            return $this->_getInstanceOfType( $sImportType );
        } catch( Exception $e) {
        }
    }

    public function setImportTypePrefix( $sType )
    {
        $this->_sImportTypePrefix = $sType;
    }

    public function getImportObjectsList()
    {
        foreach ( $this->_aObjects as $sKey => $sImportType ) {
            $oType = $this->_getInstanceOfType( $sImportType );
            $aList[$sKey] = $oType->getBaseTableName();
        }
        return $aList;
    }

    public function init( $sUserName, $sPassword, $iShopID = 1, $iLanguage = 0)
    {
        $myConfig = oxConfig::getInstance();
        $mySession = oxSession::getInstance();
        $oUser = oxUser::getAdminUser();

        if ( ( $oUser->oxuser__oxrights->value == "malladmin" || $oUser->oxuser__oxrights->value == $myConfig->getShopID()) ) {
            $this->_sSID        = $mySession->getId();
            $this->_blInit      = true;
            $this->_iLanguage   = oxLang::getInstance()->getBaseLanguage();
            $this->_sUserID     = $oUser->getId();
            //$mySession->freeze();
        } else {

            //user does not have sufficient rights for shop
            throw new Exception( self::ERROR_USER_NO_RIGHTS);
        }

        $this->_resetIdx();

        return $this->_blInit;
    }

    public function setCsvFileFieldsOrder( $aCsvFields )
    {
        $this->_aCsvFileFieldsOrder = $aCsvFields;
    }

    public function setCsvContainsHeader( $blCsvContainsHeader )
    {
        $this->_blCsvContainsHeader = $blCsvContainsHeader;
    }

    public function getTotalImportedRowsNumber()
    {
        $iTotal = 0;
        foreach ( $this->getStatistics() as $aValue ) {
            if ( $aValue ['r'] ) {
                $iTotal++;
            }
        }

        return $iTotal;
    }

    public function doImport($sPath = null, $sUserName = null, $sUserPassword = null, $sShopId = null, $sShopLanguage = null )
    {
        $myConfig = oxConfig::getInstance();
        $mySession = oxSession::getInstance();

        $this->_sReturn = "";
        $iMaxLineLength = 8192; //TODO change

        $this->_sPath = $sPath;

        //init with given data
        try {
            $this->init(null, null);
        }catch(Exception $ex){
            return $this->_sReturn = 'ERPGENIMPORT_ERROR_USER_NO_RIGHTS';
        }

        $file = @fopen($this->_sPath, "r");

        if ( isset($file) && $file ) {
            $iRow = 0;
            $aRow = array();

            while ( ($aRow = fgetcsv( $file, $iMaxLineLength, $this->_getCsvFieldsTerminator(), $this->_getCsvFieldsEncolser()) ) !== false ) {

                $this->_aData[] = $aRow;
            }

            if ( $this->_blCsvContainsHeader ) {
                //skipping first row - it's header
                array_shift( $this->_aData );
            }

            try {
                $this->Import();
            } catch (Exception $ex) {
                echo $ex->getMessage();
                $this->_sReturn = 'ERPGENIMPORT_ERROR_DURING_IMPORT';
            }

        } else {
            $this->_sReturn = 'ERPGENIMPORT_ERROR_WRONG_FILE';
        }

        @fclose($file);

        return $this->_sReturn;
    }

    protected function _getCsvFieldsTerminator()
    {
        $myConfig = oxConfig::getInstance();
        // deprecated
        $sChar = $myConfig->getConfigParam( 'sGiCsvFieldTerminator' );

        if ( !$sChar ) {
            $sChar = $myConfig->getConfigParam( 'sCSVSign' );
        }
        if ( !$sChar ) {
            $sChar = $this->_sDefaultStringTerminator;
        }
        return $sChar;
    }

    protected function _getCsvFieldsEncolser()
    {
        $myConfig = oxConfig::getInstance();

        if ( $sChar = $myConfig->getConfigParam( 'sGiCsvFieldEncloser' ) ) {
            return $sChar;
        } else {
            return $this->_sDefaultStringEncloser;
        }
    }
}