oxarticlelist.php

Go to the documentation of this file.

<?php

class oxArticleList extends oxList
{
    protected $_sCustomSorting;

    protected $_sObjectsInListName = 'oxarticle';

    protected $_blLoadSelectLists = false;

    protected $_blLoadPrice = true;

    public function setCustomSorting( $sSorting)
    {
        // sorting for multilanguage fields
        $aSorting = explode(" ", $sSorting);
        $aSorting[0] = $this->getBaseObject()->getSqlFieldName($aSorting[0]);
        $this->_sCustomSorting = implode( " ", $aSorting );
    }

    public function enableSelectLists()
    {
        $this->_blLoadSelectLists = true;
    }

    public function selectString( $sSelect )
    {
        if ( !$this->isAdmin() ) {
            $this->_aAssignCallbackPrepend = ( !$this->_blLoadPrice )?'disablePriceLoad':null;
        }

        startProfile("loadinglists");
        $oRes = parent::selectString( $sSelect );
        stopProfile("loadinglists");

        return $oRes;
    }

    public function loadHistoryArticles($sArtId)
    {
        $mySession = $this->getSession();
        $aHistoryArticles = $mySession->getVar('aHistoryArticles');
        $aHistoryArticles[] = $sArtId;

        // removing dublicates
        $aHistoryArticles = array_unique( $aHistoryArticles);

        if(count($aHistoryArticles) > 5) {
            array_shift($aHistoryArticles);
        }

        //add to session
        $mySession->setVar('aHistoryArticles', $aHistoryArticles);

        //remove current article and return array
        //asignment =, not ==
        if (($iCurrentArt = array_search($sArtId, $aHistoryArticles)) !== false) {
            unset ($aHistoryArticles[$iCurrentArt]);
        }

        $this->loadIds(array_values($aHistoryArticles));
    }

    public function loadNewestArticles( $iLimit = null )
    {
        //has module?
        $myConfig = $this->getConfig();

        if ( !$myConfig->getConfigParam( 'bl_perfLoadPriceForAddList' ) ) {
            $this->_blLoadPrice = false;
        }

        $this->_aArray = array();
        switch( $myConfig->getConfigParam( 'iNewestArticlesMode' ) ) {
            case 0:
                // switched off, do nothing
                break;
            case 1:
                // manually entered
                $this->loadAktionArticles( 'oxnewest' );
                break;
            case 2:
                $sArticleTable = getViewName('oxarticles');
                if ( $myConfig->getConfigParam( 'blNewArtByInsert' ) ) {
                    $sType = 'oxinsert';
                } else {
                    $sType = 'oxtimestamp';
                }
                $sSelect  = "select * from $sArticleTable ";
                $sSelect .= "where oxparentid = '' and ".$this->getBaseObject()->getSqlActiveSnippet()." and oxissearch = 1 order by $sType desc ";
                if (!($iLimit = (int) $iLimit)) {
                    $iLimit = $myConfig->getConfigParam( 'iNrofNewcomerArticles' );
                }
                $sSelect .= "limit " . $iLimit;

                $this->selectString($sSelect);
                break;
        }

    }

    public function loadTop5Articles()
    {
        //has module?
        $myConfig = $this->getConfig();

        if ( !$myConfig->getConfigParam( 'bl_perfLoadPriceForAddList' ) ) {
            $this->_blLoadPrice = false;
        }

        switch( $myConfig->getConfigParam( 'iTop5Mode' ) ) {
            case 0:
                // switched off, do nothing
                break;
            case 1:
                // manually entered
                $this->loadAktionArticles( 'oxtop5');
                break;
            case 2:
                $sArticleTable = getViewName('oxarticles');

                $sSelect  = "select * from $sArticleTable ";
                $sSelect .= "where ".$this->getBaseObject()->getSqlActiveSnippet()." and $sArticleTable.oxissearch = 1 ";
                $sSelect .= "and $sArticleTable.oxparentid = '' and $sArticleTable.oxsoldamount>0 ";
                $sSelect .= "order by $sArticleTable.oxsoldamount desc limit 5";

                $this->selectString($sSelect);
                break;
        }
    }

    public function loadAktionArticles( $sActionID )
    {
        // Performance
        if( !trim( $sActionID) ) {
            return;
        }

        $sShopID        = $this->getConfig()->getShopId();
        $sActionID      = strtolower( $sActionID);

        //echo $sSelect;

        $sArticleTable  = $this->getBaseObject()->getViewName();
        $sArticleFields = $this->getBaseObject()->getSelectFields();

        $oBase = oxNew("oxactions");
        $sActiveSql = $oBase->getSqlActiveSnippet();

        $sSelect = "select $sArticleFields from oxactions2article
                              left join $sArticleTable on $sArticleTable.oxid = oxactions2article.oxartid
                              left join oxactions on oxactions.oxid = oxactions2article.oxactionid
                              where oxactions2article.oxshopid = '$sShopID' and oxactions2article.oxactionid = '$sActionID' and $sActiveSql  
                              and $sArticleTable.oxid is not null and " .$this->getBaseObject()->getSqlActiveSnippet(). "
                              order by oxactions2article.oxsort";

        $this->selectString( $sSelect );
    }

    public function loadArticleCrossSell( $sArticleId )
    {
        $myConfig = $this->getConfig();

        // Performance
        if ( !$myConfig->getConfigParam( 'bl_perfLoadCrossselling' ) ) {
            return null;
        }

        $sArticleTable  = $this->getBaseObject()->getViewName();

        $sSelect  = "select $sArticleTable.* from oxobject2article left join $sArticleTable on oxobject2article.oxobjectid=$sArticleTable.oxid ";
        $sSelect .= "where oxobject2article.oxarticlenid = '$sArticleId' ";
        $sSelect .= " and $sArticleTable.oxid is not null and " .$this->getBaseObject()->getSqlActiveSnippet(). " order by rand()";

        // #525 bidirectional crossselling
        if ( $myConfig->getConfigParam( 'blBidirectCross' ) ) {
            $sSelect  = "select distinct $sArticleTable.* from oxobject2article left join $sArticleTable on (oxobject2article.oxobjectid=$sArticleTable.oxid or oxobject2article.oxarticlenid=$sArticleTable.oxid) ";
            $sSelect .= "where (oxobject2article.oxarticlenid = '$sArticleId' or oxobject2article.oxobjectid = '$sArticleId' )";
            $sSelect .= " and $sArticleTable.oxid is not null and " .$this->getBaseObject()->getSqlActiveSnippet(). " having $sArticleTable.oxid!='$sArticleId' order by rand()";
        }

        $this->setSqlLimit( 0, $myConfig->getConfigParam( 'iNrofCrossellArticles' ));
        $this->selectString( $sSelect );
    }

    public function loadArticleAccessoires( $sArticleId )
    {
        $myConfig = $this->getConfig();

        // Performance
        if ( !$myConfig->getConfigParam( 'bl_perfLoadAccessoires' ) ) {
            return;
        }

        $sArticleTable  = $this->getBaseObject()->getViewName();

        $sSelect  = "select $sArticleTable.* from oxaccessoire2article left join $sArticleTable on oxaccessoire2article.oxobjectid=$sArticleTable.oxid ";
        $sSelect .= "where oxaccessoire2article.oxarticlenid = '$sArticleId' ";
        $sSelect .= " and $sArticleTable.oxid is not null and " .$this->getBaseObject()->getSqlActiveSnippet();
        //sorting articles
        $sSelect .= " order by oxaccessoire2article.oxsort";

        $this->selectString( $sSelect );
    }

    public function loadCategoryIds( $sCatId, $aSessionFilter )
    {
        $sArticleTable = $this->getBaseObject()->getViewName();
        $sSelect = $this->_getCategorySelect( $sArticleTable.'.oxid as oxid', $sCatId, $aSessionFilter );

        $this->_createIdListFromSql( $sSelect );
    }

    public function loadCategoryArticles( $sCatId, $aSessionFilter, $iLimit = null )
    {
        $sArticleFields = $this->getBaseObject()->getSelectFields();

        $sSelect = $this->_getCategorySelect( $sArticleFields, $sCatId, $aSessionFilter );

        // calc count - we can not use count($this) here as we might have paging enabled
        // $sSelect = str_replace( $sArticleFields, 'count(*) as cnt', $sSelect);
        // #1970C - if any filters are used, we can not use cached category article count
        $iArticleCount = null;
        if ( $aSessionFilter) {
            $oDb = oxDb::getDb();
            $sCountSelect = str_replace( "SELECT ".$sArticleFields, 'SELECT count(*) as cnt', $sSelect);
            $iArticleCount = $oDb->getOne( $sCountSelect);
        }

        if ($iLimit = (int) $iLimit) {
            $sSelect .= " LIMIT $iLimit";
        }

        $this->selectString( $sSelect );

        if ( $iArticleCount !== null ) {
            return $iArticleCount;
        }

        $iTotalCount = oxUtilsCount::getInstance()->getCatArticleCount($sCatId);
        // this select is FAST so no need to hazzle here with getNrOfArticles()

        return $iTotalCount;
    }

    public function loadRecommArticles( $sRecommId, $sArticlesFilter = null )
    {
        $sSelect = $this->_getArticleSelect( $sRecommId, $sArticlesFilter);
        $this->selectString( $sSelect );
    }

    public function loadRecommArticleIds( $sRecommId, $sArticlesFilter )
    {
        $sSelect = $this->_getArticleSelect( $sRecommId, $sArticlesFilter );

        $sArtView = getViewName( 'oxarticles' );
        $sPartial = substr( $sSelect, strpos( $sSelect, ' from ' ) );
        $sSelect  = "select distinct $sArtView.oxid $sPartial ";

        $this->_createIdListFromSql( $sSelect );
    }

    protected function _getArticleSelect( $sRecommId, $sArticlesFilter = null )
    {
        $sArtView = getViewName( 'oxarticles' );
        $sSelect  = "select distinct $sArtView.*, oxobject2list.oxdesc from oxobject2list ";
        $sSelect .= "left join $sArtView on oxobject2list.oxobjectid = $sArtView.oxid ";
        $sSelect .= "where (oxobject2list.oxlistid = '".$sRecommId."') ".$sArticlesFilter;

        return $sSelect;
    }

    public function loadSearchIds( $sSearchStr = '', $sSearchCat = '', $sSearchVendor = '' )
    {
        $oDb = oxDb::getDb();
        $sSearchCat    = $sSearchCat?$oDb->quote( $sSearchCat ):null;
        $sSearchVendor = $sSearchVendor?$oDb->quote( $sSearchVendor ):null;

        $sWhere = null;

        if( $sSearchStr ) {
            $sWhere = $this->_getSearchSelect( $sSearchStr );
        }

        $sArticleTable = getViewName('oxarticles');

        // longdesc field now is kept on different table
        $sDescTable = '';
        $sDescJoin  = '';
        if ( is_array( $aSearchCols = oxConfig::getInstance()->getConfigParam( 'aSearchCols' ) ) ) {
            if ( in_array( 'oxlongdesc', $aSearchCols ) || in_array( 'oxtags', $aSearchCols ) ) {
                $sDescView  = getViewName( 'oxartextends' );
                $sDescTable = ", {$sDescView} ";
                $sDescJoin  = " {$sDescView}.oxid={$sArticleTable}.oxid and ";
            }
        }

        // load the articles
        $sSelect  =  "select $sArticleTable.oxid from $sArticleTable $sDescTable where $sDescJoin";

        // must be additional conditions in select if searching in category
        if ( $sSearchCat ) {
            $sO2CView = getViewName('oxobject2category');
            $sSelect  = "select $sArticleTable.oxid from $sArticleTable, $sO2CView as oxobject2category $sDescTable ";
            $sSelect .= "where oxobject2category.oxcatnid=$sSearchCat and oxobject2category.oxobjectid=$sArticleTable.oxid and $sDescJoin ";
        }
        $sSelect .= $this->getBaseObject()->getSqlActiveSnippet();
        $sSelect .= " and $sArticleTable.oxparentid = '' and $sArticleTable.oxissearch = 1 ";

        // #671
        if ( $sSearchVendor ) {
            $sSelect .= " and $sArticleTable.oxvendorid = $sSearchVendor ";
        }
        $sSelect .= $sWhere;

        if ($this->_sCustomSorting) {
            $sSelect .= " order by {$this->_sCustomSorting} ";
        }

        $this->_createIdListFromSql($sSelect);
    }

    public function loadPriceIds( $dPriceFrom, $dPriceTo )
    {

        $sSelect =  $this->_getPriceSelect( $dPriceFrom, $dPriceTo );
        $this->_createIdListFromSql($sSelect);
    }

    public function loadPriceArticles( $dPriceFrom, $dPriceTo, $oCategory = null)
    {
        $sArticleTable = getViewName('oxarticles');

        $sSelect =  $this->_getPriceSelect( $dPriceFrom, $dPriceTo );

        $this->selectString( $sSelect);
        //echo( $sSelect);

        if ( !$oCategory ) {
            return $this->count();
        }

        // #858A
        $iNumOfArticles = $oCategory->getNrOfArticles();
        if ( !isset($iNumOfArticles) || $iNumOfArticles == -1) {
            return oxUtilsCount::getInstance()->getPriceCatArticleCount($oCategory->getId(), $dPriceFrom, $dPriceTo );
        } else {
            return $oCategory->getNrOfArticles();
        }
    }

    public function loadVendorIDs( $sVendorId)
    {
        $sSelect = $this->_getVendorSelect($sVendorId);
        $this->_createIdListFromSql($sSelect);
    }

    public function loadVendorArticles( $sVendorId, $oVendor = null )
    {
        $sSelect = $this->_getVendorSelect($sVendorId);
        $this->selectString( $sSelect);

        return oxUtilsCount::getInstance()->getVendorArticleCount( $sVendorId );
    }

    public function loadTagArticles( $sTag, $iLang )
    {
        $oListObject = $this->getBaseObject();
        $sArticleTable  = $oListObject->getViewName();
        $sArticleFields = $oListObject->getSelectFields();
        $sActiveSnippet = $oListObject->getSqlActiveSnippet();

        $sLangExt = oxLang::getInstance()->getLanguageTag( $iLang );

        $oTagHandler = oxNew( 'oxtagcloud' );
        $sTag = $oTagHandler->prepareTags( $sTag );

        $sQ = "select {$sArticleFields} from oxartextends inner join {$sArticleTable} on
               {$sArticleTable}.oxid = oxartextends.oxid where match ( oxartextends.oxtags{$sLangExt} )
               against( ".oxDb::getDb()->quote( $sTag )." )";

        // checking stock etc
        if ( $sActiveSnippet ) {
            $sQ .= " and {$sActiveSnippet}";
        }

        if ( $this->_sCustomSorting ) {
            $sQ .= " order by {$sArticleTable}.{$this->_sCustomSorting} ";
        }

        $this->selectString( $sQ );

        // calc count - we can not use count($this) here as we might have paging enabled
        return oxUtilsCount::getInstance()->getTagArticleCount( $sTag, $iLang );
    }

    public function getTagArticleIds( $sTag, $iLang )
    {
        $oListObject = $this->getBaseObject();
        $sArticleTable  = $oListObject->getViewName();
        $sActiveSnippet = $oListObject->getSqlActiveSnippet();
        $sLangExt = oxLang::getInstance()->getLanguageTag( $iLang );

        $oTagHandler = oxNew( 'oxtagcloud' );
        $sTag = $oTagHandler->prepareTags( $sTag );

        $sQ = "select oxartextends.oxid from oxartextends inner join {$sArticleTable} on
               {$sArticleTable}.oxid = oxartextends.oxid where match ( oxartextends.oxtags{$sLangExt} )
               against( ".oxDb::getDb()->quote( $sTag )." )";

        // checking stock etc
        if ( $sActiveSnippet ) {
            $sQ .= " and {$sActiveSnippet}";
        }

        if ( $this->_sCustomSorting ) {
            $sQ .= " order by {$sArticleTable}.{$this->_sCustomSorting} ";
        }

        return $this->_createIdListFromSql( $sQ );
    }

    public function loadIds($aIds)
    {
        if (!count($aIds)) {
            $this->clear();
            return;
        }

        foreach ($aIds as $iKey => $sVal)
            $aIds[$iKey] = mysql_real_escape_string($sVal);

        $sArticleTable = $this->getBaseObject()->getViewName();
        $sArticleFields = $this->getBaseObject()->getSelectFields();

        $sSelect  = "select $sArticleFields from $sArticleTable ";
        $sSelect .= "where $sArticleTable.oxid in ( '".implode("','", $aIds)."' ) and ";
        $sSelect .= $this->getBaseObject()->getSqlActiveSnippet();

        $this->selectString($sSelect);
    }

    public function loadOrderArticles($aOrders)
    {
        if (!count($aOrders)) {
            $this->clear();
            return;
        }

        foreach ($aOrders as $iKey => $oOrder) {
            $aOrdersIds[] = $oOrder->getId();
        }

        $sArticleTable = $this->getBaseObject()->getViewName();
        $sArticleFields = $this->getBaseObject()->getSelectFields();

        $sSelect  = "SELECT $sArticleFields FROM oxorderarticles ";
        $sSelect .= "left join $sArticleTable on oxorderarticles.oxartid = $sArticleTable.oxid ";
        $sSelect .= "WHERE oxorderarticles.oxorderid IN ( '".implode("','", $aOrdersIds)."' ) ";
        $sSelect .= "order by $sArticleTable.oxid ";

        $this->selectString( $sSelect );
    }

    protected function _createIdListFromSql( $sSql)
    {
        $rs = oxDb::getDb(true)->execute( $sSql);
        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {
                $rs->fields = array_change_key_case($rs->fields, CASE_LOWER);
                $this[$rs->fields['oxid']] =  $rs->fields['oxid']; //only the oxid
                $rs->moveNext();
            }
        }
    }

    protected function _getFilterSql($sCatId, $aFilter)
    {
        $sO2CView      = getViewName( 'oxobject2category' );
        $sArticleTable = getViewName( 'oxarticles' );
        $sFilter = '';
        $iCnt    = 0;
        $sSuffix = oxLang::getInstance()->getLanguageTag();

        foreach ( $aFilter as $sAttrId => $sValue ) {
            if ( $sValue ) {
                if ( $sFilter ) {
                    $sFilter .= ' or ';
                }
                $sValue = mysql_real_escape_string($sValue);
                $sFilter .= "( oa.oxattrid = '$sAttrId' and oa.oxvalue$sSuffix = '$sValue' )";
                $iCnt++;
            }
        }
        if ( $sFilter ) {
            $sFilter = "and ( $sFilter ) ";
        }
        $sFilterSelect = "select oc.oxobjectid as oxobjectid, count(*) as cnt from $sO2CView as oc ";
        $sFilterSelect.= "INNER JOIN oxobject2attribute as oa ON ( oa.oxobjectid = oc.oxobjectid ) ";
        $sFilterSelect.= "WHERE oc.oxcatnid = '$sCatId' $sFilter ";
        $sFilterSelect.= "GROUP BY oa.oxobjectid HAVING cnt = $iCnt ";

        $aIds = oxDb::getDb( true )->getAll( $sFilterSelect );
        $sIds = '';

        if ( $aIds ) {
            foreach ( $aIds as $aArt ) {
                if ( $sIds ) {
                    $sIds .= ', ';
                }
                $sIds .= " '{$aArt['oxobjectid']}' ";
            }

            if ( $sIds ) {
                $sFilterSql = " and $sArticleTable.oxid in ( $sIds ) ";
            }
        }
        return $sFilterSql;
    }

    protected function _getCategorySelect( $sFields, $sCatId, $aSessionFilter )
    {
        $sArticleTable = getViewName( 'oxarticles' );
        $sO2CView      = getViewName( 'oxobject2category' );

        // ----------------------------------
        // sorting
        $sSorting = '';
        if ( $this->_sCustomSorting ) {
            $sSorting = " {$this->_sCustomSorting} , ";
        }

        // ----------------------------------
        // filtering ?
        $sFilterSql = '';
        if ( $aSessionFilter && isset( $aSessionFilter[$sCatId] ) ) {
            $sFilterSql = $this->_getFilterSql($sCatId, $aSessionFilter[$sCatId]);
        }

        $sSelect = "SELECT $sFields FROM $sO2CView as oc left join $sArticleTable
                    ON $sArticleTable.oxid = oc.oxobjectid
                    WHERE ".$this->getBaseObject()->getSqlActiveSnippet()." and $sArticleTable.oxparentid = ''
                    and oc.oxcatnid = '$sCatId' $sFilterSql ORDER BY $sSorting oc.oxpos, oc.oxobjectid ";

        return $sSelect;
    }

    protected function _getSearchSelect( $sSearchString )
    {
        // check if it has string at all
        if ( !$sSearchString || !str_replace( ' ', '', $sSearchString ) ) {
            return '';
        }

        $myConfig = $this->getConfig();
        $myUtils  = oxUtils::getInstance();
        $sArticleTable = $this->getBaseObject()->getViewName();

        $aSearch = explode( ' ', $sSearchString);

        $sSearch  = ' and ( ';
        $blSep = false;

        // #723
        if ( $myConfig->getConfigParam( 'blSearchUseAND' ) ) {
            $sSearchSep = ' and ';
        } else {
            $sSearchSep = ' or ';
        }

        $aSearchCols = $myConfig->getConfigParam( 'aSearchCols' );
        foreach ( $aSearch as $sSearchString) {

            if ( !strlen( $sSearchString ) ) {
                continue;
            }

            if ( $blSep ) {
                $sSearch .= $sSearchSep;
            }
            $blSep2   = false;
            $sSearch .= '( ';

            $sUml = oxUtilsString::getInstance()->prepareStrForSearch($sSearchString);
            foreach ( $aSearchCols as $sField ) {

                if ( $blSep2) {
                    $sSearch  .= ' or ';
                }

                // as long description now is on different table table must differ
                if ( $sField == 'oxlongdesc' || $sField == 'oxtags') {
                    $sSearchTable = getViewName( 'oxartextends' );
                } else {
                    $sSearchTable = $sArticleTable;
                }

                $sField = $this->getBaseObject()->getSqlFieldName( $sField );

                $sSearch .= $sSearchTable.'.'.$sField.' like '.oxDb::getDb()->Quote('%'.$sSearchString.'%') . ' ';
                if ( $sUml ) {
                    $sSearch  .= ' or '.$sSearchTable.'.'.$sField.' like '.oxDb::getDb()->Quote('%'.$sUml.'%');
                }
                $blSep2 = true;
            }
            $sSearch  .= ' ) ';
            $blSep = true;
        }
        $sSearch .= ' ) ';

        return $sSearch;
    }

    protected function _getPriceSelect( $dPriceFrom, $dPriceTo )
    {
        $sArticleTable = $this->getBaseObject()->getViewName();
        $sSelectFields = $this->getBaseObject()->getSelectFields();

        $sSubSelect  = "select if(oxparentid='',oxid,oxparentid) as id from $sArticleTable where oxprice > 0 ";
        if ( $dPriceTo) {
            $sSubSelect .= $dPriceTo?"and oxprice <= $dPriceTo ":" ";
        }
        $sSubSelect .= "group by id having ";
        if ( $dPriceFrom) {
            $sSubSelect .= $dPriceFrom?"min(oxprice) >= $dPriceFrom ":" ";
        }
        $sSelect =  "select $sSelectFields from $sArticleTable where ";
        $sSelect .= "$sArticleTable.oxid in ($sSubSelect) ";
        $sSelect .= "and ".$this->getBaseObject()->getSqlActiveSnippet()." and $sArticleTable.oxissearch = 1";

        if ( !$this->_sCustomSorting ) {
            $sSelect .= " order by $sArticleTable.oxprice asc , $sArticleTable.oxid";
        } else {
            $sSelect .= " order by {$this->_sCustomSorting}, $sArticleTable.oxid ";
        }

        return $sSelect;

    }

    protected function _getVendorSelect( $sVendorId )
    {
        $sArticleTable = getViewName('oxarticles');
        $sFieldNames = $this->getBaseObject()->getSelectFields();
        $sSelect  = "select $sFieldNames from $sArticleTable ";
        $sSelect .= "where $sArticleTable.oxvendorid = '$sVendorId' ";
        $sSelect .= " and " . $this->getBaseObject()->getSqlActiveSnippet() . " and $sArticleTable.oxparentid = ''  ";

        if ( $this->_sCustomSorting ) {
            $sSelect .= " ORDER BY {$this->_sCustomSorting} ";
        }

        return $sSelect;
    }

}

---