Services/Search/classes/class.ilUserFilter.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
include_once 'Services/Search/classes/class.ilSearchResult.php';

class ilUserFilter
{
        var $limit = 0;
        var $limit_reached = false;


        var $search_fields = array('login' => true,
                                                           'firstname' => true,
                                                           'lastname' => true);

        var $enabled_member_filter = false;
        var $possible_users = array();

        // Default values for filter

        var $usr_id = null;
        var $db = null;

        function ilUserFilter($a_usr_id)
        {
                global $ilDB,$ilias;

                $this->usr_id = $a_usr_id;
                $this->db =& $ilDB;

                // Limit of filtered objects is search max hits
                $this->limit = $ilias->getSetting('search_max_hits',50);
                $this->result_obj = new ilSearchResult();

        }

        function enableField($key)
        {
                $this->search_fields[$key] = true;
        }
        function disableField($key)
        {
                $this->search_fields[$key] = true;
        }
        function enableMemberFilter($a_status)
        {
                $this->enabled_member_filter = $a_status;
        }

        function setPossibleUsers($a_users)
        {
                $this->possible_users = $a_users ? $a_users : array();
        }


        function getLimit()
        {
                return $this->limit;
        }

        function limitReached()
        {
                return $this->limit_reached;
        }

        function getUserId()
        {
                return $this->usr_id;
        }
        
        function storeQueryStrings($a_strings)
        {
                $_SESSION['search_usr_filter'] = $a_strings;
        }

        function getQueryString($a_field)
        {
                return isset($_SESSION['search_usr_filter'][$a_field]) ? $_SESSION['search_usr_filter'][$a_field] : '';
        }


        function getUsers()
        {
                // Check if a query string is given
                foreach($this->search_fields as $field => $enabled)
                {
                        if(!$enabled)
                        {
                                continue;
                        }
                        if(strlen($_SESSION['search_usr_filter'][$field]))
                        {
                                $search = true;
                                break;
                        }
                }
                if($search)
                {
                        return $this->__searchObjects();
                }
                else
                {
                        return $this->possible_users;
                }
        }


        function __searchObjects()
        {
                foreach($this->search_fields as $field => $enabled)
                {
                        // Disabled ?
                        if(!$enabled)
                        {
                                continue;
                        }

                        $query_string = $_SESSION['search_usr_filter'][$field];
                        if(!$query_string)
                        {
                                continue;
                        }
                        if(!is_object($query_parser = $this->__parseQueryString($query_string)))
                        {
                                sendInfo($query_parser);
                                return false;
                        }
                        $user_search =& ilObjectSearchFactory::_getUserSearchInstance($query_parser);
                        $user_search->setFields(array($field));
                        
                        // store entries
                        $this->__storeEntries($result_obj = $user_search->performSearch());
                }

                // no filter entries
                if(is_object($this->result_obj))
                {
                        if($this->enabled_member_filter)
                        {
                                $this->result_obj->addObserver($this,'memberFilter');
                        }
                        $this->result_obj->filter(ROOT_FOLDER_ID,QP_COMBINATION_OR);

                        return $this->__toArray($this->result_obj->getResults());
                }
                return array();
        }

        function &__parseQueryString($a_string)
        {
                include_once 'Services/Search/classes/class.ilQueryParser.php';

                $query_parser = new ilQueryParser(ilUtil::stripSlashes($a_string));
                $query_parser->setCombination(QP_COMBINATION_OR);
                $query_parser->setMinWordLength(1);
                $query_parser->parse();

                if(!$query_parser->validate())
                {
                        return $query_parser->getMessage();
                }
                return $query_parser;
        }


        function __storeEntries(&$new_res)
        {
                if($this->stored == false)
                {
                        $this->result_obj->mergeEntries($new_res);
                        $this->stored = true;
                        return true;
                }
                else
                {
                        $this->result_obj->intersectEntries($new_res);
                        return true;
                }
        }

        function __toArray($entries)
        {
                foreach($entries as $entry)
                {
                        $users[] = $entry['obj_id'];
                }
                return $users ? $users : array();
        }

        function memberFilter($a_usr_id,$entry_data)
        {
                return in_array($a_usr_id,$this->possible_users);
        }
}       
?>