tag.php

Go to the documentation of this file.

<?php

class Tag extends aList
{
    protected $_sListType = 'tag';

    protected $_blShowSorting = true;

    protected $_sTag;

    protected $_sTagTitle;

    protected $_oPageNavigation = null;

    protected $_sTemplateLocation;

    protected $_iViewIndexState = VIEW_INDEXSTATE_INDEX;

    public function render()
    {
        oxUBase::render();

        $myConfig = $this->getConfig();
        
        $oArticleList = $this->getArticleList();

        //if no articles - showing 404 header (#2139)
        if ( !$oArticleList || count( $oArticleList ) < 1 ) {
            error_404_handler();
        }

        $this->_aViewData['articlelist']       = $oArticleList;
        $this->_aViewData['title']             = $this->getTitle();
        $this->_aViewData['template_location'] = $this->getTemplateLocation();
        $this->_aViewData['searchtag']         = $this->getTag();

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

        // processing list articles
        $this->_processListArticles();
        
        return $this->_sThisTemplate;
    }

    protected function _getProductLinkType()
    {
        return OXARTICLE_LINKTYPE_TAG;
    }

    public function getAddUrlParams()
    {
        $sAddParams  = parent::getAddUrlParams();
        $sAddParams .= ($sAddParams?'&amp;':'') . "listtype={$this->_sListType}";
        if ( $sParam = oxConfig::getParameter( 'searchtag', 1 ) ) {
            $sAddParams .= "&amp;searchtag=" . rawurlencode( $sParam );
        }
        return $sAddParams;
    }

    protected function _loadArticles( $oCategory )
    {
        // load only articles which we show on screen
        $iNrofCatArticles = (int) $this->getConfig()->getConfigParam( 'iNrofCatArticles' );
        $iNrofCatArticles = $iNrofCatArticles?$iNrofCatArticles:1;
        $oArtList = oxNew( 'oxarticlelist' );
        $oArtList->setSqlLimit( $iNrofCatArticles * $this->getActPage(), $iNrofCatArticles );
        $oArtList->setCustomSorting( $this->getSortingSql( 'oxtags' ) );

        // load the articles
        $this->_iAllArtCnt = $oArtList->loadTagArticles( $this->getTag(), oxLang::getInstance()->getBaseLanguage());
        $this->_iCntPages  = round( $this->_iAllArtCnt / $iNrofCatArticles + 0.49 );

        return $oArtList;
    }

    protected function _getCatPathString()
    {
        return $this->getTag();
    }

    protected function _getSeoObjectId()
    {
        return md5("tag" . $this->getTag() );
    }

    public function getSorting( $sCnid )
    {
        return parent::getSorting( "oxtags" );
    }

    public function setItemSorting( $sCnid, $sSortBy, $sSortOrder  = null )
    {
        parent::setItemSorting( "oxtags", $sSortBy, $sSortOrder );
    }

    public function generatePageNavigationUrl()
    {
        if ( ( oxUtils::getInstance()->seoIsActive() && ( $sTag = $this->getTag() ) ) ) {
            return oxSeoEncoderTag::getInstance()->getTagUrl( $sTag, oxLang::getInstance()->getBaseLanguage() );
        }
        return oxUBase::generatePageNavigationUrl();
    }

    protected function _addPageNrParam( $sUrl, $iPage, $iLang = null)
    {
        if ( oxUtils::getInstance()->seoIsActive() && ( $sTag = $this->getTag() ) ) {
            if ( $iPage ) {
                // only if page number > 0
                $sUrl = oxSeoEncoderTag::getInstance()->getTagPageUrl( $sTag, $iPage, $iLang );
            }
        } else {
            $sUrl = oxUBase::_addPageNrParam( $sUrl, $iPage, $iLang );
        }
        return $sUrl;
    }

    public function getArticleList()
    {
        if ( $this->_aArticleList === null ) {
            if ( ( $this->getTag() ) ) {
                $this->_aArticleList = $this->_loadArticles( null );
            }
        }
        
        return $this->_aArticleList;
    }

    public function getTag()
    {
        if ( $this->_sTag === null ) {
            $this->_sTag = oxConfig::getParameter("searchtag", 1);
        }
        return $this->_sTag;
    }

    public function getTitle()
    {
        if ( $this->_sTagTitle === null ) {
            $this->_sTagTitle = false;
            if ( ( $sTag = $this->getTag() ) ) {
                $oStr = getStr();
                $sTitle = $oStr->ucfirst( $sTag );
                $this->_sTagTitle = $oStr->htmlspecialchars( $sTitle );
            }
        }
        return $this->_sTagTitle;
    }

    public function getTemplateLocation()
    {
        if ( $this->_sTemplateLocation === null ) {
            $this->_sTemplateLocation = false;
            if ( ( $sTag = $this->getTag() ) ) {
                $oStr = getStr();
                $sTitle = $oStr->ucfirst( $sTag );
                $this->_sTemplateLocation = oxLang::getInstance()->translateString('TAGS')." / ".$oStr->htmlspecialchars( $sTitle );
            }
        }
        return $this->_sTemplateLocation;
    }

    public function getTreePath()
    {
        if ( ( $sTag = $this->getTag() ) ) {
            $oStr = getStr();

            $aPath[0] = oxNew( "oxcategory" );
            $aPath[0]->setLink( false );
            $aPath[0]->oxcategories__oxtitle = new oxField( oxLang::getInstance()->translateString('TAGS') );

            $aPath[1] = oxNew( "oxcategory" );
            $aPath[1]->setLink( false );
            $aPath[1]->oxcategories__oxtitle = new oxField( $oStr->htmlspecialchars( $oStr->ucfirst( $sTag ) ) );
            return $aPath;
        }
    }

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

    protected function _prepareMetaKeyword( $sKeywords, $blRemoveDuplicatedWords = true )
    {
        return parent::_collectMetaKeyword( $sKeywords );
    }

    protected function _prepareMetaDescription( $sMeta, $iLength = 1024, $blDescTag = false )
    {
        return parent::_collectMetaDescription( $sMeta, $iLength, $blDescTag );
    }

    public function getCanonicalUrl()
    {
        if ( ( $iPage = $this->getActPage() ) ) {
            return $this->_addPageNrParam( $this->generatePageNavigationUrl(), $iPage );
        } elseif ( ( $sTag = $this->getTag() ) ) {
            return oxSeoEncoderTag::getInstance()->getTagUrl( $sTag );
        }
    }
}