oxtagset.php

Go to the documentation of this file.

<?php


class oxTagSet extends oxSuperCfg implements Iterator
{

    protected $_sSeparator = ',';

    protected $_aTags = array();

    protected $_aInvalidTags = array();

    public function setSeparator( $sSeparator )
    {
        $this->_sSeparator = $sSeparator;
    }

    public function getSeparator()
    {
        return $this->_sSeparator;
    }

    public function set( $sTags, $blPrepare = true )
    {
        $this->clear();
        $this->add( $sTags, $blPrepare );
    }

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

    public function getInvalidTags()
    {
        return $this->_aInvalidTags;
    }

    public function add( $sTags, $blPrepare = true )
    {
        $aTags = explode( $this->getSeparator(), $sTags );
        foreach ( $aTags as $sTag ) {
            $this->addTag( $sTag, $blPrepare );
        }
    }

    public function addTag( $mTag, $blPrepare = true )
    {
        $oTag = $this->_formTag( $mTag, $blPrepare );
        $sTagName = $oTag->get();
        if ( !$oTag->isValid() ) {
            if ( $sTagName !== "" ) {
                $this->_aInvalidTags[$sTagName] = $oTag;
            }
            return false;
        }
        if ( $this->_aTags[$sTagName] === null ) {
            $this->_aTags[$sTagName] = $oTag;
        } else {
            $this->_aTags[$sTagName]->increaseHitCount();
        }
        return true;
    }

    public function clear()
    {
        $this->_aTags = array();
    }

    public function formString()
    {
        $aTags = array();
        foreach ($this->get() as $oTag) {
            $aTags = array_merge($aTags, array_fill(0, $oTag->getHitCount(), $oTag->get() ) );
        }
        return implode($this->getSeparator(), $aTags );
    }

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

    public function slice( $offset, $length )
    {
        $this->_aTags = array_slice( $this->get(), $offset, $length, true );
        return $this->_aTags;
    }

    public function sort()
    {
        $oStr = getStr();
        uksort( $this->_aTags, array($oStr, 'strrcmp') );
    }

    public function sortByHitCount()
    {
        uasort( $this->_aTags, array($this, '_tagHitsCmp') );
    }

    public function current()
    {
        return current( $this->_aTags );
    }

    public function next()
    {
        next( $this->_aTags );
    }

    public function key()
    {
        return key( $this->_aTags );
    }

    public function valid()
    {
        return isset( $this->_aTags[ $this->key() ] );
    }

    public function rewind()
    {
        reset( $this->_aTags );
    }

    protected function _formTag( $mTag, $blPrepare = true )
    {
        if ( $mTag instanceof oxTag ) {
            $oTag = $mTag;
        } else {
            $oTag = oxNew( "oxTag" );
            $oTag->set( $mTag, $blPrepare );
        }
        return $oTag;
    }

    protected function _tagHitsCmp( $oTag1, $oTag2 )
    {
        return $oTag2->getHitCount() - $oTag1->getHitCount();
    }
}