oxshopmetadata.php

Go to the documentation of this file.

<?php

class oxShopMetaData extends oxSuperCfg
{
    private static $_instance = null;

    const SHOP_FIELD_SET_SIZE = 64;

    public static function getInstance()
    {
        // disable caching for test modules
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            self::$_instance = modInstances::getMod( __CLASS__ );
        }

        if ( !(self::$_instance instanceof oxShopMetaData) ) {
            self::$_instance = oxNew( 'oxShopMetaData' );
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }
        return self::$_instance;
    }

    public function getShopBit( $iShopId )
    {
        // get shop field set id for shop field set
        $iShopId = $this->_getShopFieldSetId((int) $iShopId);

        //this works for large numbers when $sShopNr is up to (inclusive) 128
        $iRes = oxDb::getDb()->getOne( "select 1 << ( $iShopId - 1 ) as shopbit" );

        //as php ints supports only 32 bits, we return string.
        return $iRes;
    }

    public function getShopBits( $iShopId )
    {
        $aShopBits = array();
        $iFieldCount = $this->_getShopFieldCount();
        if ($iFieldCount) {
            // Fill array with 0 values
            $aShopBits = array_fill(0, $iFieldCount, 0);
            // Calculate shop bit for current field set
            $aShopBits[$this->getShopFieldSet($iShopId)] = $this->getShopBit($iShopId);
        }
        return $aShopBits;
    }

    public function getMultiShopBits()
    {
        $aShopBits = array();
        $iFieldCount = $this->_getShopFieldCount();
        if ($iFieldCount) {
            // Fill array with max 64bit int values
            $aShopBits = array_fill(0, $iFieldCount, MAX_64BIT_INTEGER);
        }
        return $aShopBits;
    }

    public function getParentShopBits( $sShopId, $blIsInherited = null )
    {
        $iCnt  = 0;
        $iMax  = $this->_getMaxShopId();
        $aShopSetBits = array();
        do {
            //collects inherited shop set bit array up to uninherited parent.
            $aInheritedShops = array();
            $sQ = 'select oxid, oxparentid, oxisinherited from oxshops where oxid = "'.$sShopId.'" ';
            $rs = oxDb::getDb()->select( $sQ );
            if ( $rs && $rs->recordCount()> 0 && $rs->fields[0] ) {
                $iOXID     = $rs->fields[0];
                $sParentID = $rs->fields[1];

                //the default value is taking from the shop settings
                if ( is_null($blIsInherited) ) {
                    $blIsInherited = $rs->fields[2];
                }
                $aShopSetBits[$this->getShopFieldSet($iOXID)][] = $this->getShopBit($iOXID);
            }
            $sShopId = $sParentID;

        } while ( ( $blIsInherited && $sParentID ) && $iCnt++ < $iMax );

        $aFieldSets = $this->_combineShopSetBits($aShopSetBits);
        return $aFieldSets;
    }

    public function isIncludedInShop($iShopId, $sTable, $sOXID)
    {
        $oDb      = oxDb::getDb();
        $sField   = $this->getShopFieldName('oxshopincl', $iShopId);
        $iShopBit = $this->getShopBit($iShopId);
        $sSelect  = "select ({$iShopBit} & {$sField}) as isIncluded from {$sTable} where oxid = ".$oDb->quote( $sOXID );

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

    public function isExcludedFromShop($iShopId, $sTable, $sOXID)
    {
        $oDb      = oxDb::getDb();
        $sField   = $this->getShopFieldName('oxshopexcl', $iShopId);
        $iShopBit = $this->getShopBit($iShopId);
        $sSelect  = "select ({$iShopBit} & {$sField}) as isExcluded from {$sTable} where oxid = ".$oDb->quote( $sOXID );

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

    public function getShopFieldSet($iShopId)
    {
        return ceil($iShopId / self::SHOP_FIELD_SET_SIZE)-1;
    }

    public function getShopFields()
    {
        $iCount = $this->_getShopFieldCount();
        $aFields = array();
        for ($iSet=0; $iSet<$iCount; $iSet++) {
            $aFields[] = $this->getShopFieldSetName('oxshopincl', $iSet);
            $aFields[] = $this->getShopFieldSetName('oxshopexcl', $iSet);
        }
        return $aFields;
    }



    public function shopFieldSetExist( $iShopId, $sTable = 'oxarticles')
    {
        $blExists = true;
        $sFieldSet = $this->getShopFieldSet($iShopId);
        if ( $sFieldSet > 0 ) {
            $sFieldName = "oxshopincl".$sFieldSet;
            $oDbMetadata = oxNew('oxDbMetaDataHandler');
            $blExists = $oDbMetadata->tableExists( $sTable ) && $oDbMetadata->fieldExists( $sFieldName, $sTable );
        }
        return $blExists;
    }

    public function addShopFieldSets( $iShopId )
    {
        set_time_limit(0);
        $aSql = array();
        $aMultiShopTables = $this->getConfig()->getConfigParam( 'aMultiShopTables' );
        $iFieldSet = $this->getShopFieldSet($iShopId);
        $oDbMetadata = oxNew('oxDbMetaDataHandler');

        foreach ( $aMultiShopTables as $sTable ) {
            foreach ( array( "OXSHOPINCL", "OXSHOPEXCL" ) as $sField ) {
                $sNewFieldName = $sField . $iFieldSet;
                if ($iFieldSet > 1) {
                    $iPrevLang = $iFieldSet-1;
                    $sPrevField = $sField.$iPrevLang;
                } else {
                    $sPrevField = $sField;
                }
                if ( !$oDbMetadata->fieldExists( $sNewFieldName, $sTable ) ) {

                    //getting add field sql
                    $aSql[] = $oDbMetadata->getAddFieldSql( $sTable, $sField, $sNewFieldName, $sPrevField );


                    //getting add index sql on added field
                    $aSql = array_merge($aSql, (array) $oDbMetadata->getAddFieldIndexSql($sTable, $sField, $sNewFieldName));
                }
            }
        }
        $oDbMetadata->executeSql($aSql);
    }

    public function getShopFieldSetSuffix( $iSet )
    {
        $sSuffix = ( $iSet > 0 ) ? $iSet : '';
        return $sSuffix;
    }

    public function getShopFieldSuffix( $iShopId )
    {
        $iSet = $this->getShopFieldSet( $iShopId );
        return $this->getShopFieldSetSuffix($iSet);
    }

    public function getShopFieldSetName( $sField, $iSet )
    {
        $sSuffix = $this->getShopFieldSetSuffix($iSet);
        return $sField.$sSuffix;
    }

    public function getShopFieldName( $sField, $iShopId )
    {
        $iSet = $this->getShopFieldSet( $iShopId );
        return $this->getShopFieldSetName($sField, $iSet);
    }

    public function getSqlSetIncludeSnippet( $iShopId )
    {
        $iBit     = $this->getShopBit( $iShopId );
        $sField   = $this->getShopFieldName( 'oxshopincl', $iShopId);
        $sSnippet = "{$sField} = {$sField} | $iBit";

        return $sSnippet;
    }

    public function getSqlUnsetIncludeSnippet( $iShopId )
    {
        $iBit     = $this->getShopBit( $iShopId );
        $sField   = $this->getShopFieldName( 'oxshopincl', $iShopId );
        $sSnippet = "{$sField} = {$sField} & ~{$iBit}";

        return $sSnippet;
    }

    public function getSqlSetExcludeSnippet( $iShopId )
    {
        $iBit     = $this->getShopBit( $iShopId );
        $sField   = $this->getShopFieldName( 'oxshopexcl', $iShopId );
        $sSnippet = "{$sField} = {$sField} | $iBit";

        return $sSnippet;
    }

    public function getSqlUnsetExcludeSnippet( $iShopId )
    {
        $iBit     = $this->getShopBit( $iShopId );
        $iField   = $this->getShopFieldName( 'oxshopexcl', $iShopId);
        $sSnippet = "{$iField} = {$iField} & ~{$iBit}";

        return $sSnippet;
    }

    protected function _getShopFieldSetId($iShopId)
    {
        return 1 + (($iShopId - 1) % self::SHOP_FIELD_SET_SIZE);
    }

    protected function _getShopFieldCount()
    {
        return 1 + $this->getShopFieldSet($this->_getMaxShopId());
    }

    protected function _getMaxShopId()
    {
        return oxDb::getDb()->getOne( "select max(oxid) as maxid from oxshops" );
    }

    protected function _combineShopSetBits( $aShopSetBits )
    {
        $aFieldSets = array_fill(0, $this->_getShopFieldCount(), 0);
        foreach ( $aShopSetBits as $iShopSet => $aBits ) {
            //this works for large numbers when $sShopNr is up to (inclusive) 64
            $iRes = oxDb::getDb()->getOne( "select (".implode(" | ", $aBits).") as bitwiseOr" );
            $aFieldSets[$iShopSet] = $iRes;
        }

        //for more than 64 shop, we return array.
        return $aFieldSets;
    }
}