oxadminlist.php

Go to the documentation of this file.

<?php

class oxAdminList extends oxAdminView
{

    protected $_sListClass = null;

    protected $_sListType = 'oxlist';

    protected $_oList = null;

    protected $_iCurrListPos = 0;

    protected $_iListSize = 0;

    protected $_aWhere = null;

    protected $_blDesc = false;

    protected $_blEmployMultilanguage = null;

    protected $_iOverPos = null;

    protected $_iViewListSize = 0;

    protected $_iDefViewListSize = 50;

    protected $_aCurrSorting = null;

    protected $_sDefSortField = null;

    protected $_aListFilter = null;

    public function getListSorting()
    {
        if ($this->_aCurrSorting === null) {
            $this->_aCurrSorting = oxRegistry::getConfig()->getRequestParameter('sort');

            if (!$this->_aCurrSorting && $this->_sDefSortField && ($oBaseObject = $this->getItemListBaseObject())) {
                $this->_aCurrSorting[$oBaseObject->getCoreTableName()] = array($this->_sDefSortField => "asc");
            }
        }

        return $this->_aCurrSorting;
    }

    public function getListFilter()
    {
        if ($this->_aListFilter === null) {
            $this->_aListFilter = oxRegistry::getConfig()->getRequestParameter("where");
        }

        return $this->_aListFilter;
    }

    protected function _getViewListSize()
    {
        if (!$this->_iViewListSize) {
            $myConfig = $this->getConfig();
            if ($aProfile = oxRegistry::getSession()->getVariable('profile')) {
                if (isset($aProfile[1])) {
                    $myConfig->setConfigParam('iAdminListSize', (int) $aProfile[1]);
                }
            }

            $this->_iViewListSize = (int) $myConfig->getConfigParam('iAdminListSize');
            if (!$this->_iViewListSize) {
                $this->_iViewListSize = 10;
                $myConfig->setConfigParam('iAdminListSize', $this->_iViewListSize);
            }
        }

        return $this->_iViewListSize;
    }

    public function getViewListSize()
    {
        return $this->_getViewListSize();
    }

    protected function _getUserDefListSize()
    {
        if (!$this->_iViewListSize) {
            if (!($iViewListSize = (int) oxRegistry::getConfig()->getRequestParameter('viewListSize'))) {
                $iViewListSize = $this->_iDefViewListSize;
            }
            $this->_iViewListSize = $iViewListSize;
        }

        return $this->_iViewListSize;
    }

    public function render()
    {
        $sReturn = parent::render();

        // assign our list
        $this->_aViewData['mylist'] = $this->getItemList();

        // set navigation parameters
        $this->_setListNavigationParams();

        return $sReturn;
    }

    public function deleteEntry()
    {
        $oDelete = oxNew($this->_sListClass);


        $blDelete = $oDelete->delete($this->getEditObjectId());

        // #A - we must reset object ID
        if ($blDelete && isset($_POST['oxid'])) {
            $_POST['oxid'] = -1;
        }


        $this->init();
    }

    protected function _calcListItemsCount($sSql)
    {
        $oStr = getStr();

        // count SQL
        $sSql = $oStr->preg_replace('/select .* from/i', 'select count(*) from ', $sSql);

        // removing order by
        $sSql = $oStr->preg_replace('/order by .*$/i', '', $sSql);

        // con of list items which fits current search conditions
        $this->_iListSize = oxDb::getDb()->getOne($sSql, false, false);

        // set it into session that other frames know about size of DB
        oxRegistry::getSession()->setVariable('iArtCnt', $this->_iListSize);
    }

    protected function _setCurrentListPosition($sPage = null)
    {
        $iAdminListSize = $this->_getViewListSize();

        $iJumpTo = $sPage ? ((int) $sPage) : ((int) ((int) oxRegistry::getConfig()->getRequestParameter('lstrt')) / $iAdminListSize);
        $iJumpTo = ($sPage && $iJumpTo) ? ($iJumpTo - 1) : $iJumpTo;

        $iJumpTo = $iJumpTo * $iAdminListSize;
        if ($iJumpTo < 1) {
            $iJumpTo = 0;
        } elseif ($iJumpTo >= $this->_iListSize) {
            $iJumpTo = floor($this->_iListSize / $iAdminListSize - 1) * $iAdminListSize;
        }

        $this->_iCurrListPos = $this->_iOverPos = (int) $iJumpTo;
    }

    protected function _prepareOrderByQuery($sSql = null)
    {
        // sorting
        $aSortFields = $this->getListSorting();

        if (is_array($aSortFields) && count($aSortFields)) {

            // only add order by at full sql not for count(*)
            $sSql .= ' order by ';
            $blSep = false;

            $oListItem = $this->getItemListBaseObject();
            $iLangId = $oListItem->isMultilang() ? $oListItem->getLanguage() : oxRegistry::getLang()->getBaseLanguage();

            $blSortDesc = oxRegistry::getConfig()->getRequestParameter('adminorder');
            $blSortDesc = $blSortDesc !== null ? (bool) $blSortDesc : $this->_blDesc;

            foreach ($aSortFields as $sTable => $aFieldData) {

                $sTable = $sTable ? (getViewName($sTable, $iLangId) . '.') : '';
                foreach ($aFieldData as $sColumn => $sSortDir) {

                    $sField = $sTable . $sColumn;

                    //add table name to column name if no table name found attached to column name
                    $sSql .= ((($blSep) ? ', ' : '')) . oxDb::getInstance()->escapeString($sField);

                    //V oxActive field search always DESC
                    if ($blSortDesc || $sColumn == "oxactive" || strcasecmp($sSortDir, 'desc') == 0) {
                        $sSql .= ' desc ';
                    }

                    $blSep = true;
                }
            }
        }

        return $sSql;
    }

    protected function _buildSelectString($oListObject = null)
    {
        return $oListObject !== null ? $oListObject->buildSelectString(null) : "";
    }


    protected function _processFilter($sFieldValue)
    {
        $oStr = getStr();

        //removing % symbols
        $sFieldValue = $oStr->preg_replace("/^%|%$/", "", trim($sFieldValue));

        return $oStr->preg_replace("/\s+/", " ", $sFieldValue);
    }

    protected function _buildFilter($sVal, $blIsSearchValue)
    {
        if ($blIsSearchValue) {
            //is search string, using LIKE
            $sQ = " like " . oxDb::getDb()->quote('%' . $sVal . '%') . " ";
        } else {
            //not search string, values must be equal
            $sQ = " = " . oxDb::getDb()->quote($sVal) . " ";
        }

        return $sQ;
    }

    protected function _isSearchValue($sFieldValue)
    {
        //check if this is search string (contains % sign at beginning and end of string)
        $blIsSearchValue = false;
        $oStr = getStr();
        if ($oStr->preg_match('/^%/', $sFieldValue) && $oStr->preg_match('/%$/', $sFieldValue)) {
            $blIsSearchValue = true;
        }

        //removing % symbols
        return $blIsSearchValue;
    }

    protected function _prepareWhereQuery($aWhere, $sqlFull)
    {
        if (count($aWhere)) {
            $myUtilsString = oxRegistry::get("oxUtilsString");
            while (list($sFieldName, $sFieldValue) = each($aWhere)) {
                $sFieldValue = trim($sFieldValue);

                //check if this is search string (contains % sign at beginning and end of string)
                $blIsSearchValue = $this->_isSearchValue($sFieldValue);

                //removing % symbols
                $sFieldValue = $this->_processFilter($sFieldValue);

                if (strlen($sFieldValue)) {
                    $aVal = explode(' ', $sFieldValue);

                    //for each search field using AND action
                    $sSqlBoolAction = ' and (';

                    foreach ($aVal as $sVal) {
                        // trying to search spec chars in search value
                        // if found, add cleaned search value to search sql
                        $sUml = $myUtilsString->prepareStrForSearch($sVal);
                        if ($sUml) {
                            $sSqlBoolAction .= '(';
                        }

                        $sFieldName = oxDb::getInstance()->escapeString($sFieldName);
                        $sqlFull .= " {$sSqlBoolAction} {$sFieldName} ";

                        //for search in same field for different values using AND
                        $sSqlBoolAction = ' and ';

                        $sqlFull .= $this->_buildFilter($sVal, $blIsSearchValue);

                        if ($sUml) {
                            $sqlFull .= " or {$sFieldName} ";

                            $sqlFull .= $this->_buildFilter($sUml, $blIsSearchValue);
                            $sqlFull .= ')'; // end of OR section
                        }
                    }

                    // end for AND action
                    $sqlFull .= ' ) ';
                }
            }
        }

        return $sqlFull;
    }

    protected function _changeselect($sSql)
    {
        return $sSql;
    }


    public function buildWhere()
    {
        if ($this->_aWhere === null && ($oList = $this->getItemList())) {

            $this->_aWhere = array();
            $aFilter = $this->getListFilter();
            if (is_array($aFilter)) {

                $oListItem = $this->getItemListBaseObject();
                $iLangId = $oListItem->isMultilang() ? $oListItem->getLanguage() : oxRegistry::getLang()->getBaseLanguage();
                $sLocalDateFormat = $this->getConfig()->getConfigParam('sLocalDateFormat');

                foreach ($aFilter as $sTable => $aFilterData) {
                    foreach ($aFilterData as $sName => $sValue) {
                        if ($sValue || '0' === ( string ) $sValue) {

                            $sField = "{$sTable}__{$sName}";

                            // if no table name attached to field name, add it
                            $sName = $sTable ? getViewName($sTable, $iLangId) . ".{$sName}" : $sName;

                            // #M1260: if field is date
                            if ($sLocalDateFormat && $sLocalDateFormat != 'ISO' && isset($oListItem->$sField)) {
                                $sFldType = $oListItem->{$sField}->fldtype;
                                if ("datetime" == $sFldType || "date" == $sFldType) {
                                    $sValue = $this->_convertToDBDate($sValue, $sFldType);
                                }
                            }

                            $this->_aWhere[$sName] = "%{$sValue}%";
                        }
                    }
                }
            }
        }

        return $this->_aWhere;
    }

    protected function _convertToDBDate($sValue, $sFldType)
    {
        $oConvObject = new oxField();
        $oConvObject->setValue($sValue);
        if ($sFldType == "datetime") {
            if (strlen($sValue) == 10 || strlen($sValue) == 22 || (strlen($sValue) == 19 && !stripos($sValue, "m"))) {
                oxRegistry::get("oxUtilsDate")->convertDBDateTime($oConvObject, true);
            } else {
                if (strlen($sValue) > 10) {
                    return $this->_convertTime($sValue);
                } else {
                    return $this->_convertDate($sValue);
                }
            }
        } elseif ($sFldType == "date") {
            if (strlen($sValue) == 10) {
                oxRegistry::get("oxUtilsDate")->convertDBDate($oConvObject, true);
            } else {
                return $this->_convertDate($sValue);
            }
        }

        return $oConvObject->value;
    }

    protected function _convertDate($sDate)
    {
        // regexps to validate input
        $aDatePatterns = array("/^([0-9]{2})\.([0-9]{4})/" => "EUR2", // MM.YYYY
                               "/^([0-9]{2})\.([0-9]{2})/" => "EUR1", // DD.MM
                               "/^([0-9]{2})\/([0-9]{4})/" => "USA2", // MM.YYYY
                               "/^([0-9]{2})\/([0-9]{2})/" => "USA1" // DD.MM
        );

        // date/time formatting rules
        $aDFormats = array("EUR1" => array(2, 1),
                           "EUR2" => array(2, 1),
                           "USA1" => array(1, 2),
                           "USA2" => array(2, 1)
        );

        // looking for date field
        $aDateMatches = array();
        $oStr = getStr();
        foreach ($aDatePatterns as $sPattern => $sType) {
            if ($oStr->preg_match($sPattern, $sDate, $aDateMatches)) {
                $sDate = $aDateMatches[$aDFormats[$sType][0]] . "-" . $aDateMatches[$aDFormats[$sType][1]];
                break;
            }
        }

        return $sDate;
    }

    protected function _convertTime($sFullDate)
    {
        $sDate = substr($sFullDate, 0, 10);
        $oConvObject = new oxField();
        $oConvObject->setValue($sDate);
        oxRegistry::get("oxUtilsDate")->convertDBDate($oConvObject, true);
        $oStr = getStr();

        // looking for time field
        $sTime = substr($sFullDate, 11);
        if ($oStr->preg_match("/([0-9]{2}):([0-9]{2}) ([AP]{1}[M]{1})$/", $sTime, $aTimeMatches)) {
            if ($aTimeMatches[3] == "PM") {
                $iIntVal = (int) $aTimeMatches[1];
                if ($iIntVal < 13) {
                    $sTime = ($iIntVal + 12) . ":" . $aTimeMatches[2];
                }
            } else {
                $sTime = $aTimeMatches[1] . ":" . $aTimeMatches[2];
            }
        } elseif ($oStr->preg_match("/([0-9]{2}) ([AP]{1}[M]{1})$/", $sTime, $aTimeMatches)) {
            if ($aTimeMatches[2] == "PM") {
                $iIntVal = (int) $aTimeMatches[1];
                if ($iIntVal < 13) {
                    $sTime = ($iIntVal + 12);
                }
            } else {
                $sTime = $aTimeMatches[1];
            }
        } else {
            $sTime = str_replace(".", ":", $sTime);
        }

        return $oConvObject->value . " " . $sTime;
    }

    protected function _setListNavigationParams()
    {
        $myConfig = $this->getConfig();

        // list navigation
        $blShowNavigation = false;
        $iAdminListSize = $this->_getViewListSize();
        if ($this->_iListSize > $iAdminListSize) {
            // yes, we need to build the navigation object
            $pageNavigation = new stdClass();
            $pageNavigation->pages = round((($this->_iListSize - 1) / $iAdminListSize) + 0.5, 0);
            $pageNavigation->actpage = ($pageNavigation->actpage > $pageNavigation->pages) ? $pageNavigation->pages : round(($this->_iCurrListPos / $iAdminListSize) + 0.5, 0);
            $pageNavigation->lastlink = ($pageNavigation->pages - 1) * $iAdminListSize;
            $pageNavigation->nextlink = null;
            $pageNavigation->backlink = null;

            $iPos = $this->_iCurrListPos + $iAdminListSize;
            if ($iPos < $this->_iListSize) {
                $pageNavigation->nextlink = $iPos = $this->_iCurrListPos + $iAdminListSize;
            }

            if (($this->_iCurrListPos - $iAdminListSize) >= 0) {
                $pageNavigation->backlink = $iPos = $this->_iCurrListPos - $iAdminListSize;
            }

            // calculating list start position
            $iStart = $pageNavigation->actpage - 5;
            $iStart = ($iStart <= 0) ? 1 : $iStart;

            // calculating list end position
            $iEnd = $pageNavigation->actpage + 5;
            $iEnd = ($iEnd < $iStart + 10) ? $iStart + 10 : $iEnd;
            $iEnd = ($iEnd > $pageNavigation->pages) ? $pageNavigation->pages : $iEnd;

            // once again adjusting start pos ..
            $iStart = ($iEnd - 10 > 0) ? $iEnd - 10 : $iStart;
            $iStart = ($pageNavigation->pages <= 11) ? 1 : $iStart;

            // navigation urls
            for ($i = $iStart; $i <= $iEnd; $i++) {
                $page = new stdclass();
                $page->selected = 0;
                if ($i == $pageNavigation->actpage) {
                    $page->selected = 1;
                }
                $pageNavigation->changePage[$i] = $page;
            }

            $this->_aViewData['pagenavi'] = $pageNavigation;

            if (isset($this->_iOverPos)) {
                $iPos = $this->_iOverPos;
                $this->_iOverPos = null;
            } else {
                $iPos = oxRegistry::getConfig()->getRequestParameter('lstrt');
            }

            if (!$iPos) {
                $iPos = 0;
            }

            $this->_aViewData['lstrt'] = $iPos;
            $this->_aViewData['listsize'] = $this->_iListSize;
            $blShowNavigation = true;
        }

        // determine not used space in List
        $iShowListSize = $this->_iListSize - $this->_iCurrListPos;
        $iAdminListSize = $this->_getViewListSize();
        $iNotUsed = $iAdminListSize - min($iShowListSize, $iAdminListSize);
        $iSpace = $iNotUsed * 15;

        if (!$blShowNavigation) {
            $iSpace += 20;
        }

        $this->_aViewData['iListFillsize'] = $iSpace;
    }

    protected function _setupNavigation($sNode)
    {
        // navigation according to class
        if ($sNode) {

            $myAdminNavigation = $this->getNavigation();

            $sOxId = $this->getEditObjectId();

            if ($sOxId == -1) {
                //on first call or when pressed creating new item button, reseting active tab
                $iActTab = $this->_iDefEdit;
            } else {
                // active tab
                $iActTab = oxRegistry::getConfig()->getRequestParameter('actedit');
                $iActTab = $iActTab ? $iActTab : $this->_iDefEdit;
            }

            // tabs
            $this->_aViewData['editnavi'] = $myAdminNavigation->getTabs($sNode, $iActTab);

            // active tab
            $this->_aViewData['actlocation'] = $myAdminNavigation->getActiveTab($sNode, $iActTab);

            // default tab
            $this->_aViewData['default_edit'] = $myAdminNavigation->getActiveTab($sNode, $this->_iDefEdit);

            // assign active tab number
            $this->_aViewData['actedit'] = $iActTab;
        }
    }

    public function getItemList()
    {
        if ($this->_oList === null && $this->_sListClass) {

            $this->_oList = oxNew($this->_sListType);
            $this->_oList->clear();
            $this->_oList->init($this->_sListClass);

            $aWhere = $this->buildWhere();

            $oListObject = $this->_oList->getBaseObject();

            oxRegistry::getSession()->setVariable('tabelle', $this->_sListClass);
            $this->_aViewData['listTable'] = getViewName($oListObject->getCoreTableName());
            $this->getConfig()->setGlobalParameter('ListCoreTable', $oListObject->getCoreTableName());

            if ($oListObject->isMultilang()) {
                // is the object multilingual?
                $oListObject->setLanguage(oxRegistry::getLang()->getBaseLanguage());

                if (isset($this->_blEmployMultilanguage)) {
                    $oListObject->setEnableMultilang($this->_blEmployMultilanguage);
                }
            }

            $sSql = $this->_buildSelectString($oListObject);
            $sSql = $this->_prepareWhereQuery($aWhere, $sSql);
            $sSql = $this->_prepareOrderByQuery($sSql);
            $sSql = $this->_changeselect($sSql);

            // calculates count of list items
            $this->_calcListItemsCount($sSql);

            // setting current list position (page)
            $this->_setCurrentListPosition(oxRegistry::getConfig()->getRequestParameter('jumppage'));

            // setting addition params for list: current list size
            $this->_oList->setSqlLimit($this->_iCurrListPos, $this->_getViewListSize());

            $this->_oList->selectString($sSql);
        }

        return $this->_oList;
    }

    public function clearItemList()
    {
        $this->_oList = null;
    }

    public function getItemListBaseObject()
    {
        if (($oList = $this->getItemList())) {
            return $oList->getBaseObject();
        }
    }
}