oxseoencodercategory.php

Go to the documentation of this file.

<?php

class oxSeoEncoderCategory extends oxSeoEncoder
{
    protected static $_instance = null;

    protected $_aCatCache = array();

    public static function getInstance()
    {
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            self::$_instance = modInstances::getMod( __CLASS__ );
        }

        if (!self::$_instance) {
            self::$_instance = oxNew("oxSeoEncoderCategory");
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            // resetting cache
            self::$_instance->_aSeoCache = array();
        }

        return self::$_instance;
    }

    protected function _getUrlExtension()
    {
        return '/';
    }

    protected function _categoryUrlLoader( $oCat, $iLang )
    {
        $sSeoUrl = false;

        $sCacheId = $this->_getCategoryCacheId( $oCat, $iLang );
        if ( isset( $this->_aCatCache[$sCacheId] ) ) {
            $sSeoUrl = $this->_aCatCache[ $sCacheId ];
        } elseif ( ( $sSeoUrl = $this->_loadFromDb( 'oxcategory', $oCat->getId(), $iLang ) ) ) {
            // caching
            $this->_aCatCache[ $sCacheId ] = $sSeoUrl;
        }

        return $sSeoUrl;
    }

    private function _getCategoryCacheId( $oCat, $iLang )
    {
        return $oCat->getId() . '_' . ( (int) $iLang );
    }

    public function getCategoryUri( $oCat, $iLang = null, $blRegenerate = false  )
    {
        startProfile(__FUNCTION__);
        $sCatId = $oCat->getId();

        // skipping external category URLs
        if ( $oCat->oxcategories__oxextlink->value ) {
            $sSeoUrl = null;
        } else {
            // not found in cache, process it from the top
            if (!isset($iLang)) {
                $iLang = $oCat->getLanguage();
            }

            $aCacheMap = array();
            $aStdLinks = array();

            while ( $oCat && !($sSeoUrl = $this->_categoryUrlLoader( $oCat, $iLang ) )) {

                if ($iLang != $oCat->getLanguage()) {
                    $sId = $oCat->getId();
                    $oCat = oxNew('oxcategory');
                    $oCat->loadInLang($iLang, $sId);
                }

                // prepare oCat title part
                $sTitle = $this->_prepareTitle( $oCat->oxcategories__oxtitle->value, false, $oCat->getLanguage() );

                foreach ( array_keys( $aCacheMap ) as $id ) {
                    $aCacheMap[$id] = $sTitle . '/' . $aCacheMap[$id];
                }

                $aCacheMap[$oCat->getId()] = $sTitle;
                $aStdLinks[$oCat->getId()] = $oCat->getBaseStdLink($iLang);

                // load parent
                $oCat = $oCat->getParentCategory();
            }

            foreach ( $aCacheMap as $sId => $sUri ) {
                $this->_aCatCache[$sId.'_'.$iLang] = $this->_processSeoUrl( $sSeoUrl.$sUri.'/', $sId, $iLang );
                $this->_saveToDb( 'oxcategory', $sId, $aStdLinks[$sId], $this->_aCatCache[$sId.'_'.$iLang], $iLang );
            }

            $sSeoUrl = $this->_aCatCache[$sCatId.'_'.$iLang];
        }

        stopProfile(__FUNCTION__);

        return $sSeoUrl;
    }


    public function getCategoryPageUrl( $oCategory, $iPage, $iLang = null, $blFixed = null )
    {
        if (!isset($iLang)) {
            $iLang = $oCategory->getLanguage();
        }
        $sStdUrl = $oCategory->getBaseStdLink($iLang) . '&amp;pgNr=' . $iPage;
        $sParams = (int) ($iPage + 1);

        $sStdUrl = $this->_trimUrl( $sStdUrl, $iLang );
        $sSeoUrl = $this->getCategoryUri( $oCategory, $iLang ) . $sParams . "/";

        if ( $blFixed === null ) {
            $blFixed = $this->_isFixed( 'oxcategory', $oCategory->getId(), $iLang );
        }
        return $this->_getFullUrl( $this->_getPageUri( $oCategory, 'oxcategory', $sStdUrl, $sSeoUrl, $sParams, $iLang, $blFixed ), $iLang );
    }

    public function getCategoryUrl( $oCategory, $iLang = null )
    {
        $sUrl = '';
        if (!isset($iLang)) {
            $iLang = $oCategory->getLanguage();
        }
        // category may have specified url
        if ( ( $sSeoUrl = $this->getCategoryUri( $oCategory, $iLang ) ) ) {
            $sUrl = $this->_getFullUrl( $sSeoUrl, $iLang );
        }
        return $sUrl;
    }

    public function markRelatedAsExpired( $oCategory )
    {
        $oDb = oxDb::getDb();
        $sIdQuoted = $oDb->quote($oCategory->getId());

        // select it from table instead of using object carrying value
        // this is because this method is usually called inside update,
        // where object may already be carrying changed id
        $aCatInfo = $oDb->getAll("select oxrootid, oxleft, oxright from oxcategories where oxid = $sIdQuoted limit 1");
        $sCatRootIdQuoted = $oDb->quote( $aCatInfo[0][0] );

        // update sub cats
        $sQ = "update oxseo as seo1, (select oxid from oxcategories where oxrootid={$sCatRootIdQuoted} and oxleft > ".((int) $aCatInfo[0][1] )." and oxright < ".((int) $aCatInfo[0][2] ).") as seo2 set seo1.oxexpired = '1' where seo1.oxtype = 'oxcategory' and seo1.oxobjectid = seo2.oxid";
        $oDb->execute( $sQ );

        // update subarticles
        $sQ = "update oxseo as seo1, (select o2c.oxobjectid as id from oxcategories as cat left join oxobject2category as o2c on o2c.oxcatnid=cat.oxid where cat.oxrootid={$sCatRootIdQuoted} and cat.oxleft >= ".((int) $aCatInfo[0][1] )." and cat.oxright <= ".((int) $aCatInfo[0][2] ).") as seo2 set seo1.oxexpired = '1' where seo1.oxtype = 'oxarticle' and seo1.oxobjectid = seo2.id";
        $oDb->execute( $sQ );
    }


    public function onDeleteCategory( $oCategory )
    {
        $oDb = oxDb::getDb();
        $sIdQuoted = $oDb->quote($oCategory->getId());
        $oDb->execute("update oxseo, (select oxseourl from oxseo where oxobjectid = $sIdQuoted and oxtype = 'oxcategory') as test set oxseo.oxexpired=1 where oxseo.oxseourl like concat(test.oxseourl, '%') and (oxtype = 'oxcategory' or oxtype = 'oxarticle')");
        $oDb->execute("delete from oxseo where oxseo.oxtype = 'oxarticle' and oxseo.oxparams = $sIdQuoted" );
        $oDb->execute("delete from oxseo where oxobjectid = $sIdQuoted and oxtype = 'oxcategory'");
        $oDb->execute("delete from oxobject2seodata where oxobjectid = $sIdQuoted");
    }

    protected function _getAltUri( $sObjectId, $iLang )
    {
        $sSeoUrl = null;
        $oCat = oxNew( "oxcategory" );
        if ( $oCat->loadInLang( $iLang, $sObjectId ) ) {
            $sSeoUrl = $this->getCategoryUri( $oCat, $iLang );
        }
        return $sSeoUrl;
    }
}