ChWsbSearch.php

Go to the documentation of this file.

<?php
 
require_once(CH_DIRECTORY_PATH_INC . 'db.inc.php');
require_once(CH_DIRECTORY_PATH_INC . 'utils.inc.php');
require_once(CH_DIRECTORY_PATH_INC . 'design.inc.php');
ch_import('ChTemplVotingView');
 
class ChWsbSearch
{
    var $aClasses = array(); // array of all search classes
    var $aChoice  = array(); // array of current search classes which were choosen in search area
 
    function __construct ($aChoice = '')
    {
        $this->aClasses = $GLOBALS['MySQL']->fromCache('sys_objects_search', 'getAllWithKey',
           'SELECT `ID` as `id`,
                   `Title` as `title`,
                   `ClassName` as `class`,
                   `ClassPath` as `file`,
                   `ObjectName`
            FROM `sys_objects_search`', 'ObjectName'
        );
 
        if (is_array($aChoice) && !empty($aChoice)) {
            foreach ($aChoice as $sValue) {
                if (isset($this->aClasses[$sValue]))
                    $this->aChoice[$sValue] = $this->aClasses[$sValue];
            }
        } else {
            $this->aChoice = $this->aClasses;
        }
    }
 
    /*
     * create units for all classes and calling their processing methods
     */
 
    function response ()
    {
        foreach ($this->aChoice as $sKey => $aValue) {
            if (!class_exists($aValue['class'])) {
                $sClassPath = str_replace('{tmpl}', $GLOBALS['oSysTemplate']->getCode(), $aValue['file']);
                require_once(CH_DIRECTORY_PATH_ROOT . $sClassPath);
            }
            $oEx = new $aValue['class']();
            $oEx->id = $aValue['id'];
            $sCode .= $oEx->processing();
        }
        return $sCode;
    }
 
    function getEmptyResult ()
    {
        $sKey = _t('_Empty');
        return DesignBoxContent($sKey, MsgBox($sKey), 1);
    }
 
}
 
/*
 * Search class for processing search requests and displaying search results
 *
 * Allows present content from modules on search params or internal (via fields of class) conditions
 *
 * Example of usage (you can see example in any of default Dolhpin's modules):
 *
 * 1. Extends your own search class from this one (or from ChBaseSearchResult or ChBaseSearchResultSharedMedia classes)
 * 2. Set necessary fields of class (using as example ChFilesSearch):
    // main field of search class
 *  $this->aCurrent = array(
 *
        // name of module
        'name' => 'ch_files',
 
        // language key with name of module
        'title' => '_ch_files',
 
        // main content table
        'table' => 'ch_files_main',
 
        // array of all fields which can be choosen for select in result query
        'ownFields' => array('ID', 'Title', 'Uri', 'Desc', 'Date', 'Size', 'Ext', 'Views', 'Rate', 'RateCount', 'Type'),
 
        // array of fields which take a part in search by keyword (global search and related words only - in other cases leave it blank)
        'searchFields' => array('Title', 'Tags', 'Desc', 'Categories'),
 
        //array of join tables
            'type' - type of join
            'table' - join table
            'mainField' - field from main table for 'on' condition
            'onField' - field from joining table for 'on' condition
            'joinFields' - array of fields from joining table
        'join' => array(
            'profile' => array(
                'type' => 'left',
                'table' => 'Profiles',
                'mainField' => 'Owner',
                'onField' => 'ID',
                'joinFields' => array('NickName')
            ), ...
        ),
 
        // array of search parameters
                'value' - value of search parameter (can be number, string or array)
                'field' - field which will take value of search, may be lefy as blank then in search query will be pasted to WHERE conditon via operator AGAINST
                'operator' - operator between field and value (can be 'in', 'not in', '>', '<', 'against', 'like' and '=' by default),
                'paramName' - GET param which will keep 'value' for pagianation
        'restriction' => array(
            'activeStatus' => array('value'=>'approved', 'field'=>'Status', 'operator'=>'=', 'paramName' => 'status'),
            'albumType' => array('value'=>'', 'field'=>'Type', 'operator'=>'=', 'paramName'=>'albumType', 'table'=>'sys_albums'),
        ),
        // array of pagination
                'perPage' - units per page
                'page' - numer of current page
                'totalNum' - total number of found results
                'totalPages' - number of total pages with search results
        'paginate' => array('perPage' => 10, 'page' => 1, 'totalNum' => 10, 'totalPages' => 1),
        // sort mode - by default it was last (DESC by date)
        'sorting' => 'last',
 
        // mode of units presentation in search result, can be 'short' or 'full' view
        'view' => 'full',
 
        // field of id
        'ident' => 'ID',
 
        // rss feed array
        'rss' => array(
            'title' => '',
            'link' => '',
            'image' => '',
            'profile' => 0,
            'fields' => array (
                'Link' => '',
                'Title' => 'Title',
                'DateTimeUTS' => 'Date',
                'Desc' => 'Desc',
                'Photo' => '',
        ),
    ),
    );
 
    // array of fields renamings
    var $aPseud - filling in costructor by function _getPseud
 
    // unique identificator from `sys_objects_search` table
    var $id;
 
    // indicator of rate connection
    var $iRate
 
    // rate object field
    var $oRate;
 
    // indicator of connection parts in display search data (for function addCustomParts)
    var $bCustomParts;
 
 *
 * Memberships/ACL:
 * Doesn't depend on user's membership.
 *
 * Alerts:
 * no alerts available
 
 */
 
class ChWsbSearchResult
{
    var $aCurrent;
    var $aPseud;
    var $id;
 
    var $iRate = 1;
    var $oRate = null;
 
    var $bCustomParts = false;
 
    /*
     * constructor
     * filling identificator field
     */
 
    function __construct ()
    {
        if (isset($this->aPseud['id']))
            $this->aCurrent['ident'] = $this->aPseud['id'];
    }
 
    /*
     * Get html box of search results (usually used in grlobal search)
     * @return html code
     */
 
    function processing ()
    {
        $sCode = $this->displayResultBlock();
        if ($this->aCurrent['paginate']['totalNum'] > 0) {
            $sPaginate = $this->showPagination();
            $sCode = $this->displaySearchBox($sCode, $sPaginate);
        } else
            $sCode = '';
        return $sCode;
    }
 
    /*
     * Get html output of search result
     * @return html code
     */
 
    function displayResultBlock ()
    {
        $aData = $this->getSearchData();
        if (count($aData) > 0) {
            $sCode .= $this->addCustomParts();
            foreach ($aData as $iKey => $aValue) {
                $sCode .= $this->displaySearchUnit($aValue);
            }
        }
        return $sCode;
    }
 
    /*
     * Add different code before html output (usually redeclared)
     * no return result
     */
 
    function addCustomParts ()
    {
    }
 
    /*
     * Get array for rss output
     */
 
    function rss ()
    {
        if (!isset($this->aCurrent['rss']['fields']) || !isset($this->aCurrent['rss']['link']))
            return '';
 
        $aData = $this->getSearchData();
        $f = &$this->aCurrent['rss']['fields'];
        if ($aData) {
            foreach ($aData as $k => $a) {
                $aData[$k][$f['Link']] = $this->getRssUnitLink ($a);
 
                if(isset($f['Image']))
                    $aData[$k][$f['Image']] = $this->getRssUnitImage ($a, $f['Image']);
            }
        }
 
        require_once(CH_DIRECTORY_PATH_CLASSES . 'ChWsbRssFactory.php');
        $oRss = new ChWsbRssFactory();
        $oRss->SetRssHeader();
        return $oRss->GenRssByCustomData(
            $aData,
            $this->aCurrent['rss']['title'] ? $this->aCurrent['rss']['title'] : $this->aCurrent['title'],
            $this->aCurrent['rss']['link'],
            $this->aCurrent['rss']['fields'],
            isset($this->aCurrent['rss']['image']) ? $this->aCurrent['rss']['image'] : '',
            isset($this->aCurrent['rss']['profile']) ? $this->aCurrent['rss']['profile'] : 0
        );
    }
 
    /*
     * Return rss unit link (redeclared)
     */
 
    function getRssUnitLink (&$a)
    {
        // override this functions to return permalink to rss unit
    }
 
    function getRssUnitImage (&$a, $sField)
    {
        // override this functions to return image for rss unit
    }
 
    /*
     * Naming fields in query's body
     * @param string $sFieldName name of field
     * @param string $sTableName name of field's table
     * $param string $sOperator of field's calculation (like MAX)
     * @param boolean $bRenameMode indicator for renaming and unsetting fields from field of class $this->aPseud
     * return $sqlUnit sql code and unsetting elements from aPseud field
     */
 
    function setFieldUnit ($sFieldName, $sTableName, $sOperator = '', $bRenameMode = true)
    {
        if (strlen($sOperator) > 0) {
            $sqlUnit  = "$sOperator(`$sTableName`.`$sFieldName`)";
        } else
            $sqlUnit  = "`$sTableName`.`$sFieldName`";
 
        if (isset($this->aPseud) && $bRenameMode !== false) {
            $sKey = array_search($sFieldName, $this->aPseud);
            if ($sKey !== false) {
                $sqlUnit .= " as `$sKey`";
                unset($this->aPseud[$sKey]);
            }
        }
        return $sqlUnit . ', ';
    }
 
    /*
     * Get html code of of every search unit
     * @param array $aData array of every search unit
     * return html code
     */
 
    function displaySearchUnit ($aData)
    {
    }
 
    /*
     * Get html code of search box with search results
     * @param string $sCode html code of search results
     * $param $sPaginate html code of paginate
     * return html code
     */
 
    function displaySearchBox ($sCode, $sPaginate = '')
    {
    }
 
    /*
     * Get html code of pagination
     */
 
    function showPagination ($aParams = array())
    {
    }
 
    /*
     * Get array of data with search results
     * return array with data
     */
 
    function getSearchData ()
    {
        $this->aPseud = $this->_getPseud();
        $this->setConditionParams();
        if ($this->aCurrent['paginate']['totalNum'] > 0) {
            $aData = $this->getSearchDataByParams();
            return $aData;
        }
    }
 
    /*
     * Get array with code for sql elements
     * @param boolean #bREnameMode indicator of renmaing fields
     * return array with joinFields, ownFields, groupBy and join elements
     */
 
    function getJoins ($bRenameMode = true)
    {
        $aSql = array();
        // joinFields & join
        if (isset($this->aCurrent['join']) && is_array($this->aCurrent['join'])) {
            $aSql = array('join'=>'', 'ownFields'=>'', 'joinFields'=>'', 'groupBy'=>'');
            foreach ($this->aCurrent['join'] as $sKey => $aValue) {
                if (is_array($aValue['joinFields'])) {
                    foreach ($aValue['joinFields'] as $sValue) {
                        $aSql['joinFields'] .= $this->setFieldUnit($sValue, $aValue['table'], isset($aValue['operator']) ? $aValue['operator'] : null, $bRenameMode);
                    }
                }
                // group by
                if (isset($aValue['groupTable']))
                    $aSql['groupBy'] =  "GROUP BY `{$aValue['groupTable']}`.`{$aValue['groupField']}`, ";
                $sOn = isset($aValue['mainTable']) ? $aValue['mainTable'] : $this->aCurrent['table'];
                $aSql['join'] .= " {$aValue['type']} JOIN `{$aValue['table']}` ON `{$aValue['table']}`.`{$aValue['onField']}`=`$sOn`.`{$aValue['mainField']}`";
                $aSql['ownFields'] .= $this->setFieldUnit($aValue['mainField'], $sOn, '', $bRenameMode);
            }
            $aSql['joinFields'] = trim($aSql['joinFields'], ', ');
            $aSql['groupBy'] = trim($aSql['groupBy'], ', ');
        }
        return $aSql;
    }
 
    /*
     * Concat sql parts of query, run it and return result array
     * @param $aParams addon param
     * return $aData multivariate array
     */
 
    function getSearchDataByParams ($aParams = '')
    {
        $aSql = array('ownFields'=>'', 'joinFields'=>'', 'order'=>'');
 
        // searchFields
        foreach ($this->aCurrent['ownFields'] as $sValue) {
            $aSql['ownFields'] .= $this->setFieldUnit($sValue, $this->aCurrent['table']);
        }
        // joinFields & join
        $aJoins = $this->getJoins();
        if (!empty($aJoins)) {
            $aSql['ownFields'] .= $aJoins['ownFields'];
            $aSql['joinFields'] .= $aJoins['joinFields'];
            $aSql['join'] = $aJoins['join'];
            $aSql['groupBy'] = $aJoins['groupBy'];
        } else
            $aSql['ownFields'] = trim($aSql['ownFields'], ', ');
        // from
        $aSql['from'] = " FROM `{$this->aCurrent['table']}`";
 
        // where
        $aSql['where'] = $this->getRestriction();
 
        // limit
        $aSql['limit'] = $this->getLimit();
 
        // sorting
        $this->setSorting();
 
        $aSort = $this->getSorting($this->aCurrent['sorting']);
        foreach ($aSort as $sKey => $sValue)
            $aSql[$sKey] .= $sValue;
 
        // rate part
        $aRate = $this->getRatePart();
        if (is_array($aRate)) {
            foreach ($aRate as $sKey => $sValue)
               $aSql[$sKey] .= $sValue;
        }
 
        // execution
        $sqlQuery = "SELECT {$aSql['ownFields']} {$aSql['joinFields']} {$aSql['from']} {$aSql['join']} {$aSql['where']} {$aSql['groupBy']} {$aSql['order']} {$aSql['limit']}";
        //echoDbg($sqlQuery);
        $aRes = db_res_assoc_arr($sqlQuery);
        return $aRes;
    }
 
    /*
     * Set class fields condition params and paginate array
     */
 
    function setConditionParams()
    {
        $aWhere = array();
        $aWhere[] = '1';
 
        $sKeyword = ch_get('keyword');
        if ($sKeyword !== false)
            $this->aCurrent['restriction']['keyword'] = array(
                'value' => process_db_input($sKeyword, CH_TAGS_STRIP),
                'field' => '',
                'operator' => 'against'
            );
 
        if (isset($_GET['ownerName'])) {
            $sName = process_db_input($_GET['ownerName'], CH_TAGS_STRIP);
            $iUser = (int)db_value("SELECT `ID` FROM `Profiles` WHERE `NickName`='$sName'");
            $GLOBALS['oTopMenu']->setCurrentProfileID($iUser);
        } elseif (isset($_GET['userID']))
            $iUser = (int)$_GET['userID'];
 
        if (!empty($iUser))
            $this->aCurrent['restriction']['owner']['value'] = $iUser;
 
        $iTotalNum = $this->getCount();
        if ($iTotalNum > 0) {
            $this->aCurrent['paginate']['totalNum'] = $iTotalNum;
            $this->setPaginate();
            $this->aCurrent['paginate']['totalPages'] = ceil( $iTotalNum / $this->aCurrent['paginate']['perPage'] );
        } else {
           $this->aCurrent['paginate']['totalNum'] = 0;
           $this->aCurrent['paginate']['totalPages'] = 0;
        }
    }
 
    /*
    * Count all found elements
    * return number of all found records
    */
 
    function getCount ()
    {
        $aJoins = $this->getJoins(false);
        $sqlQuery =  "SELECT COUNT(*) FROM `{$this->aCurrent['table']}` {$aJoins['join']} " . $this->getRestriction() . " {$aJoins['groupBy']}";
        return (int)db_value($sqlQuery);
    }
 
    /*
     * Check restriction params and make condition part of query
     * return $sqlWhere sql code of query for WHERE part
     */
 
    function getRestriction ()
    {
        $sqlWhere = '';
        if (isset($this->aCurrent['restriction'])) {
            $aWhere[] = '1';
            foreach ($this->aCurrent['restriction'] as $sKey => $aValue) {
                $sqlCondition = '';
                if (isset($aValue['operator']) && !empty($aValue['value'])) {
                   $sFieldTable = isset($aValue['table']) ? $aValue['table'] : $this->aCurrent['table'];
                   $sqlCondition = "`{$sFieldTable}`.`{$aValue['field']}` ";
                   if (!isset($aValue['no_quote_value']))
                       $aValue['value'] = process_db_input($aValue['value'], CH_TAGS_STRIP);
                   switch ($aValue['operator']) {
                       case 'against':
                            $aCond = isset($aValue['field']) && strlen($aValue['field']) > 0 ? $aValue['field'] : $this->aCurrent['searchFields'];
                            $sqlCondition = !empty($aCond) ? $this->getSearchFieldsCond($aCond, $aValue['value']) : "";
                            break;
                       case 'like':
                            $sqlCondition .= "LIKE '%" . $aValue['value'] . "%'";
                            break;
                       case 'in':
                       case 'not in':
                            $sValuesString = $this->getMultiValues($aValue['value']);
                            $sqlCondition .= strtoupper($aValue['operator']) . '('.$sValuesString.')';
                            break;
                       default:
                               $sqlCondition .= $aValue['operator'] . (isset($aValue['no_quote_value']) && $aValue['no_quote_value'] ?  $aValue['value'] : "'" . $aValue['value'] . "'");
                       break;
                    }
                }
                if (strlen($sqlCondition) > 0)
                    $aWhere[] = $sqlCondition;
            }
            $sqlWhere .= "WHERE ". implode(' AND ', $aWhere);
        }
        return $sqlWhere;
    }
 
    /*
     * Get limit part of query
     * return $sqlFrom code for limit part pf query
     */
 
    function getLimit ()
    {
        if (isset($this->aCurrent['paginate'])) {
            $sqlFrom = ( $this->aCurrent['paginate']['page'] - 1 ) * $this->aCurrent['paginate']['perPage'];
            $sqlTo = $this->aCurrent['paginate']['perPage'];
            if ($sqlTo > 0)
                return 'LIMIT ' . $sqlFrom .', '.$sqlTo;
        }
    }
 
    /*
     * Set sorting field of class
     */
 
    function setSorting ()
    {
        $this->aCurrent['sorting'] = isset($_GET[$this->aCurrent['name'] . '_mode']) ? $_GET[$this->aCurrent['name'] . '_mode'] : $this->aCurrent['sorting'];
    }
 
    /*
     * Get sorting part of query according current sorting mode
     * @param string $sSortType sorting type
     * return array with sql elements order and ownFields
     */
    function getSorting ($sSortType = 'last')
    {
        $aOverride = $this->getAlterOrder();
        if (is_array($aOverride) && !empty($aOverride))
            return $aOverride;
 
        $aSql = array();
        switch ($sSortType) {
            case 'rand':
                $aSql['order'] = "ORDER BY RAND()";
                break;
            case 'top':
                $sHow = "DESC";
                $aSql['order'] = "ORDER BY `Rate` $sHow, `RateCount` $sHow, `date` $sHow";
                break;
            case 'score':
                if (is_array($this->aCurrent['restriction']['keyword'])) {
                    $aSql['order'] = "ORDER BY `score` DESC";
                    $aSql['ownFields'] .= $this->getSearchFieldsCond($this->aCurrent['searchFields'], $this->aCurrent['restriction']['keyword']['value'], 'score'). ', ';
                }
                break;
            case 'voteTime':
                $aSql['order'] = "ORDER BY `voteTime` DESC";
                break;
            case 'none':
                $aSql['order'] = "";
                break;
            default:
                $aSql['order'] = "ORDER BY `date` DESC";
        }
        return $aSql;
    }
 
    /*
     * Return own varaint for sorting (redeclare if necessary)
     * return array of sql elements
     */
 
    function getAlterOrder ()
    {
        return array();
    }
 
    /*
     * Set paginate fields of class according GET params 'page' and 'per_page'
     * forcePage is need for setting most important number of current page
     */
 
    function setPaginate ()
    {
        $this->aCurrent['paginate']['perPage'] = (isset($_GET['per_page']) && (int)$_GET['per_page'] != 0) ? (int)$_GET['per_page'] : $this->aCurrent['paginate']['perPage'];
        if (empty($this->aCurrent['paginate']['perPage']))
            $this->aCurrent['paginate']['perPage'] = 10;
 
        $this->aCurrent['paginate']['page'] = isset($this->aCurrent['paginate']['forcePage'])
            ? (int)$this->aCurrent['paginate']['forcePage']
            : (empty($_GET['page']) ? 1 : (int)$_GET['page']);
 
        if ($this->aCurrent['paginate']['page'] < 1)
            $this->aCurrent['paginate']['page'] = 1;
    }
 
    /*
     * Get sql where condition for search fields
     * @param array of search fields
     * @param string $sKeyword keyword value for search
     * @param string sPseud for setting new name for generated set of fields in query
     * return sql code of WHERE part in query
     */
 
    function getSearchFieldsCond ($aFields, $sKeyword, $sPseud = '')
    {
        if (strlen($sKeyword) > 0) {
           $bLike = getParam('useLikeOperator');
           $aSql = array(
              'function' => 'MATCH',
              'operator' => 'AGAINST',
              'word' => $sKeyword
           );
           if ($bLike == 'on') {
               $aSql = array(
                  'function' => 'CONCAT',
                  'operator' => 'LIKE',
                  'word' => '%' . preg_replace('/\s+/', '%', $sKeyword) . '%'
               );
           }
           $sqlWhere = " {$aSql['function']}(";
           if (is_array($aFields)) {
               foreach ($aFields as $sValue)
                    $sqlWhere .= "`{$this->aCurrent['table']}`.`$sValue`, ";
           } else
              $sqlWhere .= "`{$this->aCurrent['table']}`.`$aFields`";
           $sqlWhere = trim($sqlWhere, ', ') . ") {$aSql['operator']} ('{$aSql['word']}')";
 
           if (strlen($sPseud) > 0)
                   $sqlWhere .= " as `$sPseud`";
 
           return $sqlWhere;
        }
    }
 
    /*
     * Get set from several values for 'in' and 'not in' operators
     * @param $aVlues array of values
     * return sql code for field with operator IN (NOT IN)
     */
 
    function getMultiValues ($aValues)
    {
        $sqlPart = is_array($aValues) ? implode("','", $aValues) : $aValues;
        return "'".$sqlPart."'";
    }
 
    /*
     * Generate rate object if it wasn't created yet
     */
 
    function getRatePart ()
    {
        if ($this->iRate == 1)
           $this->oRate = new ChTemplVotingView($this->aCurrent['name'], 0, 0);
    }
 
    /*
     * Fill field aPseud for current class (if you will use own getSearchUnit methods then not necessary to redeclare)
     */
 
    // system method for filling aPseud array
    function _getPseud ()
    {
    }
}