oxtag.php

Go to the documentation of this file.

<?php

if (!defined('OXTAGCLOUD_MINTAGLENGTH')) {
    define('OXTAGCLOUD_MINTAGLENGTH', 4);
}
class oxTag extends oxSuperCfg
{

    protected $_sTag = '';

    protected $_aForbiddenTags = array(
        'admin', 'application', 'core', 'export', 'modules', 'out', 'setup', 'tmp'
    );

    protected $_sTagLink = null;

    protected $_iTagMaxLength = 60;

    protected $_iHitCount = 1;

    protected $_aMetaChars = array('+','-','>','<','(',')','~','*','"','\'','\\','[',']','{','}',';',':','.','/','|','!','@','#','$','%','^','&','?','=','`');

    public function __construct( $sTag = null )
    {
        parent::__construct();
        if ( $sTag !== null ) {
            $this->set( $sTag );
        }
    }

    public function setMaxLength( $iTagMaxLength )
    {
        $this->_iTagMaxLength = $iTagMaxLength;
    }

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

    public function set( $sTag, $blPrepare = true )
    {
        $this->_sTag = $blPrepare? $this->prepare( $sTag ) : $sTag;
        $this->setLink();
    }

    public function get()
    {
        return $this->_sTag;
    }

    public function setHitCount( $iHitCount )
    {
        $this->_iHitCount = $iHitCount;
    }

    public function getHitCount()
    {
        return $this->_iHitCount;
    }

    public function increaseHitCount()
    {
        $this->_iHitCount++;
    }

    public function isValid()
    {
        $blValid = strlen($this->_sTag) > 0? true : false;
        if ( $blValid && in_array( $this->_sTag, $this->_aForbiddenTags ) ) {
            $blValid = false;
        }
        return $blValid;
    }

    public function getLink()
    {
        if ( is_null($this->_sTagLink) ) {
             $this->_sTagLink = $this->formLink( $this->get() );
        }
        return $this->_sTagLink;
    }

    public function setLink( $sTagLink = null )
    {
        $this->_sTagLink = $sTagLink;
    }

    public function getTitle()
    {
        return getStr()->htmlentities( $this->get() );
    }

    public function __toString()
    {
        return $this->get();
    }

    public function prepare( $sTag )
    {
        $sTag = $this->stripMetaChars($sTag);
        $oStr = getStr();
        $iLen = $oStr->strlen( $sTag );
        if ( $iLen > $this->getMaxLength() ) {
            $sTag = trim( $oStr->substr( $sTag, 0, $this->getMaxLength() ) );
        }
        return $oStr->strtolower( $sTag );
    }

    public function stripMetaChars( $sText )
    {
        $oStr  = getStr();

        // Remove meta chars
        $sText = str_replace($this->_aMetaChars, ' ', $sText);

        // Replace multiple spaces with single space
        $sText = $oStr->preg_replace( "/\s+/", " ", trim( $sText ) );

        return $sText;
    }

    public function formLink( $sTag )
    {
        $oSeoEncoderTag = oxRegistry::get("oxSeoEncoderTag");

        $iLang = oxRegistry::getLang()->getBaseLanguage();

        $sUrl = false;
        if ( oxRegistry::getUtils()->seoIsActive() ) {
            $sUrl = $oSeoEncoderTag->getTagUrl( $sTag, $iLang );
        }
        return $sUrl ? $sUrl : $this->getConfig()->getShopUrl() . $oSeoEncoderTag->getStdTagUri( $sTag ) . "&amp;lang=" . $iLang;
    }

    public function addUnderscores()
    {
        $oStr = getStr();
        $aTagParts = explode( ' ', $this->get() );
        foreach ($aTagParts as &$sTagPart) {
            if ( $oStr->strlen( $sTagPart ) < OXTAGCLOUD_MINTAGLENGTH ) {
                $sTagPart .= str_repeat( "_", OXTAGCLOUD_MINTAGLENGTH - $oStr->strlen( $sTagPart ) );
            }
        }
        unset($sTagPart);
        $this->set( implode( ' ', $aTagParts ), false );
    }


    public function removeUnderscores()
    {
        $oStr = getStr();
        $sRes = '';
        if ( $oStr->preg_match_all( "/([\s\-]?)([^\s\-]+)([\s\-]?)/", $this->get(), $aMatches ) ) {
            foreach ( $aMatches[2] as $iKey => $sMatch ) {
                if ( $oStr->strlen( $sMatch ) <= OXTAGCLOUD_MINTAGLENGTH ) {
                    $sMatch = rtrim( $sMatch, "_" );
                }
                $sRes .= $aMatches[1][$iKey] . $sMatch . $aMatches[3][$iKey];
            }
        }
        $this->set( $sRes, false );
    }
}