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));
    }

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

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

    public function getTableName($iShopID = null, $iLanguage = 0)
    {
        if ($iShopID === null) {
            $iShopID = oxRegistry::getConfig()->getShopId();
        }

        return getViewName($this->_sTableName, -1, $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];
            }
        }

        switch ($sField) {
            case 'OXSHOPID':
            case 'OXSHOPINCL':
                return "1 as $sField";
            case 'OXSHOPEXCL':
                return "0 as $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;
        }


        $sSQL .= ' from ' . $this->getTableName($iShopId, $iLanguage) . ' ' . $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($oObj, $aData = null)
    {
        return;

        if ($oObj->isDerived()) {
            throw new Exception(oxERPBase::$ERROR_USER_NO_RIGHTS);
        }
    }

    public function checkCreateAccess($aData)
    {
    }

    public function getObjectForDeletion($sId)
    {
        $myConfig = oxRegistry::getConfig();

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

        $sName = $this->getShopObjectName();
        if ($sName) {
            $oObj = oxNew($sName, "core");
        } else {
            $oObj = oxNew('oxbase', 'core');
            $oObj->init($this->getBaseTableName());
        }

        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)
    {
        $oUsr = oxNew('oxUser');
        $oUsr->loadAdminUser();

        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
        $oUsr = oxNew('oxUser');
        $oUsr->loadAdminUser();
        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)
    {
        $myConfig = oxRegistry::getConfig();
        $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();
        if (!$this->_aFieldList) {
            $this->getFieldList();
        }

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

        return $aRParams;
    }

    public function getFieldList()
    {
        $sObjectName = $this->getShopObjectName();

        if ($sObjectName) {
            $oShopObject = oxNew($sObjectName);
        } else {
            $oShopObject = oxNew('oxbase');
            $oShopObject->init($this->getTableName());
        }

        if ($oShopObject instanceof oxI18n) {
            $oShopObject->setLanguage(0);
            $oShopObject->setEnableMultilang(false);
        }

        $sViewName = $oShopObject->getViewName();
        $sFields = str_ireplace('`' . $sViewName . "`.", "", strtoupper($oShopObject->getSelectFields()));
        $sFields = str_ireplace(array(" ", "`"), array("", ""), $sFields);
        $this->_aFieldList = explode(",", $sFields);

        return $this->_aFieldList;
    }

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

    public function getOxidFromKeyFields($aData)
    {
        $myConfig = oxRegistry::getConfig();

        if (!is_array($this->getKeyFields())) {
            return null;
        }

        $oDb = oxDb::getDb();

        $aWhere = array();
        $blAllKeys = true;
        foreach ($this->getKeyFields() as $sKey) {
            if (array_key_exists($sKey, $aData)) {
                $aWhere[] = $sKey . '=' . $oDb->qstr($aData[$sKey]);
            } else {
                $blAllKeys = false;
            }
        }

        if ($blAllKeys) {
            $sSelect = 'SELECT OXID FROM ' . $this->getTableName() . ' WHERE ' . implode(' AND ', $aWhere);

            return $oDb->getOne($sSelect);
        }

        return null;
    }

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

        return false;
    }

    protected function _preAssignObject($oShopObject, $aData, $blAllowCustomShopId)
    {
        /*
        if (isset($aData['OXSHOPID'])) {
            $aData['OXSHOPID'] = 'oxbaseshop';
        }

        */

        if (isset($aData['OXSHOPID'])) {
            $aData['OXSHOPID'] = oxRegistry::getConfig()->getShopId();
        }

        if (!isset($aData['OXID'])) {
            $aData['OXID'] = $this->getOxidFromKeyFields($aData);
        }

        // 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());
        }

        foreach ($aData as $key => $value) {
            // change case to UPPER
            $sUPKey = strtoupper($key);
            if (!isset($aData[$sUPKey])) {
                unset($aData[$key]);
                $aData[$sUPKey] = $value;
            }
        }


        $blLoaded = false;
        if ($aData['OXID']) {
            $blLoaded = $oShopObject->load($aData['OXID']);
        }

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

        if ($blLoaded) {
            $this->checkWriteAccess($oShopObject, $aData);
        } else {
            $this->checkCreateAccess($aData);
        }

        $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();
    }
}