oxdeliverylist.php

Go to the documentation of this file.

<?php

class oxDeliveryList extends oxList
{
    private static $_instance = null;

    protected $_sUserId = null;

    protected $_blPerfLoadDelivery = null;

    protected $_aDeliveries = array();

    protected $_oUser = null;

    protected $_sHomeCountry = null;

    protected $_blCollectFittingDeliveriesSets = false;


    public function __construct( $sObjectsInListName = 'oxdelivery')
    {
        parent::__construct( 'oxdelivery' );

        // load or not delivery list
        $this->setHomeCountry( $this->getConfig()->getConfigParam( 'aHomeCountry' ) );
    }

    static function getInstance()
    {
        if ( defined('OXID_PHP_UNIT')) {
            if ( ($oClassMod = modInstances::getMod(__CLASS__))  && is_object($oClassMod) ) {
                return $oClassMod;
            } else {
                 $inst = oxNew( 'oxDeliveryList' );
                 modInstances::addMod( __CLASS__, $inst );
                 return $inst;
            }
        }


        if ( !isset( self::$_instance ) ) {
            // allow modules
            self::$_instance = oxNew( 'oxDeliveryList' );
        }
        return self::$_instance;
    }

    public function setHomeCountry( $sHomeCountry )
    {
        if ( is_array( $sHomeCountry ) ) {
            $this->_sHomeCountry = current( $sHomeCountry );
        } else {
            $this->_sHomeCountry = $sHomeCountry;
        }
    }

    protected function _getList( $oUser = null, $sCountryId = null, $sDelSet = null )
    {
        // checking for current session user which gives additional restrictions for user itself, users group and country
        if ( $oUser === null ) {
            $oUser = $this->getUser();
        } else {
            //set user
            $this->setUser( $oUser );
        }

        $sUserId = $oUser ? $oUser->getId() : '';

        // chooseing delivery country if it is not set yet
        if ( !$sCountryId ) {
            if ( $oUser ) {
                $sCountryId = $oUser->getActiveCountry();
            } else {
                $sCountryId = $this->_sHomeCountry;
            }
        }

        if ( ( $sUserId.$sCountryId.$sDelSet ) !== $this->_sUserId ) {

            $this->selectString( $this->_getFilterSelect( $oUser, $sCountryId, $sDelSet ) );
            $this->_sUserId = $sUserId.$sCountryId.$sDelSet;
        }

        $this->rewind();

        return $this;
    }

    protected function _getFilterSelect( $oUser, $sCountryId, $sDelSet )
    {
        $sTable = getViewName( 'oxdelivery' );
        $sQ  = "select $sTable.* from ( select $sTable.* from $sTable left join oxdel2delset on oxdel2delset.oxdelid=$sTable.oxid ";
        $sQ .= "where ".$this->getBaseObject()->getSqlActiveSnippet()." and oxdel2delset.oxdelsetid = '$sDelSet' ";

        // do we need to check in filter starting param ?
        //$sQ .= "and ( $sTable.oxparam != 0 and $sTable.oxparamend != 0 ";

        $sQ .= "and $sTable.oxparamend != 0 ";

        // defining initial filter parameters
        $sUserId    = null;
        $aGroupIds  = null;

        // checking for current session user which gives additional restrictions for user itself, users group and country
        if ( $oUser ) {

            // user ID
            $sUserId = $oUser->getId();

            // user groups ( maybe would be better to fetch by function oxuser::getUserGroups() ? )
            $aGroupIds = $oUser->getUserGroups();
        }

        $sIds = '';
        if ( count( $aGroupIds ) ) {
            foreach ( $aGroupIds as $oGroup ) {
                $aIds[] = "'".$oGroup->getId()."'";
            }
            $sIds = implode(', ', $aIds);
        }

        $sCountrySql = $sCountryId ? "EXISTS(select oxobject2delivery.oxid from oxobject2delivery where oxobject2delivery.oxdeliveryid=$sTable.OXID and oxobject2delivery.oxtype='oxcountry' and oxobject2delivery.OXOBJECTID='$sCountryId')" : '0';
        $sUserSql    = $sUserId    ? "EXISTS(select oxobject2delivery.oxid from oxobject2delivery where oxobject2delivery.oxdeliveryid=$sTable.OXID and oxobject2delivery.oxtype='oxuser' and oxobject2delivery.OXOBJECTID='$sUserId')"   : '0';
        $sGroupSql   = $sIds       ? "EXISTS(select oxobject2delivery.oxid from oxobject2delivery where oxobject2delivery.oxdeliveryid=$sTable.OXID and oxobject2delivery.oxtype='oxgroups' and oxobject2delivery.OXOBJECTID in ($sIds) )"  : '0';

        $sQ .= ") as $sTable where (
            select
                if(EXISTS(select 1 from oxobject2delivery where oxobject2delivery.oxdeliveryid=$sTable.OXID and oxobject2delivery.oxtype='oxcountry' LIMIT 1),
                    $sCountrySql,
                    1) &&
                if(EXISTS(select 1 from oxobject2delivery where oxobject2delivery.oxdeliveryid=$sTable.OXID and oxobject2delivery.oxtype='oxuser' LIMIT 1),
                    $sUserSql,
                    1) &&
                if(EXISTS(select 1 from oxobject2delivery where oxobject2delivery.oxdeliveryid=$sTable.OXID and oxobject2delivery.oxtype='oxgroups' LIMIT 1),
                    $sGroupSql,
                    1)
            )";

        $sQ .= " order by $sTable.oxsort ";

        return $sQ;
    }

    public function getDeliveryList( $oBasket, $oUser = null, $sDelCountry = null, $sDelSet = null )
    {
        // ids of deliveries that doesnt fit for us to skip double check
        $aSkipDeliveries = array();
        $aDelSetList = oxDeliverySetList::getInstance()->getDeliverySetList( $oUser, $sDelCountry, $sDelSet );

        // must choose right delivery set to use its delivery list
        foreach ( $aDelSetList as $sDeliverySetId => $oDeliverySet ) {

            // loading delivery list to check if some of them fits
            $aDeliveries = $this->_getList( $oUser, $sDelCountry, $sDeliverySetId );
            $blDelFound = false;

            foreach ( $aDeliveries as $sDeliveryId => $oDelivery ) {

                // skipping that was checked and didn't fit before
                if ( in_array( $sDeliveryId, $aSkipDeliveries ) ) {
                    continue;
                }

                $aSkipDeliveries[] = $sDeliveryId;

                if ( $oDelivery->isForBasket( $oBasket ) ) {

                    // delivery fits conditions
                    $this->_aDeliveries[$sDeliveryId] = $aDeliveries[$sDeliveryId];
                    $blDelFound = true;

                    // unsetting from unfitting list
                    array_pop( $aSkipDeliveries );

                    // maybe checked "Stop processing after first match" ?
                    if ( $oDelivery->oxdelivery__oxfinalize->value ) {
                        break;
                    }
                }
            }

            // found deliveryset and deliveries that fits
            if ( $blDelFound ) {
                if ( $this->_blCollectFittingDeliveriesSets ) {
                    // collect only deliveries sets that fits deliveries
                    $aFittingDelSets[$sDeliverySetId] = $oDeliverySet;
                } else {
                    // return collected fitting deliveries
                    oxSession::setVar( 'sShipSet', $sDeliverySetId );
                    return $this->_aDeliveries;
                }
            }
        }

        //return deliveries sets if found
        if ( $this->_blCollectFittingDeliveriesSets && count($aFittingDelSets) ) {

            //reseting getting delivery sets list instead of delivieries before return
            $this->_blCollectFittingDeliveriesSets = false;

            //reset cache and list
            $this->setUser(null);
            $this->clear();

            return $aFittingDelSets;
        }

        // nothing what fits was found
        return array();
    }

    public function hasDeliveries( $oBasket, $oUser, $sDelCountry, $sDeliverySetId )
    {
        $blHas = false;

        // loading delivery list to check if some of them fits
        $this->_getList( $oUser, $sDelCountry, $sDeliverySetId );
        foreach ( $this as $oDelivery ) {
            if ( $oDelivery->isForBasket( $oBasket ) ) {
                $blHas = true;
                break;
            }
        }

        return $blHas;
    }
    

    public function getUser()
    {
        if ( !$this->_oUser ) {
            $this->_oUser = parent::getUser();
        }

        return $this->_oUser;
    }

    public function setUser( $oUser )
    {
        $this->_oUser = $oUser;
    }

    public function setCollectFittingDeliveriesSets( $blCollectFittingDeliveriesSets = false )
    {
        $this->_blCollectFittingDeliveriesSets = $blCollectFittingDeliveriesSets;
    }

}

---