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();

        $oArticleList = $this->getArticleList();

        // if tags are off or no articles - showing 404 header (#2139)
        if (!$this->showTags() || !$oArticleList) {
            error_404_handler();
        }

        // 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 = oxRegistry::getConfig()->getRequestParameter('searchtag', true)) {
            $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->_getRequestPageNr(), $iNrofCatArticles);
        $oArtList->setCustomSorting($this->getSortingSql($this->getSortIdent()));
        // load the articles
        $this->_iAllArtCnt = $oArtList->loadTagArticles($this->getTag(), oxRegistry::getLang()->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 generatePageNavigationUrl()
    {
        if ((oxRegistry::getUtils()->seoIsActive() && ($sTag = $this->getTag()))) {
            $sLink = oxRegistry::get("oxSeoEncoderTag")->getTagUrl($sTag, oxRegistry::getLang()->getBaseLanguage());
        }

        return $sLink ? $sLink : oxUBase::generatePageNavigationUrl();
    }

    protected function _addPageNrParam($sUrl, $iPage, $iLang = null)
    {
        $sSeoUrl = $blSeo = oxRegistry::getUtils()->seoIsActive();
        if ($blSeo && ($sTag = $this->getTag())) {
            if ($iPage && ($sSeoUrl = oxRegistry::get("oxSeoEncoderTag")->getTagPageUrl($sTag, $iPage, $iLang))) {
                // only if page number > 0
                $sUrl = $sSeoUrl;
            }
        }

        return (!$blSeo || !$sSeoUrl) ? oxUBase::_addPageNrParam($sUrl, $iPage, $iLang) : $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 = oxRegistry::getConfig()->getRequestParameter("searchtag", false);
        }

        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 getTreePath()
    {
        if (($sTag = $this->getTag())) {
            $oStr = getStr();

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

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

            return $aPath;
        }
    }

    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 oxRegistry::get("oxSeoEncoderTag")->getTagUrl($sTag);
        }
    }

    public function getBreadCrumb()
    {
        $aPaths = array();
        $aCatPath = array();

        $iBaseLanguage = oxRegistry::getLang()->getBaseLanguage();
        $sSelfLink = $this->getViewConfig()->getSelfLink();

        $aCatPath['title'] = oxRegistry::getLang()->translateString('TAGS', $iBaseLanguage, false);
        $aCatPath['link'] = oxRegistry::get("oxSeoEncoder")->getStaticUrl($sSelfLink . 'cl=tags');
        $aPaths[] = $aCatPath;

        $aCatPath['title'] = $this->getTitle();
        $aCatPath['link'] = $this->getCanonicalUrl();
        $aPaths[] = $aCatPath;

        return $aPaths;
    }
}