ilSearch Class Reference

search More...

Collaboration diagram for ilSearch:

Public Member Functions
	__construct ($a_user_id=0, $a_read=false)
	Constructor public. More...
	setSearchString ($a_search_str)
	setCombination ($a_combination)
	setSearchFor ($a_search_for)
	setSearchIn ($a_search_in)
	setResult ($a_result)
	setSearchType ($a_type)
	setPerformUpdate ($a_value)
	setEmptySearch ($a_value)
	setMinWordLength ($a_min_word_length)
	getMinWordLength ()
	getUserId ()
	getSearchString ()
	getCombination ()
	getSearchFor ()
	getSearchIn ()
	getSearchInByType ($a_type)
	getResults ()
	getResultByType ($a_type)
	getSearchType ()
	getPerformUpdate ()
	getEmptySearch ()
	getNumberOfResults ()
	validate (&$message)
	performSearch ()
	__parseSearchString ()
	__updateDBResult ()
	__readDBResult ()
	__checkAccess ($a_results, $a_type)
	__validateResults ()
	__prepareWord ($a_word)

Data Fields
	$ilias
	$lng
	$rbacsystem
	$user_id
	$search_string
	$parsed_str
	$combination
	$min_word_length = 3
	$search_for
	$search_in
	$search_type
	$result
	$perform_update
	$read_db_result
	$allow_empty_search

Protected Member Functions
	performUserSearch ()
	perform a search for users More...
	performObjectSearch ($a_type)
	perform object search More...
	performRoleSearch ()
	initQueryParser ()
	init query parser More...

Protected Attributes
	$qp = null

Detailed Description

search

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id$

Definition at line 14 of file class.ilSearch.php.

Constructor & Destructor Documentation

__construct()

ilSearch::__construct	(		$a_user_id = 0,
			$a_read = false
	)

Constructor public.

Definition at line 43 of file class.ilSearch.php.

References $DIC, $ilias, $lng, $rbacsystem, setEmptySearch(), and setPerformUpdate().

    {
        global $DIC;

        $ilias = $DIC['ilias'];
        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        
        // Initiate variables
        $this->ilias = &$ilias;
        $this->lng = &$lng;
        $this->lng->loadLanguageModule("search");
        $this->rbacsystem = &$rbacsystem;
        $this->user_id = $a_user_id;

        $this->setPerformUpdate(true);
        $this->setEmptySearch(false);
        $this->read_db_result = $a_read;

        // READ OLD SEARCH RESULTS FROM DATABASE
        #$this->__readDBResult();
    }

Here is the call graph for this function:

Member Function Documentation

__checkAccess()

ilSearch::__checkAccess	(		$a_results,
			$a_type
	)

Definition at line 340 of file class.ilSearch.php.

References $DIC, and $result.

Referenced by __validateResults().

    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        if (is_array($a_results)) {
            foreach ($a_results as $result) {
                if ($ilAccess->checkAccess('read', '', $result['id'])) {
                    $checked_result[] = $result;
                    break;
                }
            }
        }
        return $checked_result ? $checked_result : array();
    }

Here is the caller graph for this function:

__parseSearchString()

ilSearch::__parseSearchString

(

)

Definition at line 242 of file class.ilSearch.php.

References __prepareWord(), getCombination(), and getSearchString().

    {
        $tmp_arr = explode(" ", $this->getSearchString());
        $this->parsed_str["and"] = $this->parsed_str["or"] = $this->parsed_str["not"] = array();
        
        foreach ($tmp_arr as $word) {
            #$word = trim($word);
            $word = $this->__prepareWord($word);
            if ($word) {
                if (substr($word, 0, 1) == '+') {
                    $this->parsed_str["all"][] = substr($word, 1);
                    $this->parsed_str["and"][] = substr($word, 1);
                    continue;
                }

                if (substr($word, 0, 1) == '-') {
                    // better parsed_str["allmost_all"] ;-)
                    #$this->parsed_str["all"][] = substr($word,1);
                    $this->parsed_str["not"][] = substr($word, 1);
                    continue;
                }

                if ($this->getCombination() == 'and') {
                    $this->parsed_str["all"][] = $word;
                    $this->parsed_str["and"][] = $word;
                    continue;
                }

                if ($this->getCombination() == 'or') {
                    $this->parsed_str["all"][] = $word;
                    $this->parsed_str["or"][] = $word;
                    continue;
                }
            }
        }
    }

Here is the call graph for this function:

__prepareWord()

ilSearch::__prepareWord

(

$a_word

)

Definition at line 428 of file class.ilSearch.php.

Referenced by __parseSearchString().

    {
        $word = trim($a_word);
        
        if (!preg_match('/\*/', $word)) {
            return '%' . $word . '%';
        }
        if (preg_match('/^\*/', $word)) {
            return str_replace('*', '%', $word);
        } else {
            return '% ' . str_replace('*', '%', $word);
        }
    }

Here is the caller graph for this function:

__readDBResult()

ilSearch::__readDBResult

(

)

Definition at line 306 of file class.ilSearch.php.

References $DIC, $ilDB, $query, $res, $row, __updateDBResult(), __validateResults(), ilDBConstants\FETCHMODE_OBJECT, getUserId(), and setResult().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->getUserId() != 0 and $this->getUserId() != ANONYMOUS_USER_ID and $this->read_db_result) {
            $query = "SELECT search_result FROM usr_search " .
                "WHERE usr_id = " . $ilDB->quote($this->getUserId(), 'integer');
            

            $res = $ilDB->query($query);
            if ($res->numRows()) {
                $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
                $this->setResult(unserialize(stripslashes($row->search_result)));
            } else {
                $this->setResult(array("usr" => array(),
                                       "grp" => array(),
                                       "lm" => array(),
                                       "dbk" => array()));
            }
        } else {
            $this->setResult(array("usr" => array(),
                                   "grp" => array(),
                                   "lm" => array(),
                                   "dbk" => array()));
        }

        $this->__validateResults();
        $this->__updateDBResult();
        return true;
    }

Here is the call graph for this function:

__updateDBResult()

ilSearch::__updateDBResult

(

)

Definition at line 279 of file class.ilSearch.php.

References $DIC, $ilDB, getResults(), and getUserId().

Referenced by __readDBResult(), and performSearch().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->getUserId() != 0 and $this->getUserId() != ANONYMOUS_USER_ID) {
            $ilDB->manipulate("DELETE FROM usr_search " .
                "WHERE usr_id = " . $ilDB->quote($this->getUserId(), 'integer') . " " .
                "AND search_type = 0 ");

            $ilDB->insert('usr_search', array(
                'usr_id' => array('integer',$this->getUserId()),
                'search_result' => array('clob',serialize($this->getResults())),
                'checked' => array('clob',serialize(array())),
                'failed' => array('clob',serialize(array())),
                'page' => array('integer',0),
                'search_type' => array('integer',0),
                'query' => array('text',''),
                'root' => array('integer',ROOT_FOLDER_ID)));

            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__validateResults()

ilSearch::__validateResults

(

)

Definition at line 358 of file class.ilSearch.php.

References $data, $DIC, $tree, $user, __checkAccess(), ilObjectFactory\getInstanceByObjId(), and setResult().

Referenced by __readDBResult(), and performSearch().

    {
        global $DIC;

        $tree = $DIC['tree'];

        $new_result = array();


        // check lm meta

        $this->result['lm']['meta'] = $this->__checkAccess($this->result['lm']['meta'], 'lm');
        if (is_array($this->result['lm']['meta'])) {
            foreach ($this->result['lm']['meta'] as $data) {
                if ($tree->isInTree($data['id'])) {
                    $new_result['lm']['meta'][] = $data;
                }
            }
        }
        $this->result['lm']['content'] = $this->__checkAccess($this->result['lm']['content'], 'lm');
        if (is_array($this->result['lm']['content'])) {
            foreach ($this->result['lm']['content'] as $data) {
                if ($tree->isInTree($data['id'])) {
                    $new_result['lm']['content'][] = $data;
                }
            }
        }
        $this->result['dbk']['meta'] = $this->__checkAccess($this->result['dbk']['meta'], 'dbk');
        if (is_array($this->result['dbk']['meta'])) {
            foreach ($this->result['dbk']['meta'] as $data) {
                if ($tree->isInTree($data['id'])) {
                    $new_result['dbk']['meta'][] = $data;
                }
            }
        }
        $this->result['dbk']['content'] = $this->__checkAccess($this->result['dbk']['content'], 'dbk');
        if (is_array($this->result['dbk']['content'])) {
            foreach ($this->result['dbk']['content'] as $data) {
                if ($tree->isInTree($data['id'])) {
                    $new_result['dbk']['content'][] = $data;
                }
            }
        }
        $this->result['grp'] = $this->__checkAccess($this->result['grp'], 'grp');
        if (is_array($this->result['grp'])) {
            foreach ($this->result['grp'] as $data) {
                if ($tree->isInTree($data['id'])) {
                    $new_result['grp'][] = $data;
                }
            }
        }
        if (is_array($this->result['usr'])) {
            foreach ($this->result['usr'] as $user) {
                if ($tmp_obj = &ilObjectFactory::getInstanceByObjId($user['id'], false)) {
                    $new_result['usr'][] = $user;
                }
            }
        }
        if (is_array($this->result['role'])) {
            foreach ($this->result['role'] as $user) {
                if ($tmp_obj = &ilObjectFactory::getInstanceByObjId($user['id'], false)) {
                    $new_result['role'][] = $user;
                }
            }
        }
        $this->setResult($new_result);

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCombination()

ilSearch::getCombination

(

)

Definition at line 119 of file class.ilSearch.php.

Referenced by __parseSearchString(), initQueryParser(), and performObjectSearch().

    {
        return $this->combination ? $this->combination : "or";
    }

Here is the caller graph for this function:

getEmptySearch()

ilSearch::getEmptySearch

(

)

Definition at line 155 of file class.ilSearch.php.

References $allow_empty_search.

    {
        return $this->allow_empty_search;
    }

getMinWordLength()

ilSearch::getMinWordLength

(

)

Definition at line 105 of file class.ilSearch.php.

References $min_word_length.

Referenced by initQueryParser().

    {
        return $this->min_word_length;
    }

Here is the caller graph for this function:

getNumberOfResults()

ilSearch::getNumberOfResults

(

)

Definition at line 162 of file class.ilSearch.php.

References getResultByType().

    {
        $number = count($this->getResultByType("usr")) + count($this->getResultByType("grp")) + count($this->getResultByType("role"));

        $tmp_res = $this->getResultByType("dbk");
        $number += count($tmp_res["meta"]) + count($tmp_res["content"]);

        $tmp_res = $this->getResultByType("lm");
        $number += count($tmp_res["meta"]) + count($tmp_res["content"]);
                    
        return $number;
    }

Here is the call graph for this function:

getPerformUpdate()

ilSearch::getPerformUpdate

(

)

Definition at line 151 of file class.ilSearch.php.

References $perform_update.

Referenced by performSearch().

    {
        return $this->perform_update;
    }

Here is the caller graph for this function:

getResultByType()

ilSearch::getResultByType

(

$a_type

)

Definition at line 143 of file class.ilSearch.php.

References $a_type.

Referenced by getNumberOfResults().

    {
        return $this->result[$a_type] ? $this->result[$a_type] : array();
    }

Here is the caller graph for this function:

getResults()

ilSearch::getResults

(

)

Definition at line 139 of file class.ilSearch.php.

Referenced by __updateDBResult().

    {
        return $this->result ? $this->result : array();
    }

Here is the caller graph for this function:

getSearchFor()

ilSearch::getSearchFor

(

)

Definition at line 123 of file class.ilSearch.php.

Referenced by performSearch().

    {
        return $this->search_for ? $this->search_for : array();
    }

Here is the caller graph for this function:

getSearchIn()

ilSearch::getSearchIn

(

)

Definition at line 127 of file class.ilSearch.php.

    {
        return $this->search_in ? $this->search_in : array();
    }

getSearchInByType()

ilSearch::getSearchInByType

(

$a_type

)

Definition at line 131 of file class.ilSearch.php.

References $a_type.

    {
        if ($a_type == 'lm' or $a_type == 'dbk') {
            return $this->search_in[$a_type];
        } else {
            return false;
        }
    }

getSearchString()

ilSearch::getSearchString

(

)

Definition at line 115 of file class.ilSearch.php.

References $search_string.

Referenced by __parseSearchString(), and initQueryParser().

    {
        return $this->search_string;
    }

Here is the caller graph for this function:

getSearchType()

ilSearch::getSearchType

(

)

Definition at line 147 of file class.ilSearch.php.

References $search_type.

    {
        return $this->search_type;
    }

getUserId()

ilSearch::getUserId

(

)

Definition at line 111 of file class.ilSearch.php.

References $user_id.

Referenced by __readDBResult(), __updateDBResult(), and performUserSearch().

    {
        return $this->user_id;
    }

Here is the caller graph for this function:

initQueryParser()

ilSearch::initQueryParser ( )

protected

init query parser

Returns

Definition at line 511 of file class.ilSearch.php.

References getCombination(), getMinWordLength(), getSearchString(), QP_COMBINATION_AND, and QP_COMBINATION_OR.

Referenced by performSearch(), and validate().

    {
        if ($this->qp) {
            return true;
        }
        
        $this->qp = new ilQueryParser($this->getSearchString());
        $this->qp->setCombination($this->getCombination() == 'and' ? QP_COMBINATION_AND : QP_COMBINATION_OR);
        $this->qp->setMinWordLength($this->getMinWordLength());
        $this->qp->parse();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performObjectSearch()

ilSearch::performObjectSearch (   $a_type )

protected

perform object search

Returns

Definition at line 472 of file class.ilSearch.php.

References $a_type, $id, $res, and getCombination().

Referenced by performSearch().

    {
        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $object_search = new ilLikeObjectSearch($this->qp);
        $object_search->setFilter(array($a_type));
        $res = $object_search->performSearch();
        $res->filter(ROOT_FOLDER_ID, $this->getCombination());
        
        $counter = 0;
        foreach ($res->getResultIds() as $id) {
            $objs[$counter++]['id'] = $id;
        }
        return $objs ? $objs : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performRoleSearch()

ilSearch::performRoleSearch ( )

protected

Parameters

Definition at line 492 of file class.ilSearch.php.

References $data, $id, and $res.

Referenced by performSearch().

    {
        // Perform like search
        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $object_search = new ilLikeObjectSearch($this->qp);
        $object_search->setFilter(array('role'));
        
        $res = $object_search->performSearch();
        foreach ($res->getEntries() as $id => $data) {
            $tmp['id'] = $id;
            $roles[] = $tmp;
        }
        return $roles ? $roles : array();
    }

Here is the caller graph for this function:

performSearch()

ilSearch::performSearch

(

)

Definition at line 186 of file class.ilSearch.php.

References $DIC, $ilBench, $result, __updateDBResult(), __validateResults(), getPerformUpdate(), getSearchFor(), initQueryParser(), performObjectSearch(), performRoleSearch(), performUserSearch(), and setResult().

    {
        global $DIC;

        $objDefinition = $DIC['objDefinition'];
        $ilBench = $DIC['ilBench'];

        $ilBench->start("Search", "performSearch");
        
        $this->initQueryParser();

        $result = array("usr" => array(),
                        "grp" => array(),
                        "lm" => array(),
                        "dbk" => array(),
                        "role" => array());

        foreach ($this->getSearchFor() as $obj_type) {
            switch ($obj_type) {
                case "usr":
                    $result['usr'] = $this->performUserSearch();
                    break;

                case "grp":
                    $result['grp'] = $this->performObjectSearch('grp');
                    break;

                case "lm":
                    $result['lm'] = $this->performObjectSearch('lm');
                    break;

                case "dbk":
                    $result['dbk'] = $this->performObjectSearch('dbk');
                    break;
                    
                case "role":
                    $result['role'] = $this->performRoleSearch();
                    break;
            }
        }

        $this->setResult($result);
        $this->__validateResults();

        if ($this->getPerformUpdate()) {
            $this->__updateDBResult();
        }

        $ilBench->stop("Search", "performSearch");

        return true;
    }

Here is the call graph for this function:

performUserSearch()

ilSearch::performUserSearch ( )

protected

perform a search for users

Returns

Definition at line 446 of file class.ilSearch.php.

References $data, $id, $res, $users, ilObjectSearchFactory\_getUserSearchInstance(), and getUserId().

Referenced by performSearch().

    {
        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
        
        $user_search = ilObjectSearchFactory::_getUserSearchInstance($this->qp);
        $res = new ilSearchResult($this->getUserId());
        
        foreach (array("login","firstname","lastname","title",
                "email","institution","street","city","zipcode","country","phone_home","fax") as $field) {
            $user_search->setFields(array($field));
            $tmp_res = $user_search->performSearch();
            
            $res->mergeEntries($tmp_res);
        }

        foreach ($res->getEntries() as $id => $data) {
            $tmp['id'] = $id;
            $users[] = $tmp;
        }
        return $users ? $users : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCombination()

ilSearch::setCombination

(

$a_combination

)

Definition at line 71 of file class.ilSearch.php.

    {
        // 'and' or 'or'
        $this->combination = $a_combination;
    }

setEmptySearch()

ilSearch::setEmptySearch

(

$a_value

)

Definition at line 96 of file class.ilSearch.php.

Referenced by __construct().

    {
        $this->allow_empty_search = $a_value;
    }

Here is the caller graph for this function:

setMinWordLength()

ilSearch::setMinWordLength

(

$a_min_word_length

)

Definition at line 101 of file class.ilSearch.php.

    {
        $this->min_word_length = $a_min_word_length;
    }

setPerformUpdate()

ilSearch::setPerformUpdate

(

$a_value

)

Definition at line 92 of file class.ilSearch.php.

Referenced by __construct().

    {
        $this->perform_update = $a_value;
    }

Here is the caller graph for this function:

setResult()

ilSearch::setResult

(

$a_result

)

Definition at line 84 of file class.ilSearch.php.

Referenced by __readDBResult(), __validateResults(), and performSearch().

    {
        $this->result = $a_result;
    }

Here is the caller graph for this function:

setSearchFor()

ilSearch::setSearchFor

(

$a_search_for

)

Definition at line 76 of file class.ilSearch.php.

    {
        $this->search_for = $a_search_for;
    }

setSearchIn()

ilSearch::setSearchIn

(

$a_search_in

)

Definition at line 80 of file class.ilSearch.php.

    {
        $this->search_in = $a_search_in;
    }

setSearchString()

ilSearch::setSearchString

(

$a_search_str

)

Definition at line 67 of file class.ilSearch.php.

    {
        $this->search_string = trim($a_search_str);
    }

setSearchType()

ilSearch::setSearchType

(

$a_type

)

Definition at line 88 of file class.ilSearch.php.

References $a_type.

    {
        $this->search_type = $a_type;
    }

validate()

ilSearch::validate

(

&

$message

)

Definition at line 175 of file class.ilSearch.php.

References $message, and initQueryParser().

    {
        $this->initQueryParser();
        
        if (!$this->qp->validate()) {
            $message = $this->qp->getMessage();
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$allow_empty_search

ilSearch::$allow_empty_search

Definition at line 38 of file class.ilSearch.php.

Referenced by getEmptySearch().

$combination

ilSearch::$combination

Definition at line 29 of file class.ilSearch.php.

$ilias

ilSearch::$ilias

Definition at line 23 of file class.ilSearch.php.

Referenced by __construct().

$lng

ilSearch::$lng

Definition at line 24 of file class.ilSearch.php.

Referenced by __construct().

$min_word_length

ilSearch::$min_word_length = 3

Definition at line 30 of file class.ilSearch.php.

Referenced by getMinWordLength().

$parsed_str

ilSearch::$parsed_str

Definition at line 28 of file class.ilSearch.php.

$perform_update

ilSearch::$perform_update

Definition at line 35 of file class.ilSearch.php.

Referenced by getPerformUpdate().

$qp

ilSearch::$qp = null

protected

Definition at line 16 of file class.ilSearch.php.

$rbacsystem

ilSearch::$rbacsystem

Definition at line 25 of file class.ilSearch.php.

Referenced by __construct().

$read_db_result

ilSearch::$read_db_result

Definition at line 36 of file class.ilSearch.php.

$result

ilSearch::$result

Definition at line 34 of file class.ilSearch.php.

Referenced by __checkAccess(), and performSearch().

$search_for

ilSearch::$search_for

Definition at line 31 of file class.ilSearch.php.

$search_in

ilSearch::$search_in

Definition at line 32 of file class.ilSearch.php.

$search_string

ilSearch::$search_string

Definition at line 27 of file class.ilSearch.php.

Referenced by getSearchString().

$search_type

ilSearch::$search_type

Definition at line 33 of file class.ilSearch.php.

Referenced by getSearchType().

$user_id

ilSearch::$user_id

Definition at line 26 of file class.ilSearch.php.

Referenced by getUserId().

---

The documentation for this class was generated from the following file:

• Services/Search/classes/class.ilSearch.php