alist.php

Go to the documentation of this file.

<?php

class aList extends oxUBase
{
    protected $_iAllArtCnt = 0;

    protected $_iCntPages = null;

    protected $_sThisTemplate = 'list.tpl';

    protected $_sThisMoreTemplate = 'list_more.tpl';

    protected $_sCatPathString = null;

    protected $_blShowSorting = true;

    protected $_aAttributes = null;

    protected $_aCatArtList = null;

    protected $_sCatTreeHtmlPath = null;

    protected $_blHasVisibleSubCats = null;

    protected $_aSubCatList = null;

    protected $_oPageNavigation = null;

    protected $_oCategory = null;

    protected $_blIsCat = null;

    protected $_oRecommList = null;

    protected $_sCatTitle = null;

    protected $_blFixedUrl = null;

    public function getViewId()
    {
        if ( isset( $this->_sViewId ) ) {
            return $this->_sViewId;
        }

        $iActPage = $this->getActPage();

        // shorten it
            $_sViewId = md5( parent::getViewId().'|'.oxConfig::getParameter( 'cnid' ).'|'.$iActPage.'|'.oxConfig::getParameter( '_artperpage' ) );


        return $this->_sViewId = $_sViewId;
    }

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

        $this->_oCategory  = null;
        $blContinue = true;
        $this->_blIsCat = false;

        // A. checking for fake "more" category
        if ( 'oxmore' == oxConfig::getParameter( 'cnid' ) && $myConfig->getConfigParam( 'blTopNaviLayout' ) ) {

            // overriding some standard value and parameters
            $this->_sThisTemplate = $this->_sThisMoreTemplate;
            $this->_oCategory = oxNew( 'oxcategory' );
            $this->_oCategory->oxcategories__oxactive = new oxField(1, oxField::T_RAW);
        } else {
            if( ( $this->_oActCategory = $this->getActCategory() ) ) {
                $this->_oCategory  = $this->_oActCategory;
                $blContinue = $this->_oCategory->oxcategories__oxactive->value;
                $this->_blIsCat = true;
            }
        }


        // category is inactive ?
        if ( !$blContinue || !$this->_oCategory ) {
            oxUtils::getInstance()->redirect( $myConfig->getShopURL().'index.php' );
        }

        $this->_aViewData['filterattributes'] = $this->getAttributes();

        $this->_aViewData['articlelist']       = $this->getArticleList();
        $this->_aViewData['similarrecommlist'] = $this->getSimilarRecommLists();

        // loading actions
        $this->_aViewData['articlebargainlist'] = $this->getBargainArticleList();
        $this->_aViewData['aTop5Articles']      = $this->getTop5ArticleList();

        $this->_aViewData['pageNavigation'] = $this->getPageNavigation();

        $this->_aViewData['actCatpath']        = $this->getCatTreePath();
        $this->_aViewData['template_location'] = $this->getTemplateLocation();

        // generating meta info
        $this->setMetaDescription( null );
        $this->setMetaKeywords( null );

        // add to the parent view
        $this->_aViewData['actCategory'] = $this->getActiveCategory();

        $oCat = $this->getActCategory();
        if ($oCat && is_array($myConfig->getConfigParam( 'aRssSelected' )) && in_array('oxrss_categories', $myConfig->getConfigParam( 'aRssSelected' ))) {
            $oRss = oxNew('oxrssfeed');
            $this->addRssFeed($oRss->getCategoryArticlesTitle($oCat), $oRss->getCategoryArticlesUrl($oCat), 'activeCategory');
        }

        //Gets subcategory tree from category tree
        $this->_aViewData['hasVisibleSubCats'] = $this->hasVisibleSubCats();
        $this->_aViewData['subcatlist']        = $this->getSubCatList();

        $this->_aViewData['title'] = $this->getTitle();

        parent::render();

        return $this->getTemplateName();
    }

    public function executefilter()
    {
        // store this into session
        $aFilter = oxConfig::getParameter( 'attrfilter', 1 );
        $sActCat = oxConfig::getParameter( 'cnid' );
        $aSessionFilter = oxSession::getVar( 'session_attrfilter' );
        $aSessionFilter[$sActCat] = $aFilter;
        oxSession::setVar( 'session_attrfilter', $aSessionFilter );
    }

    protected function _loadArticles( $oCategory )
    {
        $myConfig = $this->getConfig();

        $iNrofCatArticles = (int) $myConfig->getConfigParam( 'iNrofCatArticles' );
        $iNrofCatArticles = $iNrofCatArticles?$iNrofCatArticles:1;

        // load only articles which we show on screen
        $oArtList = oxNew( 'oxarticlelist' );
        $oArtList->setSqlLimit( $iNrofCatArticles * $this->getActPage(), $iNrofCatArticles );

        if ( $this->_oActCategory ) {
            $oArtList->setCustomSorting( $this->getSortingSql( $this->_oActCategory->getId() ) );
        }

        if ( $oCategory->oxcategories__oxpricefrom->value || $oCategory->oxcategories__oxpriceto->value ) {
            $dPriceFrom = $oCategory->oxcategories__oxpricefrom->value;
            $dPriceTo   = $oCategory->oxcategories__oxpriceto->value;

            $this->_iAllArtCnt = $oArtList->loadPriceArticles( $dPriceFrom, $dPriceTo, $oCategory );
        } else {

            $aSessionFilter = null;
            $aSessionFilter = oxSession::getVar( 'session_attrfilter' );

            $sActCat = oxConfig::getParameter( 'cnid' );
            $this->_iAllArtCnt = $oArtList->loadCategoryArticles( $sActCat, $aSessionFilter );
        }

        $this->_iCntPages = round( $this->_iAllArtCnt/$iNrofCatArticles + 0.49 );

        return $oArtList;
    }

    protected function _getSeoObjectId()
    {
        if ( ( $oCategory = $this->getActCategory() ) ) {
            return $oCategory->getId();
        }
    }

    protected function _getCatPathString()
    {
        if ( $this->_sCatPathString === null ) {

            // marking as allready set
            $this->_sCatPathString = false;

            //fetching category path
            if ( is_array( $aPath = $this->getCatTreePath() ) ) {

                $this->_sCatPathString = '';
                foreach ( $aPath as $oCat ) {
                    if ( $this->_sCatPathString ) {
                        $this->_sCatPathString .= ', ';
                    }
                    $this->_sCatPathString .= strtolower( $oCat->oxcategories__oxtitle->value );
                }
            }
        }
        return $this->_sCatPathString;
    }

    protected function _prepareMetaDescription( $aCatPath, $iLength = 1024, $blDescTag = false )
    {
        // using language constant ..
        $sDescription = oxLang::getInstance()->translateString( 'INC_HEADER_YOUAREHERE' );

        // appending parent title
        if ( ( $oParent = $this->_oCategory->getParentCategory() ) ) {
            $sDescription .= " {$oParent->oxcategories__oxtitle->value} -";
        }

        // adding cateogry title
        $sDescription .= " {$this->_oCategory->oxcategories__oxtitle->value}.";

        // and final component ..
        if ( ( $sSuffix = $this->getConfig()->getActiveShop()->oxshops__oxstarttitle->value ) ) {
            $sDescription .= " {$sSuffix}";
        }

        // making safe for output
        $aRemoveChars = array( "\"", "'", "\n", "\r", "\t", "\x95", "\xA0" );
        $sDescription = str_replace( $aRemoveChars, ' ', $sDescription );

        return strip_tags( html_entity_decode( $sDescription ) );
    }

    protected function _collectMetaDescription( $aCatPath, $iLength = 1024, $blDescTag = false )
    {
        //formatting description tag
        $sAddText = $this->_oActCategory?trim( $this->_oActCategory->oxcategories__oxlongdesc->value ):'';
        if ( !$sAddText && count($this->_aArticleList)) {
            foreach ( $this->_aArticleList as $oArticle ) {
                if ( $sAddText ) {
                    $sAddText .= ', ';
                }
                $sAddText .= $oArticle->oxarticles__oxtitle->value;
            }
        }

        return parent::_prepareMetaDescription( $this->_getCatPathString().' - '.$sAddText, $iLength, $blDescTag );
    }

    protected function _prepareMetaKeyword( $aCatPath )
    {
        $sKeywords = '';
        if ( ( $oParent = $this->_oCategory->getParentCategory() ) ) {
            $sKeywords = $oParent->oxcategories__oxtitle->value;
        }

        $sKeywords = ( $sKeywords ? $sKeywords . ', ' : '' ) . $this->_oCategory->oxcategories__oxtitle->value;
        $aSubCats  = $this->_oCategory->getSubCats();
        if ( is_array( $aSubCats ) ) {
            foreach ( $aSubCats as $oSubCat ) {
                $sKeywords .= ', '.$oSubCat->oxcategories__oxtitle->value;
            }
        }

        $sKeywords = parent::_prepareMetaDescription( $sKeywords, -1, true );
        $sKeywords = $this->_removeDuplicatedWords( $sKeywords );

        // removing in admin defined strings
        $aSkipTags = $this->getConfig()->getConfigParam( 'aSkipTags' );
        if ( is_array( $aSkipTags ) && $sKeywords ) {
            foreach ( $aSkipTags as $sSkip ) {
                $aPattern = array( '/\W'.$sSkip.'\W/i', '/^'.$sSkip.'\W/i', '/\"'.$sSkip.'$/i' );
                $sKeywords  = preg_replace( $aPattern, '', $sKeywords );
            }
        }

        return $sKeywords;
    }

    protected function _collectMetaKeyword( $aCatPath )
    {
        $iMaxTextLenght = 60;
        $sText = '';

        if (count($this->_aArticleList)) {
            foreach ( $this->_aArticleList as $oProduct ) {
                $sDesc = strip_tags( trim( strtolower( $oProduct->oxarticles__oxlongdesc->value ) ) );
                if ( strlen( $sDesc ) > $iMaxTextLenght ) {
                    $sMidText = substr( $sDesc, 0, $iMaxTextLenght );
                    $sText   .= substr( $sMidText, 0, ( strlen( $sMidText ) - strpos( strrev( $sMidText ), ' ' ) ) );
                }
            }
        }
        return parent::_prepareMetaKeyword( $this->_getCatPathString() . ', ' . $sText );
    }

    public function getTemplateName()
    {
        // assign template name
        if ( ( $sTplName = basename( oxConfig::getParameter( 'tpl' ) ) ) ) {
            $this->_sThisTemplate = $sTplName;
        } elseif ( $this->_oActCategory && $this->_oActCategory->oxcategories__oxtemplate->value ) {
            $this->_sThisTemplate = $this->_oActCategory->oxcategories__oxtemplate->value;
        }

        return $this->_sThisTemplate;
    }

    protected function _addPageNrParam( $sUrl, $iPage, $iLang = null)
    {
        if ( oxUtils::getInstance()->seoIsActive() && ( $oCategory = $this->getActCategory() ) ) {
            if ( $iPage ) { // only if page number > 0
                $sUrl = oxSeoEncoderCategory::getInstance()->getCategoryPageUrl( $oCategory, $iPage, $iLang, $this->_isFixedUrl( $oCategory ) );
            }
        } else {
            $sUrl = parent::_addPageNrParam( $sUrl, $iPage, $iLang );
        }
        return $sUrl;
    }

    protected function _isFixedUrl( $oCategory )
    {
        if ( $this->_blFixedUrl == null ) {
            $sId = $oCategory->getId();
            $iLang = $oCategory->getLanguage();
            $sShopId = oxConfig::getInstance()->getShopId();
            $this->_blFixedUrl = oxDb::getDb()->getOne( "select oxfixed from oxseo where oxobjectid = '{$sId}' and oxshopid = '{$sShopId}' and oxlang = '{$iLang}' and oxparams = '' " );
        }
        return $this->_blFixedUrl;
    }

    public function _isActCategory()
    {
        return $this->_blIsCat;
    }

    protected function _getCategory()
    {
        return $this->_oCategory;
    }

    public function generatePageNavigationUrl( )
    {
        if ( ( oxUtils::getInstance()->seoIsActive() && ( $oCategory = $this->getActCategory() ) ) ) {
            return $oCategory->getLink();
        } else {
            return parent::generatePageNavigationUrl( );
        }
    }

    public function getSorting( $sCnid )
    {
        // category has own sorting
        $aSorting = parent::getSorting( $sCnid );
        if ( !$aSorting && $this->_oActCategory && $this->_oActCategory->oxcategories__oxdefsort->value ) {
            $sSortBy  = getViewName( 'oxarticles' ).'.'.$this->_oActCategory->oxcategories__oxdefsort->value;
            if ( $sSortBy) {
                $sSortDir = $this->_oActCategory->oxcategories__oxdefsortmode->value ? " desc " : null;
            }
            $sSortDir = $sSortDir?$sSortDir:null;

            $this->setItemSorting( $sCnid, $sSortBy, $sSortDir );
            $aSorting = array ( 'sortby' => $sSortBy, 'sortdir' => $sSortDir );
        }
        return $aSorting;
    }

    public function getTitleSuffix()
    {
        if ( $this->getActCategory()->oxcategories__oxshowsuffix->value ) {
           return $this->getConfig()->getActiveShop()->oxshops__oxtitlesuffix->value;
        }
    }

    protected function getSubject()
    {
        return $this->getActCategory();
    }

    public function getAttributes()
    {
        // #657 gather all attribute values we do have here in this category
        $this->_aAttributes = false;
        if ( $this->_getCategory() ) {
            $aAttributes = $this->_getCategory()->getAttributes();
            if ( count( $aAttributes ) ) {
                $this->_aAttributes = $aAttributes;
            }
        }
        return $this->_aAttributes;
    }

    public function getArticleList()
    {
        if ( $this->_aArticleList === null ) {
            if ( ( $oCategory = $this->_getCategory() ) && $this->_isActCategory() ) {
                $aArticleList = $this->_loadArticles( $oCategory );
                if ( count( $aArticleList ) ) {
                    $this->_aArticleList = $aArticleList;
                }
            }
        }
        return $this->_aArticleList;
    }

    public function getSimilarRecommLists()
    {
        if ( $this->_oRecommList === null ) {
            $this->_oRecommList = false;
            if ( $aCatArtList = $this->getArticleList() ) {
                $oRecommList = oxNew('oxrecommlist');
                $this->_oRecommList = $oRecommList->getRecommListsByIds( $aCatArtList->arrayKeys());
            }
        }
        return $this->_oRecommList;
    }

    public function getCatTreePath()
    {
        if ( $this->_sCatTreePath === null ) {
             $this->_sCatTreePath = false;
            // category path
            if ( $oCatTree = $this->getCategoryTree() ) {
                $this->_sCatTreePath = $oCatTree->getPath();
            }
        }
        return $this->_sCatTreePath;
    }

    public function getTemplateLocation()
    {
        if ( $this->_sCatTreeHtmlPath === null ) {
             $this->_sCatTreeHtmlPath = false;
            // category path
            if ( $oCatTree = $this->getCategoryTree() ) {
                $this->_sCatTreeHtmlPath = $oCatTree->getHtmlPath();
            }
        }
        return $this->_sCatTreeHtmlPath;
    }

    public function hasVisibleSubCats()
    {
        if ( $this->_blHasVisibleSubCats === null ) {
            $this->_blHasVisibleSubCats = false;
            if ( $oClickCat = $this->getActCategory() ) {
                $this->_blHasVisibleSubCats = $oClickCat->getHasVisibleSubCats();
            }
        }
        return $this->_blHasVisibleSubCats;
    }

    public function getSubCatList()
    {
        if ( $this->_aSubCatList === null ) {
            $this->_aSubCatList = array();
            if ( $oClickCat = $this->getActCategory() ) {
                $this->_aSubCatList = $oClickCat->getSubCats();
            }
        }
        return $this->_aSubCatList;
    }

    public function getPageNavigation()
    {
        if ( $this->_oPageNavigation === null ) {
            $this->_oPageNavigation = false;
            $this->_oPageNavigation = $this->generatePageNavigation();
        }
        return $this->_oPageNavigation;
    }

    public function getTitle()
    {
        if ( $this->_sCatTitle === null ) {
            $this->_sCatTitle = false;
            if ( $oCategory = $this->_getCategory() ) {
                $this->_sCatTitle = $oCategory->oxcategories__oxtitle->value;
            }
        }
        return $this->_sCatTitle;
    }

    public function getTop5ArticleList()
    {
        if ( $this->_aTop5ArticleList === null ) {
            $this->_aTop5ArticleList = false;
            $myConfig = $this->getConfig();
            if ( $myConfig->getConfigParam( 'bl_perfLoadAktion' ) && $this->_isActCategory() ) {
                // top 5 articles
                $oArtList = oxNew( 'oxarticlelist' );
                $oArtList->loadTop5Articles();
                if ( $oArtList->count() ) {
                    $this->_aTop5ArticleList = $oArtList;
                }
            }
        }
        return $this->_aTop5ArticleList;
    }

    public function getBargainArticleList()
    {
        if ( $this->_aBargainArticleList === null ) {
            $this->_aBargainArticleList = array();
            if ( $this->getConfig()->getConfigParam( 'bl_perfLoadAktion' ) && $this->_isActCategory() ) {
                $oArtList = oxNew( 'oxarticlelist' );
                $oArtList->loadAktionArticles( 'OXBARGAIN' );
                if ( $oArtList->count() ) {
                    $this->_aBargainArticleList = $oArtList;
                }
            }
        }
        return $this->_aBargainArticleList;
    }

    public function getActiveCategory()
    {
        return $this->getActCategory();
    }

}

---