ajaxlistcomponent.php

Go to the documentation of this file.

<?php


class ajaxListComponent extends oxSuperCfg
{

    protected $_aPosDir = array('asc', 'desc');

    protected $_aColumns = array();

    protected $_iSqlLimit = 2500;

    protected $_sContainer = null;

    protected $_blAllowExtColumns = false;

    public function init($aColumns = null)
    {
        if (!is_null($aColumns)) {
            $this->setColumns($aColumns);
        }
    }

    public function getColumns()
    {
        return $this->_aColumns;
    }

    public function setColumns($aColumns)
    {
        $this->_aColumns = $aColumns;
    }

    protected function _getActionIds($sId)
    {
        $aColumns = $this->_getColNames();
        foreach ($aColumns as $iPos => $aCol) {
            if (isset($aCol[4]) && $aCol[4] == 1 && $sId == $aCol[1] . '.' . $aCol[0]) {
                return oxRegistry::getConfig()->getRequestParameter('_' . $iPos);
            }
        }
    }

    public function setName($sName)
    {
        $this->_sContainer = $sName;
    }

    protected function _getQuery()
    {
        return '';
    }

    protected function _getDataQuery($sQ)
    {
        return 'select ' . $this->_getQueryCols() . $sQ;
    }

    protected function _getCountQuery($sQ)
    {
        return 'select count( * ) ' . $sQ;
    }

    public function processRequest($sFunction = null)
    {
        if ($sFunction) {
            $this->$sFunction();


        } else {
            $sQAdd = $this->_getQuery();

            // formatting SQL queries
            $sQ = $this->_getDataQuery($sQAdd);
            $sCountQ = $this->_getCountQuery($sQAdd);

            $this->_outputResponse($this->_getData($sCountQ, $sQ));
        }
    }

    protected function _getSortCol()
    {
        $aVisibleNames = $this->_getVisibleColNames();
        $iCol = oxRegistry::getConfig()->getRequestParameter('sort');
        $iCol = $iCol ? (( int ) str_replace('_', '', $iCol)) : 0;
        $iCol = (!isset($aVisibleNames[$iCol])) ? 0 : $iCol;

        return $iCol;
    }


    protected function _getColNames($sId = null)
    {
        if ($sId === null) {
            $sId = oxRegistry::getConfig()->getRequestParameter('cmpid');
        }

        if ($sId && isset($this->_aColumns[$sId])) {
            return $this->_aColumns[$sId];
        }

        return $this->_aColumns;
    }

    protected function _getIdentColNames()
    {
        $aColNames = $this->_getColNames();
        $aCols = array();
        foreach ($aColNames as $iKey => $aCol) {
            // ident ?
            if ($aCol[4]) {
                $aCols[$iKey] = $aCol;
            }
        }

        return $aCols;
    }

    protected function _getVisibleColNames()
    {
        $aColNames = $this->_getColNames();
        $aUserCols = oxRegistry::getConfig()->getRequestParameter('aCols');
        $aVisibleCols = array();

        // user defined some cols to load ?
        if (is_array($aUserCols)) {
            foreach ($aUserCols as $iKey => $sCol) {
                $iCol = ( int ) str_replace('_', '', $sCol);
                if (isset($aColNames[$iCol]) && !$aColNames[$iCol][4]) {
                    $aVisibleCols[$iCol] = $aColNames[$iCol];
                }
            }
        }

        // no user defined valid cols ? setting defauls ..
        if (!count($aVisibleCols)) {
            foreach ($aColNames as $sName => $aCol) {
                // visible ?
                if ($aCol[1] && !$aColNames[$sName][4]) {
                    $aVisibleCols[$sName] = $aCol;
                }
            }
        }

        return $aVisibleCols;
    }

    protected function _getQueryCols()
    {
        $sQ = $this->_buildColsQuery($this->_getVisibleColNames(), false) . ", ";
        $sQ .= $this->_buildColsQuery($this->_getIdentColNames());

        return " $sQ ";
    }

    protected function _buildColsQuery($aIdentCols, $blIdentCols = true)
    {
        $sQ = '';
        foreach ($aIdentCols as $iCnt => $aCol) {
            if ($sQ) {
                $sQ .= ', ';
            }

            $sViewTable = $this->_getViewName($aCol[1]);
            if (!$blIdentCols && $this->_isExtendedColumn($aCol[0])) {
                $sQ .= $this->_getExtendedColQuery($sViewTable, $aCol[0], $iCnt);
            } else {
                $sQ .= $sViewTable . '.' . $aCol[0] . ' as _' . $iCnt;
            }
        }

        return $sQ;
    }

    protected function _isExtendedColumn($sColumn)
    {
        $blBuild = false;
        $blVariantsSelectionParameter = oxRegistry::getConfig()->getConfigParam('blVariantsSelection');
        if ($this->_blAllowExtColumns && $blVariantsSelectionParameter && $sColumn == 'oxtitle') {
            $blBuild = true;
        }

        return $blBuild;
    }

    protected function _getExtendedColQuery($sViewTable, $sColumn, $iCnt)
    {
        // multilanguage
        $sVarSelect = "$sViewTable.oxvarselect";

        $sSql = " IF( {$sViewTable}.{$sColumn} != '', {$sViewTable}.{$sColumn}, CONCAT((select oxart.{$sColumn} " .
                "from {$sViewTable} as oxart " .
                "where oxart.oxid = {$sViewTable}.oxparentid),', ',{$sVarSelect})) as _{$iCnt}";

        return $sSql;
    }

    protected function _getSorting()
    {
        return ' order by _' . $this->_getSortCol() . ' ' . $this->_getSortDir() . ' ';
    }

    protected function _getLimit($iStart)
    {
        $iLimit = (int) oxRegistry::getConfig()->getRequestParameter("results");
        $iLimit = $iLimit ? $iLimit : $this->_iSqlLimit;

        return " limit $iStart, $iLimit ";
    }

    protected function _getFilter()
    {
        $sQ = '';
        $oConfig = $this->getConfig();
        $aFilter = $oConfig->getRequestParameter('aFilter');
        if (is_array($aFilter) && count($aFilter)) {
            $aCols = $this->_getVisibleColNames();
            $oDb = oxDb::getDb();
            $oLang = oxRegistry::getLang();
            $oStr = getStr();

            $blIsUtf = $oConfig->isUtf();
            $sCharset = $oLang->translateString("charset");

            foreach ($aFilter as $sCol => $sValue) {

                // skipping empty filters
                if ($sValue === '') {
                    continue;
                }

                $iCol = (int) str_replace('_', '', $sCol);
                if (isset($aCols[$iCol])) {
                    if ($sQ) {
                        $sQ .= ' and ';
                    }

                    if (!$blIsUtf) {
                        $sValue = iconv('UTF-8', $sCharset, $sValue);
                    }

                    // escaping special characters
                    $sValue = str_replace(array('%', '_'), array('\%', '\_'), $sValue);

                    // possibility to search in the middle ..
                    $sValue = $oStr->preg_replace('/^\*/', '%', $sValue);

                    $sQ .= $this->_getViewName($aCols[$iCol][1]) . '.' . $aCols[$iCol][0];
                    $sQ .= ' like ' . $oDb->Quote($sValue . '%') . ' ';
                }

            }
        }

        return $sQ;
    }

    protected function _addFilter($sQ)
    {
        if ($sQ && ($sFilter = $this->_getFilter())) {
            $sQ .= ((stristr($sQ, 'where') === false) ? 'where' : ' and ') . $sFilter;
        }

        return $sQ;
    }

    protected function _getAll($sQ)
    {
        $aReturn = array();
        $rs = oxDb::getDb()->execute($sQ);
        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {
                $aReturn[] = $rs->fields[0];
                $rs->moveNext();
            }
        }

        return $aReturn;
    }

    protected function _getSortDir()
    {
        $sDir = oxRegistry::getConfig()->getRequestParameter('dir');
        if (!in_array($sDir, $this->_aPosDir)) {
            $sDir = $this->_aPosDir[0];
        }

        return $sDir;
    }

    protected function _getStartIndex()
    {
        return (int) oxRegistry::getConfig()->getRequestParameter('startIndex');
    }

    protected function _getTotalCount($sQ)
    {
        // TODO: implement caching here

        // we can cache total count ...

        // $sCountCacheKey = md5( $sQ );

        return (int) oxDb::getDb()->getOne($sQ, false, false);
    }

    protected function _getDataFields($sQ)
    {
        return oxDb::getDb(oxDB::FETCH_MODE_ASSOC)->getArray($sQ, false, false);
    }

    protected function _outputResponse($aData)
    {
        if (!$this->getConfig()->isUtf()) {
            // TODO: improve this
            if (is_array($aData['records']) && ($iRecSize = count($aData['records']))) {
                $aKeys = array_keys(current($aData['records']));
                $iKeySize = count($aKeys);
                $sCharset = oxRegistry::getLang()->translateString("charset");
                for ($i = 0; $i < $iRecSize; $i++) {
                    for ($c = 0; $c < $iKeySize; $c++) {
                        $aData['records'][$i][$aKeys[$c]] =
                                                        iconv($sCharset, "UTF-8", $aData['records'][$i][$aKeys[$c]]);
                    }
                }
            }
        }

        $this->_output(json_encode($aData));
    }

    protected function _output($sOut)
    {
        echo $sOut;
    }

    protected function _getViewName($sTable)
    {
        return getViewName($sTable, oxRegistry::getConfig()->getRequestParameter('editlanguage'));
    }

    protected function _getData($sCountQ, $sQ)
    {
        $sQ = $this->_addFilter($sQ);
        $sCountQ = $this->_addFilter($sCountQ);

        $aResponse['startIndex'] = $iStart = $this->_getStartIndex();
        $aResponse['sort'] = '_' . $this->_getSortCol();
        $aResponse['dir'] = $this->_getSortDir();

        $iDebug = $this->getConfig()->getConfigParam('iDebug');
        if ($iDebug) {
            $aResponse['countsql'] = $sCountQ;
        }

        $aResponse['records'] = array();

        // skip further execution if no records were found ...
        if (($iTotal = $this->_getTotalCount($sCountQ))) {
            $sQ .= $this->_getSorting();
            $sQ .= $this->_getLimit($iStart);

            if ($iDebug) {
                $aResponse['datasql'] = $sQ;
            }

            $aResponse['records'] = $this->_getDataFields($sQ);
        }

        $aResponse['totalRecords'] = $iTotal;

        return $aResponse;
    }

    public function resetArtSeoUrl($aArtIds, $aCatIds = null)
    {
        if (empty($aArtIds)) {
            return;
        }

        if (!is_array($aArtIds)) {
            $aArtIds = array($aArtIds);
        }

        $sShopId = $this->getConfig()->getShopId();
        foreach ($aArtIds as $sArtId) {
            oxRegistry::get("oxSeoEncoder")->markAsExpired($sArtId, $sShopId, 1, null, "oxtype='oxarticle'");
        }
    }

    public function resetContentCache()
    {
        $blDeleteCacheOnLogout = $this->getConfig()->getConfigParam('blClearCacheOnLogout');

        if (!$blDeleteCacheOnLogout) {

            oxRegistry::getUtils()->oxResetFileCache();
        }
    }

    public function resetCounter($sCounterType, $sValue = null)
    {
        $blDeleteCacheOnLogout = $this->getConfig()->getConfigParam('blClearCacheOnLogout');

        if (!$blDeleteCacheOnLogout) {
            $myUtilsCount = oxRegistry::get("oxUtilsCount");
            switch ($sCounterType) {
                case 'priceCatArticle':
                    $myUtilsCount->resetPriceCatArticleCount($sValue);
                    break;
                case 'catArticle':
                    $myUtilsCount->resetCatArticleCount($sValue);
                    break;
                case 'vendorArticle':
                    $myUtilsCount->resetVendorArticleCount($sValue);
                    break;
                case 'manufacturerArticle':
                    $myUtilsCount->resetManufacturerArticleCount($sValue);
                    break;
            }

            $this->_resetContentCache();
        }
    }

    protected function _resetContentCache()
    {
    }
}