oxtagcloud.php

Go to the documentation of this file.

<?php

// @deprecated v5.3 (2016-05-04); Tags will be moved to own module.
if (!defined('OXTAGCLOUD_MINFONT')) {
    define('OXTAGCLOUD_MINFONT', 100);
    define('OXTAGCLOUD_MAXFONT', 400);
    define('OXTAGCLOUD_MINOCCURENCETOSHOW', 2);
    define('OXTAGCLOUD_STARTPAGECOUNT', 20);
    define('OXTAGCLOUD_EXTENDEDCOUNT', 200);
}
// END deprecated

class oxTagCloud extends oxSuperCfg
{

    protected $_sCacheKey = "tagcloud";

    protected $_iMaxHit = null;

    protected $_aCloudArray = null;

    protected $_blExtended = false;


    protected $_iTagMaxLength = 60;

    public function __construct()
    {
    }

    public function getTagMaxLength()
    {
        return $this->_iTagMaxLength;
    }

    public function setExtendedMode($blExtended)
    {
        $this->_blExtended = $blExtended;
    }

    public function isExtended()
    {
        return $this->_blExtended;
    }

    public function setTagList(oxITagList $oTagList)
    {
        $this->_oTagList = $oTagList;
    }

    public function getTagList()
    {
        return $this->_oTagList;
    }

    public function setCloudArray($aTagCloudArray)
    {
        $sCacheIdent = $this->_formCacheKey();
        $this->_aCloudArray[$sCacheIdent] = $aTagCloudArray;
    }

    public function getCloudArray()
    {
        $sCacheIdent = $this->_formCacheKey();
        if (!isset($this->_aCloudArray[$sCacheIdent])) {
            $oTagList = $this->getTagList();

            $this->_aCloudArray[$sCacheIdent] = $this->formCloudArray($oTagList);
        }

        return $this->_aCloudArray[$sCacheIdent];
    }

    public function formCloudArray(oxITagList $oTagList)
    {
        // checking if current data is already loaded
        if ($oTagList->getCacheId()) {
            $sCacheIdent = $this->_formCacheKey($oTagList->getCacheId());
            $myUtils = oxRegistry::getUtils();
            // checking cache
            $aCloudArray = $myUtils->fromFileCache($sCacheIdent);
        }

        // loading cloud info
        if ($aCloudArray === null) {
            $oTagList->loadList();
            $oTagSet = $oTagList->get();
            if (count($oTagSet->get()) > $this->getMaxAmount()) {
                $oTagSet->sortByHitCount();
                $oTagSet->slice(0, $this->getMaxAmount());
            }
            $oTagSet->sort();
            $aCloudArray = $oTagSet->get();
            // updating cache
            if ($sCacheIdent) {
                $myUtils->toFileCache($sCacheIdent, $aCloudArray);
            }
        }

        return $aCloudArray;
    }

    public function getTagSize($sTag)
    {
        $aCloudArray = $this->getCloudArray();
        if (is_null($aCloudArray[$sTag])) {
            return 1;
        }
        $iCurrSize = $this->_getFontSize($aCloudArray[$sTag]->getHitCount(), $this->_getMaxHit());

        // calculating min size
        return floor($iCurrSize / OXTAGCLOUD_MINFONT) * OXTAGCLOUD_MINFONT;
    }

    public function getMaxAmount()
    {
        if ($this->isExtended()) {
            return OXTAGCLOUD_EXTENDEDCOUNT;
        } else {
            return OXTAGCLOUD_STARTPAGECOUNT;
        }
    }

    public function resetTagCache($iLang = null)
    {
        if ($iLang) {
            $this->setLanguageId($iLang);
        }
        $this->resetCache();
    }

    public function resetCache()
    {
        $myUtils = oxRegistry::getUtils();

        $sCacheId = null;
        if (($oTagList = $this->getTagList()) !== null) {
            $sCacheId = $oTagList->getCacheId();
        }

        $myUtils->toFileCache($this->_formCacheKey($sCacheId), null);

        $this->_aCloudArray = null;
    }

    protected function _formCacheKey($sTagListCacheId = null)
    {
        $sExtended = $this->isExtended() ? '1' : '0';

        return $this->_sCacheKey . "_" . $this->getConfig()->getShopId() . "_" . $sExtended . "_" . $sTagListCacheId;
    }

    protected function _getMaxHit()
    {
        if ($this->_iMaxHit === null) {
            $aHits = array_map(array($this, '_getTagHitCount'), $this->getCloudArray());
            $this->_iMaxHit = max($aHits);
        }

        return $this->_iMaxHit;
    }

    protected function _getTagHitCount($oTag)
    {
        return $oTag->getHitCount();
    }

    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;
    }
}