una/template/scripts/BxBaseSearchResult.php

<?php defined('BX_DOL') or die('hack attempt');
/**
 * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
 * CC-BY License - http://creativecommons.org/licenses/by/3.0/
 *
 * @defgroup    DolphinCore Dolphin Core
 * @{
 */

// TODO: clean it more carefully !

bx_import('BxDolSearch');
class BxBaseSearchResult extends BxDolSearchResult {

    public $isError;

    protected $sBrowseUrl;
    protected $sUnitTemplate = 'unit.html';
    protected $sFilterName;

    protected $iDesignBoxTemplate = BX_DB_PADDING_DEF;
    protected $aPermalinks;
    protected $aConstants;

    function __construct($oFunctions = false) {
        parent::__construct();

        if ($oFunctions) {
            $this->oFunctions = $oFunctions;
        } else {
            bx_import('BxTemplFunctions');
            $this->oFunctions = BxTemplFunctions::getInstance();
        }
    }

    function getMain() {
        // override this to return main module class
    }

    function isPermalinkEnabled() {
       return isset($this->_isPermalinkEnabled) ? $this->_isPermalinkEnabled : ($this->_isPermalinkEnabled = (getParam($this->aPermalinks['param']) == 'on'));
    }

    function getCurrentUrl ($sType, $iId, $sUri, $aOwner = '') {
        $sLink = $this->aConstants['linksTempl'][$sType];
        $sLink = str_replace('{id}', $iId, $sLink);
        $sLink = str_replace('{uri}', $sUri, $sLink);
        if (is_array($aOwner) && !empty($aOwner)) {
            $sLink = str_replace('{ownerName}', $aOwner['ownerName'], $sLink); // TODO: urlencode
            $sLink = str_replace('{ownerId}', $aOwner['ownerId'], $sLink);
        }
        return BX_DOL_URL_ROOT . $sLink;
    }

    function displayResultBlock () {
        $sCode = '';
        $aData = $this->getSearchData();
        if ($this->aCurrent['paginate']['num'] > 0) {
            $sCode .= $this->addCustomParts();
            foreach ($aData as $aValue) {
                $sCode .= $this->displaySearchUnit($aValue);
            }
            $sCode = '<div class="bx-search-result-block">' . $sCode . '<div class="bx-clear"></div></div>';

        }
        return $sCode;
    }

    function displaySearchBox ($sCode, $sPaginate = '') {
        $aMenu = false;
        if (isset($this->aCurrent['rss']) && $this->aCurrent['rss']['link'])
            $aMenu = array(array('name' => 'rss', 'title' => _t('_sys_menu_title_rss'), 'link' => $this->aCurrent['rss']['link'] . (false === strpos($this->aCurrent['rss']['link'], '?') ? '?' : '&') . 'rss=1', 'icon' => 'rss'));

        $sTitle = _t($this->aCurrent['title']);

        $sCode = $this->oFunctions->designBoxContent($sTitle, $sCode . $sPaginate, $this->iDesignBoxTemplate, $aMenu);

        if (!isset($_GET['searchMode']))
            $sCode = '<div id="page_block_'.$this->id.'">'.$sCode.'<div class="clear_both"></div></div>';
        return $sCode;
    }

    function displaySearchUnit ($aData) {
        $oMain = $this->getMain();
        return $oMain->_oTemplate->unit($aData, $this->sUnitTemplate);
    }

    function _transformData ($aUnit, $sTempl, $sCssHeader = '') {
        foreach ($aUnit as $sKey => $sValue)
            $sTempl = str_replace('{'.$sKey.'}', $sValue, $sTempl);

        $sCssHeader = strlen($sCssHeader) > 0 ?  $sCssHeader : 'text_Unit';
        $sTempl =  str_replace('{unitClass}', $sCssHeader, $sTempl);
        return $sTempl;
    }

    function showAdminActionsPanel($sWrapperId, $aButtons, $sCheckboxName = 'entry', $bSelectAll = true, $bSelectAllChecked = false, $sCustomHtml = '') {
        $aBtns = array();
        foreach ($aButtons as $k => $v) {
            if(is_array($v)) {
                $aBtns[] = $v;
                continue;
            }
            $aBtns[] = array(
                'type' => 'submit',
                'name' => $k,
                'value' => '_' == $v[0] ? _t($v) : $v,
                'onclick' => '',
            );
        }
        $aUnit = array(
            'bx_repeat:buttons' => $aBtns,
            'bx_if:customHTML' => array(
                'condition' => strlen($sCustomHtml) > 0,
                'content' => array(
                    'custom_HTML' => $sCustomHtml,
                )
            ),
            'bx_if:selectAll' => array(
                'condition' => $bSelectAll,
                'content' => array(
                    'wrapperId' => $sWrapperId,
                    'checkboxName' => $sCheckboxName,
                    'checked' => ($bSelectAll && $bSelectAllChecked ? 'checked="checked"' : '')
                )
            ),
        );
        return BxDolTemplate::getInstance()->parseHtmlByName('adminActionsPanel.html', $aUnit, array('{','}'));
    }

    function showAdminFilterPanel($sFilterValue, $sInputId = 'filter_input_id', $sCheckboxId = 'filter_checkbox_id', $sFilterName = 'filter', $sOnApply = '') {

        $sFilter = _t('_sys_admin_filter');
        $sApply = _t('_sys_admin_apply');

        $sFilterValue = bx_html_attribute($sFilterValue);
        $isChecked = $sFilterValue ? ' checked="checked" ' : '';

        $sJsContent = "";
        if(empty($sOnApply)) {
            $sOnApply = 'on_filter_apply(this)';
            ob_start();
?>
    <script type="text/javascript">
        function on_filter_apply (e) {
            var s = ('' + document.location).replace (/[&]{0,1}<?=$sFilterName;?>=.*/, ''); // remove filter
            s = s.replace(/page=\d+/, 'page=1'); // goto 1st page
            if (e.checked && $('#<?=$sInputId;?>').val().length > 2)
                s += (-1 == s.indexOf('?') ? '?' : '&') + '<?=$sFilterName;?>=' + $('#<?=$sInputId;?>').val(); // append filter
            document.location = s;
        }
        function on_filter_key_up (e) {
            if (13 == e.keyCode) {
                $('#<?php echo $sCheckboxId; ?>').attr('checked', 'checked');
                on_filter_apply($('#<?php echo $sCheckboxId; ?>').get(0));
                return false;
            } else {
                $('#<?php echo $sCheckboxId; ?>').attr('checked', '');
                return true;
            }
        }
    </script>
<?
            $sJsContent = ob_get_clean();
        }

        return <<<EOF
    {$sJsContent}
    <div class="admin_filter_panel">
        <table>
            <tr>
                <td>{$sFilter}</td>
                <td>
                    <div class="input_wrapper input_wrapper_text">
                        <input type="text" id="{$sInputId}" value="{$sFilterValue}" class="form_input_text" onkeypress="return on_filter_key_up(event)" />
                        <div class="input_close input_close_text">&nbsp;</div>
                    </div>
                </td>
                <td><input type="checkbox" id="{$sCheckboxId}" $isChecked onclick="{$sOnApply}" /></td>
                <td><label for="{$sCheckboxId}">{$sApply}</label></td>
            </tr>
        </table>
    </div>
EOF;
    }

    function showPagination($bAdmin = false, $bChangePage = true, $bPageReload = true) {

        $oMain = $this->getMain();
        $oConfig = $oMain->_oConfig;
        bx_import('BxDolPaginate');
        $sUrlStart = BX_DOL_URL_ROOT . $oConfig->getBaseUri() . $this->sBrowseUrl;
        $sUrlStart .= (false === strpos($sUrlStart, '?') ? '?' : '&');

        bx_import('BxTemplPaginate');
        $oPaginate = new BxTemplPaginate(array(
            'page_url' => $sUrlStart . 'start={start}&per_page={per_page}' . (false !== bx_get($this->sFilterName) ? '&' . $this->sFilterName . '=' . bx_get($this->sFilterName) : ''),
            'num' => $this->aCurrent['paginate']['num'],
            'per_page' => $this->aCurrent['paginate']['perPage'],
            'start' => $this->aCurrent['paginate']['start'],
        ));

        return '<div class="clear_both"></div>'.$oPaginate->getPaginate();
    }

    function showPaginationAjax($sBlockId) {
        $oMain = $this->getMain();
        $oConfig = $oMain->_oConfig;
        bx_import('BxDolPaginate');
        $sUrlStart = BX_DOL_URL_ROOT . $oConfig->getBaseUri() . $this->sBrowseUrl;
        $sUrlStart .= (false === strpos($sUrlStart, '?') ? '?' : '&');

        $oPaginate = new BxDolPaginate(array(
            'page_url' => 'javascript:void(0);',
            'num' => $this->aCurrent['paginate']['num'],
            'per_page' => $this->aCurrent['paginate']['perPage'],
            'start' => $this->aCurrent['paginate']['start'],
        ));

        return $oPaginate->getSimplePaginate(false, -1, -1, false);
    }

    function getLinkAddByPrams ($aExclude = array()) {
        $aExclude[] = '_r';
        $aExclude[] = 'pageBlock';
        $aExclude[] = 'searchMode';
        $aExclude[] = 'section';
        $aExclude[] = 'keyword';
        $aLinks = array();
        $aCurrParams = array();
        $aParams = array();

        foreach ($this->aCurrent['restriction'] as $sKey => $aValue) {
            if (isset($aValue['paramName'])) {
                if (is_array($aValue['value']))
                    $aCurrParams[$aValue['paramName']] = $aValue['value'];
                elseif (mb_strlen($aValue['value']) > 0)
                    $aCurrParams[$aValue['paramName']] = $aValue['value'];
            }
        }

        // add get params
        $aExclude = array_merge($aExclude, array('page', 'per_page'));
        $aParams = array_merge($_GET, $aCurrParams);
        $aLinks['params'] = bx_encode_url_params ($_GET, $aExclude);

        //paginate
        $aLinks['paginate'] = '&start={start}';
        $aLinks['paginate'] .= '&per_page={per_page}';
        return $aLinks;
    }

    function clearFilters ($aPassParams = array(), $aPassJoins = array()) {
        //clear sorting
        $this->aCurrent['sorting'] = 'last';
        //clear restrictions
        foreach ($this->aCurrent['restriction'] as $sKey => $aValue) {
            if (!in_array($sKey, $aPassParams))
                $this->aCurrent['restriction'][$sKey]['value'] = '';
        }
        //clear unnecessary joins (remains only profile join)
        $aPassJoins[] = 'profile';
        $aTemp = array();
        foreach ($aPassJoins as $sValue) {
            if (isset($this->aCurrent['join'][$sValue]) && is_array($this->aCurrent['join'][$sValue]))
                $aTemp[$sValue] = $this->aCurrent['join'][$sValue];
        }
        $this->aCurrent['join'] = $aTemp;
    }

    function fillFilters ($aParams) {
        // transform all given values to fields values
        if (is_array($aParams)) {
            foreach ($aParams as $sKey => $mixedValue) {
                if (isset($this->aCurrent['restriction'][$sKey]))
                    $this->aCurrent['restriction'][$sKey]['value'] = $mixedValue;
            }
        }
    }

    function getTopMenu ($aExclude = array()) {

    }

    function getBottomMenu ($sAllLinkType = 'browseAll', $iId = 0, $sUri = '', $aExclude = array()) {
        if (strpos($sAllLinkType, 'http') === false) {
            if (isset($this->aConstants['linksTempl'][$sAllLinkType]))
                $sAllUrl = $this->getCurrentUrl($sAllLinkType, $iId, $sUri);
            else
                $sAllUrl = $this->getCurrentUrl('browseAll', 0, '');
        }
        else
            $sAllUrl = $sAllLinkType;
        $sModeName = $this->aCurrent['name'] . '_mode';
        $sMode = isset($_GET[$sModeName]) ? '&' . $sModeName . '=' . rawurlencode($_GET[$sModeName]) : $sModeName . '=' . $this->aCurrent['sorting'];
        $aLinkAddon = $this->getLinkAddByPrams($aExclude);
        $sLink = bx_html_attribute($_SERVER['PHP_SELF']);
        bx_import('BxDolPaginate');
        $oPaginate = new BxDolPaginate(array(
            'page_url' => $this->getCurrentUrl($sAllUrl, 0, ''),
            'num' => $this->aCurrent['paginate']['num'],
            'per_page' => $this->aCurrent['paginate']['perPage'],
            'start' => $this->aCurrent['paginate']['start'],
        ));
        return $oPaginate->getSimplePaginate($sAllUrl);
    }

    function getBrowseBlock ($aParams, $aCustom = array(), $sMainUrl = '', $bClearJoins = true) {
        $aJoins = $bClearJoins ? array('albumsObjects', 'albums') : array_keys($this->aCurrent['join']);
        $this->clearFilters(array('activeStatus', 'albumType', 'album_status', 'ownerStatus'), $aJoins);
        $this->addCustomParts();
        $aCustomTmpl = array(
            'enable_center' => true,
            'unit_css_class' => ' > div:not(.clear_both)',
            'start' => 0,
            'per_page' => 10,
            'sorting' => 'last',
            'simple_paginate' => true,
            'dynamic_paginate' => true,
            'menu_top' => false,
            'menu_bottom' => true,
            'menu_bottom_type' => 'browseAll',
            'menu_bottom_param'=> ''
        );
        $aCustom = array_merge($aCustomTmpl, $aCustom);
        $this->aCurrent['paginate']['perPage'] = (int)$aCustom['per_page'];
        $this->aCurrent['paginate']['start'] = (int)$aCustom['start'] > 0 ? $aCustom['start'] : 0;
        $this->aCurrent['sorting'] = $aCustom['sorting'];
        foreach ($aParams as $sKey => $mixedValues) {
            if (isset($this->aCurrent['restriction'][$sKey]))
                $this->aCurrent['restriction'][$sKey]['value'] = $mixedValues;
        }
        $aList = $this->getSearchData();
        $bWrap = true;
        if ($this->aCurrent['paginate']['num'] > 0) {
            $bWrap = false;
            foreach ($aList as $aData)
                $sCode .= $this->displaySearchUnit($aData);
            if ($aCustom['enable_center'])
                $sCode = $GLOBALS['oFunctions']->centerContent($sCode, $aCustom['unit_css_class']);
            if (mb_strlen($aCustom['wrapper_class']) > 0)
                $sCode = '<div class="' . $aCustom['wrapper_class'] . '">' . $sCode . '</div>';
            if ($aCustom['dynamic_paginate']) {
                $aExclude = array($this->aCurrent['name'] . '_mode', 'r');
                $aLinkAddon = $this->getLinkAddByPrams($aExclude);
                $sOnChange = 'return !loadDynamicBlock({id}, \'' . $sMainUrl . $aLinkAddon['params'] . $aLinkAddon['paginate'] . '\');';
            }
        }
        $aMenuTop = $aCustom['menu_top'] ? $this->getTopMenu($aExclude): array();
        $sMenuBottom = $aCustom['menu_bottom'] ? $this->getBottomMenu($aCustom['menu_bottom_type'], 0, $this->aCurrent['restriction'][$aCustom['menu_bottom_param']]['value']): array();
        return array('code' => $sCode, 'menu_top'=> $aMenuTop, 'menu_bottom' => $sMenuBottom, 'wrapper' => $bWrap);
    }

    function serviceGetBrowseBlock ($aParams, $sMainUrl = '', $aCustom = array()) {
        $aCode = $this->getBrowseBlock($aParams, $aCustom, $sMainUrl);
        return $aCode['code'] . $aCode['menu_bottom'];
    }

    /*
     * Get number of all elements under specified search criterias
     * @param array $aFilter - search criteria like 'restriction key'=>'rest. value'
     * @param array $aJoin - list of joins elements from $this->aCurrent['join'] field which shouldn't be cleared,
       if empty then all current joins will be left
     * @return integer number of found elements
     */
    function serviceGetAllCount ($aFilter, $aJoin = array()) {
        if (is_array($aFilter)) {
            // collect all current joins, but clear almost all search values
            if (!is_array($aJoin) || empty($aJoin))
                $aCurrJoins = array_keys($this->aCurrent['join']);
            else
                $aCurrJoins = $aJoin;
            $this->clearFilters(array('activeStatus'), $aCurrJoins);
            foreach ($aFilter as $sKey => $mixedValue) {
                if (isset($this->aCurrent['restriction'][$sKey]))
                    $this->aCurrent['restriction'][$sKey]['value'] = $mixedValue;
            }
            return $this->getCount();
        }
    }

    /**
     * Set design box template id to use to wrap search results to
     */
    function setDesignBoxTemplateId ($i) {
        $this->iDesignBoxTemplate = $i;
    }
}

/** @} */