ilQueryParser Class Reference

Collaboration diagram for ilQueryParser:

Public Member Functions
	__construct ($a_query_str)
	Constructor @access public. More...
	setMinWordLength ($a_length, $a_force=false)
	getMinWordLength ()
	setGlobalMinLength ($a_value)
	getGlobalMinLength ()
	setAllowedWildcards ($a_value)
	getAllowedWildcards ()
	setMessage ($a_msg)
	getMessage ()
	appendMessage ($a_msg)
	setCombination ($a_combination)
	getCombination ()
	getQueryString ()
	getWords ()
	getQuotedWords ($with_quotation=false)
	getLuceneQueryString ()
	parse ()
	__parseQuotation ()
	validate ()

Data Fields
const	MIN_WORD_LENGTH = 3
	Minimum of characters required for search. More...
	$lng = null
	$min_word_length = 0
	$global_min_length = null
	$query_str
	$quoted_words = array()
	$message
	$combination

Protected Attributes
	$settings = null
	$wildcards_allowed

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilQueryParser::__construct

(

$a_query_str

)

Constructor @access public.

Definition at line 61 of file class.ilQueryParser.php.

        {
                global $lng;
 
                define('MIN_WORD_LENGTH',self::MIN_WORD_LENGTH);
 
                $this->lng = $lng;
 
                $this->query_str = $a_query_str;
                $this->message = '';
 
                include_once './Services/Search/classes/class.ilSearchSettings.php';
                $this->settings = ilSearchSettings::getInstance();
 
                if(!$this->setMinWordLength(1))
                {
                        $this->setMinWordLength(MIN_WORD_LENGTH);
                }
                
                $this->setAllowedWildcards(false);
        }

References $lng, ilSearchSettings\getInstance(), MIN_WORD_LENGTH, setAllowedWildcards(), setMinWordLength(), and settings().

Here is the call graph for this function:

Member Function Documentation

__parseQuotation()

ilQueryParser::__parseQuotation

(

)

Definition at line 246 of file class.ilQueryParser.php.

        {
                if(!strlen($this->getQueryString()))
                {
                        $this->quoted_words[] = '';
                        return false;
                }
                $query_str = $this->getQueryString();
                while(preg_match("/\".*?\"/",$query_str,$matches))
                {
                        $query_str = str_replace($matches[0],'',$query_str);
                        $this->quoted_words[] = ilUtil::prepareDBString($matches[0]);
                }
 
                // Parse the rest
                $words = explode(' ',trim($query_str));
                foreach($words as $word)
                {
                        if(!strlen(trim($word)))
                        {
                                continue;
                        }
                        
                        $this->quoted_words[] = ilUtil::prepareDBString($word);
                }
                                                
                if(!$this->getAllowedWildcards())
                {
                        // #14768
                        foreach($this->quoted_words as $idx => $word)
                        {                               
                                if(!stristr($word, '\\'))
                                {
                                        $word = str_replace('%', '\%', $word);
                                        $word = str_replace('_', '\_', $word);                                  
                                }               
                                $this->quoted_words[$idx] = $word;
                        }
                }
        }

References $query_str, getAllowedWildcards(), getQueryString(), and ilUtil\prepareDBString().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

appendMessage()

ilQueryParser::appendMessage

(

$a_msg

)

Definition at line 137 of file class.ilQueryParser.php.

        {
                if(strlen($this->getMessage()))
                {
                        $this->message .= '<br />';
                }
                $this->message .= $a_msg;
        }

References getMessage().

Here is the call graph for this function:

getAllowedWildcards()

ilQueryParser::getAllowedWildcards

(

)

Definition at line 124 of file class.ilQueryParser.php.

        {
                return $this->wildcards_allowed;
        }

References $wildcards_allowed.

Referenced by __parseQuotation(), and parse().

Here is the caller graph for this function:

getCombination()

ilQueryParser::getCombination

(

)

Definition at line 150 of file class.ilQueryParser.php.

        {
                return $this->combination;
        }

References $combination.

Referenced by getLuceneQueryString().

Here is the caller graph for this function:

getGlobalMinLength()

ilQueryParser::getGlobalMinLength

(

)

Definition at line 114 of file class.ilQueryParser.php.

        {
                return $this->global_min_length;
        }

References $global_min_length.

Referenced by validate().

Here is the caller graph for this function:

getLuceneQueryString()

ilQueryParser::getLuceneQueryString

(

)

Definition at line 180 of file class.ilQueryParser.php.

        {
                $counter = 0;
                $tmp_str = "";
                foreach($this->getQuotedWords(true) as $word) {
                        if($counter++)
                        {
                                $tmp_str .= (" ".strtoupper($this->getCombination())." ");
                        }
                        $tmp_str .= $word;
                }
                return $tmp_str;
        }

References $counter, getCombination(), and getQuotedWords().

Here is the call graph for this function:

getMessage()

ilQueryParser::getMessage

(

)

Definition at line 133 of file class.ilQueryParser.php.

        {
                return $this->message;
        }

References $message.

Referenced by appendMessage(), and validate().

Here is the caller graph for this function:

getMinWordLength()

ilQueryParser::getMinWordLength

(

)

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

        {
                return $this->min_word_length;
        }

References $min_word_length.

Referenced by parse(), and validate().

Here is the caller graph for this function:

getQueryString()

ilQueryParser::getQueryString

(

)

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

        {
                return trim($this->query_str);
        }

Referenced by __parseQuotation(), parse(), and validate().

Here is the caller graph for this function:

getQuotedWords()

ilQueryParser::getQuotedWords

(

$with_quotation = false

)

Definition at line 164 of file class.ilQueryParser.php.

        {
                if($with_quotation)
                {
                        return $this->quoted_words ? $this->quoted_words : array();
                }
                else
                {
                        foreach($this->quoted_words as $word)
                        {
                                $tmp_word[] = str_replace('\"','',$word);
                        }
                        return $tmp_word ? $tmp_word : array();
                }
        }

Referenced by getLuceneQueryString(), and ilAdvancedMDFieldDefinitionText\searchObjects().

Here is the caller graph for this function:

getWords()

ilQueryParser::getWords

(

)

Definition at line 159 of file class.ilQueryParser.php.

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

Referenced by validate().

Here is the caller graph for this function:

parse()

ilQueryParser::parse

(

)

Definition at line 193 of file class.ilQueryParser.php.

        {
                $this->words = array();
 
                #if(!strlen($this->getQueryString()))
                #{
                #       return false;
                #}
 
                $words = explode(' ',trim($this->getQueryString()));
                foreach($words as $word)
                {
                        if(!strlen(trim($word)))
                        {
                                continue;
                        }
                        
                        if(strlen(trim($word)) < $this->getMinWordLength())
                        {
                                $this->setMessage(sprintf($this->lng->txt('search_minimum_info'), $this->getMinWordLength()));
                                continue;
                        }
                        
                        $this->words[] = ilUtil::prepareDBString($word);
                }
                
                $fullstr = trim($this->getQueryString());
                if (!in_array($fullstr, $this->words))
                {
                        $this->words[] = ilUtil::prepareDBString($fullstr);
                }
                                
                if(!$this->getAllowedWildcards())
                {
                        // #14768
                        foreach($this->words as $idx => $word)
                        {                               
                                if(!stristr($word, '\\'))
                                {
                                        $word = str_replace('%', '\%', $word);
                                        $word = str_replace('_', '\_', $word);                                  
                                }               
                                $this->words[$idx] = $word;
                        }
                }
 
                // Parse strings like && 'A "B C D" E' as 'A' && 'B C D' && 'E'
                // Can be used in LIKE search or fulltext search > MYSQL 4.0
                $this->__parseQuotation();
                
                return true;
        }

References __parseQuotation(), getAllowedWildcards(), getMinWordLength(), getQueryString(), ilUtil\prepareDBString(), setMessage(), and sprintf.

Here is the call graph for this function:

setAllowedWildcards()

ilQueryParser::setAllowedWildcards

(

$a_value

)

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

        {
                $this->wildcards_allowed = (bool)$a_value;
        }

Referenced by __construct().

Here is the caller graph for this function:

setCombination()

ilQueryParser::setCombination

(

$a_combination

)

Definition at line 146 of file class.ilQueryParser.php.

        {
                $this->combination = $a_combination;
        }

setGlobalMinLength()

ilQueryParser::setGlobalMinLength

(

$a_value

)

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

        {
                if($a_value !== null)
                {
                        $a_value = (int)$a_value;
                        if($a_value < 1)
                        {
                                return;
                        }
                }
                $this->global_min_length = $a_value;
        }

setMessage()

ilQueryParser::setMessage

(

$a_msg

)

Definition at line 129 of file class.ilQueryParser.php.

        {
                $this->message = $a_msg;
        }

Referenced by parse(), and validate().

Here is the caller graph for this function:

setMinWordLength()

ilQueryParser::setMinWordLength	(		$a_length,
			$a_force = false
	)

Definition at line 83 of file class.ilQueryParser.php.

        {
                // Due to a bug in mysql fulltext search queries with min_word_legth < 3
                // might freeze the system.
                // Thus min_word_length cannot be set to values < 3 if the mysql fulltext is used.
                if(!$a_force and $this->settings->enabledIndex() and $a_length < 3)
                {
                        ilLoggerFactory::getLogger('src')->debug('Disabled min word length');
                        return false;                   
                }
                $this->min_word_length = $a_length;
                return true;
        }

References ilLoggerFactory\getLogger(), and settings().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

ilQueryParser::validate

(

)

Definition at line 287 of file class.ilQueryParser.php.

        {
                // Words with less than 3 characters
                if(strlen($this->getMessage()))
                {
                        return false;
                }
                // No search string given
                if($this->getMinWordLength() and !count($this->getWords()))
                {
                        $this->setMessage($this->lng->txt('msg_no_search_string'));
                        return false;
                }
                // No search string given
                if($this->getGlobalMinLength() and strlen(str_replace('"', '', $this->getQueryString())) < $this->getGlobalMinLength())
                {
                        $this->setMessage(sprintf($this->lng->txt('search_minimum_info'), $this->getGlobalMinLength()));
                        return false;
                }
 
                return true;
        }

References getGlobalMinLength(), getMessage(), getMinWordLength(), getQueryString(), getWords(), setMessage(), and sprintf.

Here is the call graph for this function:

Field Documentation

$combination

ilQueryParser::$combination

Definition at line 53 of file class.ilQueryParser.php.

Referenced by getCombination().

$global_min_length

ilQueryParser::$global_min_length = null

Definition at line 48 of file class.ilQueryParser.php.

Referenced by getGlobalMinLength().

$lng

ilQueryParser::$lng = null

Definition at line 45 of file class.ilQueryParser.php.

Referenced by __construct().

$message

ilQueryParser::$message

Definition at line 52 of file class.ilQueryParser.php.

Referenced by getMessage().

$min_word_length

ilQueryParser::$min_word_length = 0

Definition at line 47 of file class.ilQueryParser.php.

Referenced by getMinWordLength().

$query_str

ilQueryParser::$query_str

Definition at line 50 of file class.ilQueryParser.php.

Referenced by __parseQuotation().

$quoted_words

ilQueryParser::$quoted_words = array()

Definition at line 51 of file class.ilQueryParser.php.

$settings

ilQueryParser::$settings = null

protected

Definition at line 54 of file class.ilQueryParser.php.

$wildcards_allowed

ilQueryParser::$wildcards_allowed

protected

Definition at line 55 of file class.ilQueryParser.php.

Referenced by getAllowedWildcards().

MIN_WORD_LENGTH

const ilQueryParser::MIN_WORD_LENGTH = 3

Minimum of characters required for search.

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

Referenced by __construct().

---

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

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