oxcategorylist.php

Go to the documentation of this file.

<?php


class oxCategoryList extends oxList
{
    protected $_sObjectsInListName = 'oxcategory';

    protected $_blHideEmpty = false;

    protected $_blForseFull = false;

    protected $_iForseLevel = 1;

    protected $_sActCat     = null;

    protected $_aPath = array();

    public function __construct( $sObjectsInListName = 'oxcategory')
    {
        $this->_blHideEmpty = $this->getConfig()->getConfigParam('blDontShowEmptyCategories');
        parent::__construct( $sObjectsInListName );
    }

    protected function _getSelectString($blReverse = false)
    {
        $oBaseObject = $this->getBaseObject();
        $sViewName  = $oBaseObject->getViewName();
        //$sFieldList = $oBaseObject->getSelectFields();
        //excluding long desc
        $sLangSuffix = oxLang::getInstance()->getLanguageTag();
        $sFieldList = "oxid, oxactive$sLangSuffix as oxactive, oxhidden, oxparentid, oxdefsort, oxdefsortmode, oxleft, oxright, oxrootid, oxsort, oxtitle$sLangSuffix as oxtitle, oxpricefrom, oxpriceto, oxicon ";
        $sWhere     = $this->_getDepthSqlSnippet();

        $sOrdDir    = $blReverse?'desc':'asc';
        $sOrder     = "$sViewName.oxrootid $sOrdDir, $sViewName.oxleft $sOrdDir";

            $sFieldList.= ",not $sViewName.".$oBaseObject->getSqlFieldName( 'oxactive' )." as remove";


        return "select $sFieldList from $sViewName where $sWhere order by $sOrder";
    }

    protected function _getDepthSqlSnippet()
    {
        $sDepthSnippet = ' 1 ';

        // complex tree depth loading optimization ...
        if (!$this->isAdmin() && !$this->_blHideEmpty && !$this->_blForseFull) {
            $sViewName  = $this->getBaseObject()->getViewName();
            $sDepthSnippet = ' ( 0';

            $oCat = oxNew('oxcategory');
            $blLoaded = $oCat->load($this->_sActCat);
            // load compleate tree of active category, if it exists
            if ($blLoaded && $this->_sActCat && $sActRootID = $oCat->oxcategories__oxrootid->value) {
                $sDepthSnippet .= " or ("
                    ." $sViewName.oxparentid in"
                        ." (select subcats.oxparentid from $sViewName as subcats"
                        ." where subcats.oxrootid = '{$oCat->oxcategories__oxrootid->value}'"
                        ." and subcats.oxleft <= {$oCat->oxcategories__oxleft->value}"
                        ." and subcats.oxright >= {$oCat->oxcategories__oxright->value})"
                    ." or ($sViewName.oxparentid = '{$oCat->oxcategories__oxid->value}')"
                .")";
            } else {
                $this->_sActCat = null;
            }

            // load 1'st category level (roots)
            if ($this->_iForseLevel >= 1) {
                $sDepthSnippet .= " or $sViewName.oxparentid = 'oxrootid'";
            }

            // load 2'nd category level ()
            if ($this->_iForseLevel >= 2) {
                $sDepthSnippet .= " or $sViewName.oxrootid = $sViewName.oxparentid or $sViewName.oxid = $sViewName.oxrootid";
            }

            $sDepthSnippet .= ' ) ';
        }
        return $sDepthSnippet;
    }


    public function buildTree($sActCat, $blLoadFullTree, $blPerfLoadTreeForSearch, $blTopNaviLayout)
    {
        startProfile("buildTree");

        $this->_sActCat     = $sActCat;
        $this->_blForseFull = $blLoadFullTree || $blPerfLoadTreeForSearch;
        $this->_iForseLevel = $blTopNaviLayout?2:1;

        $sSelect = $this->_getSelectString(true);
        $this->selectString($sSelect);

        // PostProcessing
        if ( !$this->isAdmin() ) {
            // remove inactive categories
            $this->_ppRemoveInactiveCategories();

            // add active cat as full object
            $this->_ppLoadFullCategory($sActCat);

            // builds navigation path
            $this->_ppAddPathInfo();

            // add content categories
            $this->_ppAddContentCategories();

            // build tree structure
            $this->_ppBuildTree();
        }

        stopProfile("buildTree");
    }

    protected function _ppLoadFullCategory($sId)
    {
        $oNewCat = oxNew('oxcategory');
        if ($oNewCat->load($sId)) {
            // replace aArray object with fully loaded category
            $this->_aArray[$sId] = $oNewCat;
        }
    }

    public function buildList($blLoad)
    {

        if (!$blLoad) {
            return;
        }

        startProfile('buildCategoryList');

        $this->_blForseFull = true;
        $this->selectString($this->_getSelectString(false));

        // PostProcessing
        // add tree depth info
        $this->_ppAddDepthInformation();
        stopProfile('buildCategoryList');
    }

    public function setShopID($sShopID)
    {
        $this->_sShopID = $sShopID;
    }

    public function getPath()
    {
        return $this->_aPath;
    }

    public function getHtmlPath()
    {
        $sHtmlCatTree = '';
        $sSep         = '';
        foreach ( $this->_aPath as $oCategory ) {
            $sHtmlCatTree .= " $sSep<a href='".$oCategory->getLink()."'>".$oCategory->oxcategories__oxtitle->value."</a>";
            $sSep = '/ ';
        }
        return $sHtmlCatTree;
    }

    public function getClickCat()
    {
        if (count($this->_aPath)) {
            return end($this->_aPath);
        }
    }

    public function getClickRoot()
    {
        if (count($this->_aPath)) {
            return array(reset($this->_aPath));
        }
    }

    protected function _ppRemoveInactiveCategories()
    {
        // Colect all items whitch must be remove
        $aRemoveList = array();
        foreach ($this->_aArray as $oCat) {
            if ($oCat->oxcategories__remove->value) {
                if (isset($aRemoveList[$oCat->oxcategories__oxrootid->value])) {
                    $aRemoveRange = $aRemoveList[$oCat->oxcategories__oxrootid->value];
                } else {
                    $aRemoveRange = array();
                }
                $aRemoveList[$oCat->oxcategories__oxrootid->value] = array_merge(range($oCat->oxcategories__oxleft->value, $oCat->oxcategories__oxright->value), $aRemoveRange);
            }
            unset($oCat->oxcategories__remove);
        }

        // Remove colected items from list.
        foreach ($this->_aArray as $oCat) {
            if (isset($aRemoveList[$oCat->oxcategories__oxrootid->value]) && in_array($oCat->oxcategories__oxleft->value, $aRemoveList[$oCat->oxcategories__oxrootid->value])) {
                unset( $this->_aArray[$oCat->oxcategories__oxid->value] );
            }
        }
    }

    protected function _ppAddPathInfo()
    {

        if (is_null($this->_sActCat)) {
            return;
        }

        $aPath = array();
        $sCurrentCat  = $this->_sActCat;

        while ($sCurrentCat != 'oxrootid' && isset($this[$sCurrentCat])) {
            $oCat = $this[$sCurrentCat];
            $oCat->setExpanded(true);
            $aPath[$sCurrentCat] = $oCat;
            $sCurrentCat = $oCat->oxcategories__oxparentid->value;
        }

        $this->_aPath = array_reverse($aPath);
    }

    protected function _ppAddContentCategories()
    {
        // load content pages for adding them into menue tree
        $oContentList = oxNew( "oxcontentlist" );
        $oContentList->loadCatMenues();

        foreach ($oContentList as $sCatId => $aContent) {
            if (array_key_exists($sCatId, $this->_aArray)) {
                $this[$sCatId]->setContentCats($aContent);

            }
        }
    }

    protected function _ppBuildTree()
    {
        startProfile("_sortCats");
        $aIds = $this->sortCats();
        stopProfile("_sortCats");
        $aTree = array();
        foreach ($this->_aArray as $oCat) {
            $sParentId = $oCat->oxcategories__oxparentid->value;
            if ( $sParentId != 'oxrootid') {
                $this->_aArray[$sParentId]->setSortingIds( $aIds );
                $this->_aArray[$sParentId]->setSubCat($oCat, $oCat->getId());
            } else {
                $aTree[$oCat->getId()] = $oCat;
            }
        }

        // Sort root categories
        $oCategory = oxNew('oxcategory');
        $oCategory->setSortingIds( $aIds );
        uasort($aTree, array( $oCategory, 'cmpCat' ) );

        $this->assign($aTree);
    }

    public function sortCats()
    {
        $oDB = oxDb::getDb();
        $sViewName  = getViewName('oxcategories');
        $sSortSql = "SELECT oxid FROM $sViewName ORDER BY oxparentid, oxsort, oxtitle";
        $aIds = array();
        $rs = $oDB->execute($sSortSql);
        $cnt = 0;
        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {
                $aIds[$rs->fields[0]] = $cnt;
                $cnt++;
                $rs->moveNext();
            }
        }

        return $aIds;
    }

    protected function _ppAddDepthInformation()
    {

        $aStack = array();
        $iDepth = 0;
        $sPrevParent = '';

        foreach ($this->_aArray as $oCat) {

            $sParentId = $oCat->oxcategories__oxparentid->value;
            if ( $oCat->oxcategories__oxparentid->value == 'oxrootid' ) {
                $iDepth = 1;
                $aStack = array($sParentId => '0');
            }

            if ($sPrevParent != $sParentId && isset($aStack[$sParentId]) ) {
                $iDepth -= count($aStack)- $aStack[$sParentId];
                $aStack = array_slice($aStack, 0, $iDepth-1, true);
            }

            if ( !isset($aStack[$sParentId])) {
                $aStack[$sParentId] = $iDepth;
                $iDepth++;
            }

            $oCat->oxcategories__oxtitle->setValue(str_repeat('-', $iDepth-1).' '.$oCat->oxcategories__oxtitle->value);
            $sPrevParent = $sParentId;
        }

    }

    public function updateCategoryTree($blVerbose = true, $sShopID = null)
    {
        $oDB = oxDb::getDb();
        $sWhere = '1';


        $oDB->execute("update oxcategories set oxleft = 0, oxright = 0 where $sWhere");
        $oDB->execute("update oxcategories set oxleft = 1, oxright = 2 where oxparentid = 'oxrootid' and $sWhere");

        // Get all root categories
        $rs = $oDB->execute("select oxid, oxtitle from oxcategories where oxparentid = 'oxrootid' and $sWhere order by oxsort");
        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {
                if ($blVerbose) {
                    echo( "<b>Processing : ".$rs->fields[1]."</b>(".$rs->fields[0].")<br>");
                }
                $oxRootId = $rs->fields[0];

                $updn = $this->_updateNodes($oxRootId, true, $oxRootId);
                $rs->moveNext();
            }
        }
    }

    protected function _updateNodes($oxRootId, $isroot, $thisRoot)
    {
        $oDB = oxDb::getDb();

        if ($isroot) {
            $thisRoot = $oxRootId;
        }

        // Get sub categories of root categorie
        $rs = $oDB->execute("update oxcategories set oxrootid = '$thisRoot' where oxparentid = '$oxRootId'");
        $rs = $oDB->execute("select oxid, oxparentid from oxcategories where oxparentid = '$oxRootId' order by oxsort");
        // If there are sub categories
        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {
                $parentId = $rs->fields[1];
                $actOxid = $rs->fields[0];

                // Get the data of the parent category to the current Cat
                $rs3 = $oDB->execute("select oxrootid, oxright from oxcategories where oxid = '$parentId'");
                while (!$rs3->EOF) {
                    $parentOxRootId = $rs3->fields[0];
                    $parentRight = $rs3->fields[1];
                    $rs3->moveNext();
                }
                $oDB->execute("update oxcategories set oxleft = oxleft + 2 where oxrootid = '$parentOxRootId' and oxleft > '$parentRight' and oxright >= '$parentRight' and oxid != '$actOxid'");
                $oDB->execute("update oxcategories set oxright = oxright + 2 where oxrootid = '$parentOxRootId' and oxright >= '$parentRight' and oxid != '$actOxid'");
                $oDB->execute("update oxcategories set oxleft = $parentRight, oxright = ($parentRight + 1) where oxid = '$actOxid'");
                $this->_updateNodes($actOxid, false, $thisRoot);
                $rs->moveNext();
            }
        }
    }

    public function __get($sName)
    {
        switch ($sName) {
            case 'aPath':
            case 'aFullPath':
                return $this->getPath();
            }
        return parent::__get($sName);
    }

}

---