search.php

Go to the documentation of this file.

<?php

class Search extends oxUBase
{
    protected $_iAllArtCnt     = 0;

    protected $_iCntPages = null;

    protected $_sThisTemplate = 'page/search/search.tpl';

    protected $_sListType = 'search';

    protected $_blShowSorting = true;

    protected $_blEmptySearch = null;

    protected $_oRecommList = null;

    protected $_sSearchParamForHtml = null;

    protected $_sSearchParam = null;

    protected $_sSearchCatId = null;

    protected $_sSearchVendor = null;

    protected $_sSearchManufacturer = null;

    protected $_blSearchClass = null;

    protected $_oPageNavigation = null;

    protected $_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW;

    protected $_aSimilarRecommListIds = null;


    public function init()
    {
        parent::init();

        $myConfig = $this->getConfig();

        // #1184M - specialchar search
        $sSearchParamForQuery = oxConfig::getParameter( 'searchparam', true );

        // searching in category ?
        $sInitialSearchCat = $this->_sSearchCatId = rawurldecode( oxConfig::getParameter( 'searchcnid' ) );

        // searching in vendor #671
        $sInitialSearchVendor = rawurldecode( oxConfig::getParameter( 'searchvendor' ) );

        // searching in Manufacturer #671
        $sInitialSearchManufacturer = $this->_sSearchManufacturer = rawurldecode( oxConfig::getParameter( 'searchmanufacturer' ) );

        $this->_blEmptySearch = false;
        if ( !$sSearchParamForQuery && !$sInitialSearchCat && !$sInitialSearchVendor && !$sInitialSearchManufacturer ) {
            //no search string
            $this->_aArticleList = null;
            $this->_blEmptySearch = true;
            return false;
        }

        // config allows to search in Manufacturers ?
        if ( !$myConfig->getConfigParam( 'bl_perfLoadManufacturerTree' ) ) {
            $sInitialSearchManufacturer = null;
        }

        // searching ..
        $oSearchHandler = oxNew( 'oxsearch' );
        $oSearchList = $oSearchHandler->getSearchArticles( $sSearchParamForQuery, $sInitialSearchCat, $sInitialSearchVendor, $sInitialSearchManufacturer, $this->getSortingSql( $this->getSortIdent() ) );

        // list of found articles
        $this->_aArticleList = $oSearchList;
        $this->_iAllArtCnt    = 0;

        // skip count calculation if no articles in list found
        if ( $oSearchList->count() ) {
            $this->_iAllArtCnt = $oSearchHandler->getSearchArticleCount( $sSearchParamForQuery, $sInitialSearchCat, $sInitialSearchVendor, $sInitialSearchManufacturer );
        }

        $iNrofCatArticles = (int) $myConfig->getConfigParam( 'iNrofCatArticles' );
        $iNrofCatArticles = $iNrofCatArticles?$iNrofCatArticles:1;
        $this->_iCntPages  = round( $this->_iAllArtCnt / $iNrofCatArticles + 0.49 );
    }

    public function render()
    {
        parent::render();

        $myConfig = $this->getConfig();
        if ( $myConfig->getConfigParam( 'bl_rssSearch' ) ) {
            $oRss = oxNew('oxrssfeed');
            $sSearch = oxConfig::getParameter( 'searchparam', true );
            $sCnid = oxConfig::getParameter( 'searchcnid', true );
            $sVendor = oxConfig::getParameter( 'searchvendor', true );
            $sManufacturer = oxConfig::getParameter( 'searchmanufacturer', true );
            $this->addRssFeed($oRss->getSearchArticlesTitle($sSearch, $sCnid, $sVendor, $sManufacturer), $oRss->getSearchArticlesUrl($sSearch, $sCnid, $sVendor, $sManufacturer), 'searchArticles');
        }

        // processing list articles
        $this->_processListArticles();

        return $this->_sThisTemplate;
    }

    protected function _processListArticles()
    {
        $sAddDynParams = $this->getAddUrlParams();
        if ( $sAddDynParams && ( $aArtList = $this->getArticleList() ) ) {
            $blSeo = oxRegistry::getUtils()->seoIsActive();
            foreach ( $aArtList as $oArticle ) {
                // appending std and dynamic urls
                if ( !$blSeo ) {
                    // only if seo is off..
                    $oArticle->appendStdLink( $sAddDynParams );
                }
                $oArticle->appendLink( $sAddDynParams );
            }
        }
    }

    public function getAddUrlParams()
    {
        $sAddParams  = parent::getAddUrlParams();
        $sAddParams .= ($sAddParams?'&amp;':'') . "listtype={$this->_sListType}";

        if ( $sParam = oxConfig::getParameter( 'searchparam', true ) ) {
            $sAddParams .= "&amp;searchparam=".rawurlencode($sParam);
        }

        if ( $sParam = oxConfig::getParameter( 'searchcnid' ) ) {
            $sAddParams .= "&amp;searchcnid=$sParam";
        }

        if ( $sParam = rawurldecode( oxConfig::getParameter( 'searchvendor' ) ) ) {
            $sAddParams .= "&amp;searchvendor=$sParam";
        }

        if ( $sParam = rawurldecode( oxConfig::getParameter( 'searchmanufacturer' ) ) ) {
            $sAddParams .= "&amp;searchmanufacturer=$sParam";
        }
        return $sAddParams;
    }

    public function setItemSorting( $sCnid, $sSortBy, $sSortOrder  = null )
    {
        parent::setItemSorting( $sCnid, $sSortBy, $sSortOrder );
    }

    public function getSorting( $sCnid )
    {
        return parent::getSorting( $sCnid );
    }

    protected function _isSearchClass()
    {
        if ( $this->_blSearchClass === null ) {
            $this->_blSearchClass = false;
            if ( strtolower(oxConfig::getParameter( 'cl' )) == 'search' ) {
                $this->_blSearchClass = true;
            }
        }
        return $this->_blSearchClass;
    }
    public function isEmptySearch()
    {
        return $this->_blEmptySearch;
    }

    public function getArticleList()
    {
        return $this->_aArticleList;
    }

    public function getSimilarRecommListIds()
    {
        if ( $this->_aSimilarRecommListIds === null ) {
            $this->_aSimilarRecommListIds = false;

            $aList = $this->getArticleList();
            if ( $aList && $aList->count() > 0 ) {
                $this->_aSimilarRecommListIds = $aList->arrayKeys();
            }
        }

        return $this->_aSimilarRecommListIds;
    }

    public function getSearchParamForHtml()
    {
        if ( $this->_sSearchParamForHtml === null ) {
            $this->_sSearchParamForHtml = false;
            if ( $this->_isSearchClass() ) {
                $this->_sSearchParamForHtml = oxConfig::getParameter( 'searchparam' );
            }
        }
        return $this->_sSearchParamForHtml;
    }

    public function getSearchParam()
    {
        if ( $this->_sSearchParam === null ) {
            $this->_sSearchParam = false;
            if ( $this->_isSearchClass() ) {
                $this->_sSearchParam = rawurlencode( oxConfig::getParameter( 'searchparam', true ) );
            }
        }
        return $this->_sSearchParam;
    }

    public function getSearchCatId()
    {
        if ( $this->_sSearchCatId === null ) {
            $this->_sSearchCatId = false;
            if ( $this->_isSearchClass() ) {
                $this->_sSearchCatId = rawurldecode( oxConfig::getParameter( 'searchcnid' ) );
            }
        }
        return $this->_sSearchCatId;
    }

    public function getSearchVendor()
    {
        if ( $this->_sSearchVendor === null ) {
            $this->_sSearchVendor = false;
            if ( $this->_isSearchClass() ) {
                // searching in vendor #671
                $this->_sSearchVendor = rawurldecode( oxConfig::getParameter( 'searchvendor' ) );
            }
        }
        return $this->_sSearchVendor;
    }

    public function getSearchManufacturer()
    {
        if ( $this->_sSearchManufacturer === null ) {
            $this->_sSearchManufacturer = false;
            if ( $this->_isSearchClass() ) {
                // searching in Manufacturer #671
                $this->_sSearchManufacturer = rawurldecode( oxConfig::getParameter( 'searchmanufacturer' ) );
            }
        }
        return $this->_sSearchManufacturer;
    }

    public function getPageNavigation()
    {
        if ( $this->_oPageNavigation === null ) {
            $this->_oPageNavigation = false;
            $this->_oPageNavigation = $this->generatePageNavigation();
        }
        return $this->_oPageNavigation;
    }


    public function getActiveCategory()
    {
        return $this->getActSearch();
    }

    public function getBreadCrumb()
    {
        $aPaths = array();
        $aPath = array();

        $aPath['title'] = oxRegistry::getLang()->translateString( 'SEARCH_TITLE', oxRegistry::getLang()->getBaseLanguage(), false );
        $aPath['link']  = $this->getLink();
        $aPaths[] = $aPath;

        return $aPaths;
    }

    public function canSelectDisplayType()
    {
        return $this->getConfig()->getConfigParam( 'blShowListDisplayType' );
    }

    protected function _canRedirect()
    {
        return false;
    }

    public function getArticleCount()
    {
        return $this->_iAllArtCnt;
    }
}