ilLuceneQueryInputGUI Class Reference

Lucene query input form gui. More...

Inheritance diagram for ilLuceneQueryInputGUI:

Collaboration diagram for ilLuceneQueryInputGUI:

Public Member Functions
	__construct ($a_title, $a_postvar)
	Constructor.
	checkInput ()
	Check input, strip slashes etc.
Public Member Functions inherited from ilTextInputGUI
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	setValidationFailureMessage ($a_msg)
	Set message string for validation failure.
	getValidationFailureMessage ()
	setValidationRegexp ($a_value)
	Set validation regexp.
	getValidationRegexp ()
	Get validation regexp.
	setMaxLength ($a_maxlength)
	Set Max Length.
	getMaxLength ()
	Get Max Length.
	setSize ($a_size)
	Set Size.
	setInlineStyle ($a_style)
	Set inline style.
	getInlineStyle ()
	Get inline style.
	setCssClass ($a_class)
	getCssClass ()
	setValueByArray ($a_values)
	Set value by array.
	getSize ()
	Get Size.
	setSuffix ($a_value)
	Set suffix.
	getSuffix ()
	Get suffix.
	setInputType ($a_type)
	set input type
	getInputType ()
	get input type
	setSubmitFormOnEnter ($a_val)
	Set submit form on enter.
	getSubmitFormOnEnter ()
	Get submit form on enter.
	getDataSource ()
	get datasource link for YUI autocomplete
	setDataSource ($href)
	set datasource link for YUI autocomplete
	getDataSourceSchema ()
	get datasource schema for YUI autocomplete
	setDataSourceSchema ($ds)
	set datasource schema for YUI autocomplete
	getDataSourceResultFormat ()
	get data result format callback for YUI autocomplete
	setDataSourceResultFormat ($callback)
	set data result format callback for YUI autocomplete
	setDataSourceDelimiter ($ar)
	set data delimiter array
	getDataSourceDelimiter ()
	get data delimiter array
	insert (&$a_tpl)
	Insert property html.
	getTableFilterHTML ()
	Get HTML for table filter.
	getToolbarHTML ()
	Get HTML for toolbar.
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem.
	getSubItems ()
	Get Subitems.
	checkSubItemsInput ()
	Check SubItems.
	getSubForm ()
	Get sub form html.
	getItemByPostVar ($a_post_var)
	Get item by post var.
Public Member Functions inherited from ilFormPropertyGUI
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)

Additional Inherited Members
Protected Member Functions inherited from ilTextInputGUI
	render ($a_mode="")
	Render item.
Protected Attributes inherited from ilTextInputGUI
	$value
	$maxlength = 200
	$size = 40
	$validationRegexp
	$validationFailureMessage = ''
	$suffix
	$style_css
	$css_class
	$yui_dataSource
	$yui_dataSchema
	$yui_formatCallback
	$yui_delimiterarray = array()
	$submit_form_on_enter = false

Detailed Description

Lucene query input form gui.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

ilLuceneQueryInputGUI::__construct	(		$a_title,
			$a_postvar
	)

Constructor.

Reimplemented from ilTextInputGUI.

Definition at line 39 of file class.ilLuceneQueryInputGUI.php.

        {
                parent::__construct($a_title,$a_postvar);
        }       

Member Function Documentation

ilLuceneQueryInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

Reimplemented from ilTextInputGUI.

Definition at line 44 of file class.ilLuceneQueryInputGUI.php.

References $_POST, $lng, $ok, $query, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\setAlert(), ilUtil\stripSlashes(), and ilLuceneQueryParser\validateQuery().

        {
                global $lng,$ilUser;
                
                $ok = parent::checkInput();
                
                $query = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                
                if(!$ok or !strlen($query))
                {
                        return false;
                }
                
                include_once './Services/Search/classes/Lucene/class.ilLuceneQueryParser.php';
                try {
                        ilLuceneQueryParser::validateQuery($query);
                        return true;
                }
                catch(ilLuceneQueryParserException $e)
                {
                        $this->setAlert($lng->txt($e->getMessage()));
                        return false;
                }
        }

Here is the call graph for this function:

---

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

• Services/Search/classes/Form/class.ilLuceneQueryInputGUI.php