oxerptype.php

Go to the documentation of this file.

<?php

class oxERPType
{
    public static $ERROR_WRONG_SHOPID = "Wrong shop id, operation not allowed!";

    protected $_sTableName        = null;

    protected $_sFunctionSuffix   = null;

    protected $_aFieldList        = null;

    protected $_aKeyFieldList     = null;

    protected $_sShopObjectName   = null;

    protected $_blRestrictedByShopId = false;

    protected $_aFieldListVersions = null;

    public function getFunctionSuffix()
    {
        return $this->_sFunctionSuffix;
    }

    public function getShopObjectName()
    {
        return $this->_sShopObjectName;
    }

    public function getBaseTableName()
    {
        return $this->_sTableName;
    }

    public function __construct()
    {
        $this->_sFunctionSuffix = str_replace( "oxERPType_", "", get_class( $this));
        if (isset($this->_aFieldListVersions)) {
            $this->_aFieldList = $this->_aFieldListVersions[oxERPBase::getUsedDbFieldsVersion()];
        }
    }

    public function setFunctionSuffix( $sNew )
    {
        $this->_sFunctionSuffix = $sNew;
    }

    public function setFieldList($aFieldList)
    {
        $this->_aFieldList = $aFieldList;
    }

    public function getTableName( $iShopID = 1 )
    {
        return getViewName( $this->_sTableName, $iShopID );
    }

    private function _getMultilangualFields()
    {
        $aRet = array();

        $aData = oxDb::getInstance()->getTableDescription( $this->_sTableName);

        foreach ( $aData as $key => $oADODBField) {
            $iLang = substr( $oADODBField->name, strlen( $oADODBField->name) - 1, 1);
            if ( is_numeric( $iLang) &&  substr( $oADODBField->name, strlen( $oADODBField->name) - 2, 1) == '_') {
                // multilangual field
                $sMainFld = str_replace( '_'.$iLang, "", $oADODBField->name);
                $aRet[$iLang][$sMainFld] = $oADODBField->name.' as '.$sMainFld;
            }
        }

        return $aRet;
    }

    protected function getSqlFieldName($sField, $iLanguage = 0, $iShopID = 1)
    {
        if ( $iLanguage ) {
            $aMultiLang = $this->_getMultilangualFields();
            // we need to load different fields
            if ( isset( $aMultiLang[$iLanguage][$sField] ) ) {
                $sField = $aMultiLang[$iLanguage][$sField];
            }
        }
        return $sField;
    }

    public function getSQL( $sWhere, $iLanguage = 0, $iShopID = 1)
    {
        if ( !$this->_aFieldList ) {
            return;
        }

        $sSQL    = 'select ';
        $blSep = false;

        foreach ( $this->_aFieldList as $sField) {
            if ( $blSep ) {
                $sSQL .= ',';
            }

            $sSQL .= $this->getSqlFieldName($sField, $iLanguage, $iShopID);
            $blSep = true;
        }

        if ( $this->_blRestrictedByShopId ) {
            $oStr = getStr();
            if ( $oStr->strstr( $sWhere, 'where')) {
                $sWhere .= ' and ';
            } else {
                $sWhere .= ' where ';
            }

            $sWhere .= 'oxshopid = \''.$iShopID.'\'';
        }

        $sSQL .= ' from '.$this->getTableName($iShopID).' '.$sWhere;

        return $sSQL;
    }

    public function getSortString($sFieldName = null, $sType = null)
    {
        $sRes = " order by ";
        if ($sFieldName) {
            $sRes .= $sFieldName;
        } else {
            $sRes .= "oxid";
        }
        if ($sType && ($sType == "ASC" || $sType == "DESC")) {
            $sRes .= " ". $sType;
        }
        return $sRes;
    }

    public function checkWriteAccess($sOxid)
    {
        $oObj = oxNew("oxbase");
        $oObj->init($this->_sTableName);
        if ( $oObj->load( $sOxid ) ) {
            $sFld = $this->_sTableName.'__oxshopid';
            if ( isset( $oObj->$sFld ) ) {
                $sRes = $oObj->$sFld->value;
                if ( $sRes && $sRes != oxConfig::getInstance()->getShopId() ) {
                    throw new Exception( oxERPBase::$ERROR_USER_NO_RIGHTS);
                }
            }
        }
    }

    public function getObjectForDeletion( $sId)
    {
        $myConfig = oxConfig::getInstance();

        if ( !isset( $sId ) ) {
            throw new Exception( "Missing ID!");
        }

        $oObj = oxNew( $this->getShopObjectName(), "core");

        if ( !$oObj->exists( $sId ) ) {
            throw new Exception( $this->getShopObjectName(). " " . $sId. " does not exists!");
        }

        //We must load the object here, to check shopid and return it for further checks
        if ( !$oObj->load( $sId ) ) {
            //its possible that access is restricted allready
            throw new Exception( "No right to delete object {$sId} !");
        }

        if ( !$this->_isAllowedToEdit($oObj->getShopId() ) ) {
            throw new Exception( "No right to delete object {$sId} !");
        }

        return $oObj;
    }

    protected function _isAllowedToEdit($iShopId)
    {
        if ($oUsr = oxUser::getAdminUser()) {
            if ($oUsr->oxuser__oxrights->value == "malladmin") {
                return true;
            } elseif ($oUsr->oxuser__oxrights->value == (int) $iShopId) {
                return true;
            }
        }
        return false;
    }

    protected function _directSqlCheckForDeletion($sId)
    {
        $oDb =oxDb::getDb();
        $sSql = "select oxshopid from ".$this->_sTableName." where oxid = " .$oDb->quote( $sId );
        try {
            $iShopId = $oDb->getOne($sSql);
        } catch (Exception $e) {
            // no shopid was found
            return;
        }
        if ( !$this->_isAllowedToEdit( $iShopId ) ) {
            throw new Exception( "No right to delete object {$sId} !");
        }
    }

    public function checkForDeletion($sId)
    {

        if ( !isset( $sId ) ) {
            throw new Exception( "Missing ID!");
        }
        // malladmin can do it
        if ($oUsr = oxUser::getAdminUser()) {
            if ($oUsr->oxuser__oxrights->value == "malladmin") {
                return;
            }
        }
        try {
            $this->getObjectForDeletion($sId);
        } catch (oxSystemComponentException $e) {
            if ($e->getMessage() == 'EXCEPTION_SYSTEMCOMPONENT_CLASSNOTFOUND') {
                $this->_directSqlCheckForDeletion($sId);
            } else {
                throw $e;
            }
        }
    }

    public function delete($sID)
    {
        $oDb = oxDb::getDb();
        $sSql = "delete from ".$this->_sTableName." where oxid = " . $oDb->quote( $sID );

        return $oDb->Execute($sSql);
    }

    public function deleteObject($oObj, $sID)
    {

        return $oObj->delete($sID);
    }

    public function addExportData( $aFields)
    {
        return $aFields;
    }

    public function addImportData($aFields)
    {
        return $aFields;
    }

    public function getRightFields()
    {
        $aRParams = array();

        foreach ( $this->_aFieldList as $sField ) {
            $aRParams[] = strtolower($this->_sTableName.'__'.$sField);
        }
        return $aRParams;
    }

    public function getFieldList()
    {
        return $this->_aFieldList;
    }

    public function getKeyFields()
    {
        return $this->_aKeyFieldList;
    }

    public function hasKeyFields()
    {
        if ( isset( $this->_aKeyFieldList ) && is_array( $this->_aKeyFieldList ) ) {
            return true;
        }
        return false;
    }

    protected function _preAssignObject($oShopObject, $aData, $blAllowCustomShopId)
    {
        if ( !isset( $aData['OXID'] ) ) {
            throw new Exception( "OXID missing, seems to be wrong Format!");
        }
        if ( !$oShopObject->exists( $aData['OXID'] ) ) {
            //$aData['OXSHOPID'] = $this->_iShopID;
            if ( !$blAllowCustomShopId ) {
                if (isset($aData['OXSHOPID'])) {
                    $aData['OXSHOPID'] = oxConfig::getInstance()->getShopId();
                }
            }
            if ( !array_key_exists('OXSHOPINCL', $aData ) ) {
                $aData['OXSHOPINCL'] = oxUtils::getInstance()->getShopBit($aData['OXSHOPID']);
            }
            if ( !array_key_exists( 'OXSHOPEXCL', $aData ) ) {
                $aData['OXSHOPEXCL'] = 0;
            }
        }
        if (isset($aData['OXACTIV'])) {
            $aData['OXACTIVE'] = $aData['OXACTIV'];
        }
        if (isset($aData['OXACTIVFROM'])) {
            $aData['OXACTIVEFROM'] = $aData['OXACTIVFROM'];
        }
        if (isset($aData['OXACTIVTO'])) {
            $aData['OXACTIVETO'] = $aData['OXACTIVTO'];
        }
        for ($i=1;$i<4;$i++) {
            if (isset($aData['OXACTIV_'.$i])) {
                $aData['OXACTIVE_'.$i] = $aData['OXACTIV_'.$i];
            }
        }
        // null values support
        foreach ($aData as $key => $val) {
            if ( !strlen( (string) $val ) ) {
                // oxbase whill quote it as string if db does not support null for this field
                $aData[$key] = null;
            }
        }
        return $aData;
    }

    protected function _preSaveObject($oShopObject, $aData)
    {
        return true;
    }

    public function saveObject($aData, $blAllowCustomShopId)
    {
        $sObjectName = $this->getShopObjectName();
        if ( $sObjectName ) {
            $oShopObject = oxNew( $sObjectName, 'core');
            if ( $oShopObject instanceof oxI18n ) {
                $oShopObject->setLanguage(0);
                $oShopObject->setEnableMultilang(false);
            }
        } else {
            $oShopObject = oxNew( 'oxbase', 'core');
            $oShopObject->init($this->getBaseTableName());
        }

        $aData = $this->_preAssignObject($oShopObject, $aData, $blAllowCustomShopId);


        $oShopObject->load( $aData['OXID']);

        $oShopObject->assign( $aData );

        if ($blAllowCustomShopId) {
            $oShopObject->setIsDerived(false);
        }

        if ($this->_preSaveObject($oShopObject, $aData)) {
            // store
            if ( $oShopObject->save() ) {
                return $this->_postSaveObject($oShopObject, $aData);
            }
        }

        return false;
    }

    protected function _postSaveObject($oShopObject, $aData)
    {
        // returning ID on success
        return $oShopObject->getId();
    }
}