oxtagcloud.php

Go to the documentation of this file.

<?php

if (!defined('OXTAGCLOUD_MINFONT')) {
    define('OXTAGCLOUD_MINFONT', 100);
    define('OXTAGCLOUD_MAXFONT', 400);
    define('OXTAGCLOUD_MINOCCURENCETOSHOW', 2);
    //depends on mysql server configuration
    define('OXTAGCLOUD_MINTAGLENGTH', 4);
    define('OXTAGCLOUD_STARTPAGECOUNT', 20);
    define('OXTAGCLOUD_EXTENDEDCOUNT', 200);
}

class oxTagCloud extends oxSuperCfg
{
    protected $_sCacheKey = "tagcloud_";

    public function getTags($sArtId = null, $blExtended = false, $iLang = null )
    {
        $oDb = oxDb::getDb(true);
        if ($blExtended) {
            $iAmount = OXTAGCLOUD_EXTENDEDCOUNT;
        } else {
            $iAmount = OXTAGCLOUD_STARTPAGECOUNT;
        }

        $sArticleSelect = " 1 ";
        if ( $sArtId ) {
            $sArtId = $oDb->quote( $sArtId );
            $sArticleSelect = " oxarticles.oxid = $sArtId ";
            $iAmount = 0;
        }

        $sField = "oxartextends.oxtags".oxLang::getInstance()->getLanguageTag( $iLang );

        $sArtView = getViewName('oxarticles');
        $sQ = "select $sField as oxtags from $sArtView as oxarticles left join oxartextends on oxarticles.oxid=oxartextends.oxid where oxarticles.oxactive=1 AND $sArticleSelect";
        //$sQ = "select $sField from oxartextends where $sArticleSelect";
        $rs = $oDb->execute( $sQ );
        $aTags = array();
        while ( $rs && $rs->recordCount() && !$rs->EOF ) {
            $sTags = $this->trimTags( $rs->fields['oxtags'] );
            $aArticleTags = explode( ' ', $sTags );
            foreach ( $aArticleTags as $sTag ) {
                if ( trim( $sTag ) ) {
                    ++$aTags[$sTag];
                }
            }
            $rs->moveNext();
        }

        //taking only top tags
        if ( $iAmount ) {
            arsort($aTags);
            $aTags = array_slice($aTags, 0, $iAmount, true );
        }

        $aTags = $this->_sortTags( $aTags );
        return $aTags;
    }

    protected function _sortTags( $aTags, $iLang = null )
    {
        if ( is_array( $aTags ) && count( $aTags ) ) {
            $oDb = oxDb::getDb( true );
            $sSubQ = '';
            foreach ( $aTags as $sKey => $sTag ) {
                if ( $sSubQ ) {
                    $sSubQ .= ' union all ';
                }
                $sSubQ .= 'select '.$oDb->quote( $sKey ).' as _oxsort, '.$oDb->quote( $sTag ).' as _oxval';
            }

            $sField = "oxartextends.oxtags".oxLang::getInstance()->getLanguageTag( $iLang );

            // forcing collation
            $sSubQ = "select {$sField} as _oxsort, 'ox_skip' as _oxval from oxartextends limit 1 union $sSubQ";

            $sQ = "select _oxtable._oxsort, _oxtable._oxval from ( {$sSubQ} ) as _oxtable order by _oxtable._oxsort desc";

            $aTags = array();
            $oRs = $oDb->execute( $sQ );
            while ( $oRs && $oRs->recordCount() && !$oRs->EOF ) {
                if ( $oRs->fields['_oxval'] != 'ox_skip' ) {
                    $aTags[$oRs->fields['_oxsort']] = $oRs->fields['_oxval'];
                }
                $oRs->moveNext();
            }
        }
        return $aTags;
    }

    public function getTagCloud($sArtId = null, $blExtended = false, $iLang = null )
    {
        $myUtils = oxUtils::getInstance();

        $sTagCloud = null;
        $sCacheKey = $this->_getCacheKey($blExtended, $iLang );
        if ( $this->_sCacheKey && !$sArtId ) {
            $sTagCloud = $myUtils->fromFileCache( $sCacheKey );
        }

        if ( !is_null($sTagCloud) ) {
            return $sTagCloud;
        }

        $aTags = $this->getTags($sArtId, $blExtended, $iLang);
        if (!count($aTags)) {
            if ($this->_sCacheKey && !$sArtId) {
                $sTagCloud = false;
                $myUtils->toFileCache($sCacheKey, $sTagCloud);
            }
            return $sTagCloud;
        }

        $iMaxHit = max( $aTags);
        $blSeoIsActive = $myUtils->seoIsActive();
        $oSeoEncoderTag = oxSeoEncoderTag::getInstance();

        $iLang = ( $iLang !== null ) ? $iLang : oxLang::getInstance()->getBaseLanguage();
        $sUrl = $this->getConfig()->getShopUrl();
        $oStr = getStr();

        $sTagCloud = false;
        foreach ( $aTags as $sTag => $sRelevance ) {
            if ( $blSeoIsActive ) {
                $sLink = $oSeoEncoderTag->getTagUrl( $sTag, $iLang );
            } else {
                $sLink = $sUrl . $oSeoEncoderTag->getStdTagUri( $sTag ) . "&amp;lang=" . $iLang;
            }
            $sTagCloud .= "<a style='font-size:". $iFontSize ."%;' class='tagitem_". $iFontSize . "' href='$sLink'>".$oStr->htmlentities($sTag)."</a> ";
        }

        if ( $this->_sCacheKey && !$sArtId ) {
            $myUtils->toFileCache( $sCacheKey, $sTagCloud );
        }

        return $sTagCloud;
    }

    protected function _getFontSize($iHit, $iMaxHit)
    {
        //handling special case
        if ($iMaxHit <= OXTAGCLOUD_MINOCCURENCETOSHOW || !$iMaxHit) {
            return OXTAGCLOUD_MINFONT;
        }

        $iFontDiff = OXTAGCLOUD_MAXFONT - OXTAGCLOUD_MINFONT;
        $iMaxHitDiff = $iMaxHit - OXTAGCLOUD_MINOCCURENCETOSHOW;
        $iHitDiff = $iHit - OXTAGCLOUD_MINOCCURENCETOSHOW;

        if ($iHitDiff < 0) {
            $iHitDiff = 0;
        }

        $iSize = round($iHitDiff * $iFontDiff / $iMaxHitDiff) + OXTAGCLOUD_MINFONT;

        return $iSize;
    }

    public function prepareTags( $sTags )
    {
        $aTags = explode( ' ', $sTags );
        $sRes = '';
        $oStr = getStr();
        foreach ( $aTags as $sTag ) {
            if ( ( $iLen = $oStr->strlen( $sTag ) ) ) {
                if ( $iLen < OXTAGCLOUD_MINTAGLENGTH ) {
                    $sTag .= str_repeat( '_', OXTAGCLOUD_MINTAGLENGTH - $iLen );
                }

                $sRes .= $oStr->strtolower( $sTag ) . " ";
            }
        }

        return trim( $sRes );
    }

    public function trimTags($sTags)
    {
        $aTags = explode(' ', $sTags);
        $sRes = '';
        $oStr = getStr();
        foreach ( $aTags as $sTag ) {
            if ( $oStr->strlen( $sTag ) ) {
                $sRes .= rtrim( $sTag, '_' ) . " ";
            }
        }

        return trim( $sRes );
    }

    public function resetTagCache( $iLang = null )
    {
        $myUtils = oxUtils::getInstance();

        $sCacheKey1 = $this->_getCacheKey( true, $iLang );
        $myUtils->toFileCache( $sCacheKey1, null );

        $sCacheKey2 = $this->_getCacheKey( false, $iLang );
        $myUtils->toFileCache( $sCacheKey2, null );
    }

    protected function _getCacheKey( $blExtended, $iLang = null )
    {
        return $this->_sCacheKey."_".$this->getConfig()->getShopId()."_".( ( $iLang !== null ) ? $iLang : oxLang::getInstance()->getBaseLanguage() ) ."_".$blExtended;
    }

}

---