ilMailQuickFilterInputGUI Class Reference

Inheritance diagram for ilMailQuickFilterInputGUI:

Collaboration diagram for ilMailQuickFilterInputGUI:

Public Member Functions
	checkInput ()
	render ($a_mode="")
Public Member Functions inherited from ilTextInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValue ($a_value)
	Set Value. More...
	getValue ()
	Get Value. More...
	setValidationFailureMessage ($a_msg)
	Set message string for validation failure. More...
	getValidationFailureMessage ()
	setValidationRegexp ($a_value)
	Set validation regexp. More...
	getValidationRegexp ()
	Get validation regexp. More...
	setMaxLength ($a_maxlength)
	Set Max Length. More...
	getMaxLength ()
	Get Max Length. More...
	setSize ($a_size)
	Set Size. More...
	setInlineStyle ($a_style)
	Set inline style. More...
	getInlineStyle ()
	Get inline style. More...
	setCssClass ($a_class)
	getCssClass ()
	setValueByArray ($a_values)
	Set value by array. More...
	getSize ()
	Get Size. More...
	setSuffix ($a_value)
	Set suffix. More...
	getSuffix ()
	Get suffix. More...
	setInputType ($a_type)
	set input type More...
	getInputType ()
	get input type More...
	setSubmitFormOnEnter ($a_val)
	Set submit form on enter. More...
	getSubmitFormOnEnter ()
	Get submit form on enter. More...
	checkInput ()
	Check input, strip slashes etc. More...
	getDataSource ()
	get datasource link for js autocomplete More...
	setDataSource ($href, $a_delimiter=null)
	set datasource link for js autocomplete More...
	setDataSourceSubmitOnSelection ($a_stat)
	getDataSourceSubmitOnSelection ()
	setDataSourceSubmitUrl ($a_url)
	getDataSourceSubmitUrl ()
	setMultiValues (array $a_values)
	insert ($a_tpl)
	Insert property html. More...
	getTableFilterHTML ()
	Get HTML for table filter. More...
	getToolbarHTML ()
	Get HTML for toolbar. More...
	setDisableHtmlAutoComplete ($autocomplete)
	isHtmlAutoCompleteDisabled ()
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...
	getSubItems ()
	Get Subitems. More...
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...
	checkSubItemsInput ()
	Check SubItems. More...
	getSubForm ()
	Get sub form html. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getType ()
	Get Type. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setPostVar ($a_postvar)
	Set Post Variable. More...
	getPostVar ()
	Get Post Variable. More...
	getFieldId ()
	Get Post Variable. More...
	setInfo ($a_info)
	Set Information Text. More...
	getInfo ()
	Get Information Text. More...
	setAlert ($a_alert)
	Set Alert Text. More...
	getAlert ()
	Get Alert Text. More...
	setRequired ($a_required)
	Set Required. More...
	getRequired ()
	Get Required. More...
	setDisabled ($a_disabled)
	Set Disabled. More...
	getDisabled ()
	Get Disabled. More...
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm ($a_parentform)
	Set Parent Form. More...
	getParentForm ()
	Get Parent Form. More...
	setParent ($a_val)
	Set Parent GUI object. More...
	getParent ()
	Get Parent GUI object. More...
	getSubForm ()
	Get sub form html. More...
	hideSubForm ()
	Sub form hidden on init? More...
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...
	getHiddenTitle ()
	Get hidden title. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
	serializeData ()
	serialize data More...
	unserializeData ($a_data)
	unserialize data More...
	writeToSession ()
	Write to session. More...
	clearFromSession ()
	Clear session value. More...
	readFromSession ()
	Read from session. More...
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...
	getMulti ()
	Get Multi. More...
	setMultiValues (array $a_values)
	Set multi values. More...
	getMultiValues ()
	Get multi values. More...
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...
	getFormLabelFor ()
	Get label "for" attribute value for form. More...
Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...
Protected Attributes inherited from ilTextInputGUI
	$value
	$maxlength = 200
	$size = 40
	$validationRegexp
	$validationFailureMessage = ''
	$suffix
	$style_css
	$css_class
	$ajax_datasource
	$ajax_datasource_delimiter
	$ajax_datasource_commit = false
	$ajax_datasource_commit_url
	$submit_form_on_enter = false
	$autocomplete_disabled = false
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$ctrl
	$lng
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 11 of file class.ilMailQuickFilterInputGUI.php.

Member Function Documentation

checkInput()

ilMailQuickFilterInputGUI::checkInput

(

)

Returns

bool

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

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

    {
        global $DIC;

        $ok = parent::checkInput();

        $query = ilUtil::stripSlashes($_POST[$this->getPostVar()]);

        if (!$ok) {
            return false;
        }

        include_once 'Services/Mail/classes/class.ilMailLuceneQueryParser.php';
        try {
            ilMailLuceneQueryParser::validateQuery($query);
            return true;
        } catch (Exception $e) {
            $this->setAlert($DIC->language()->txt($e->getMessage()));
            return false;
        }
    }

Here is the call graph for this function:

render()

ilMailQuickFilterInputGUI::render

(

$a_mode = ""

)

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

References $DIC, ilFormPropertyGUI\$postvar, $tpl, ilTextInputGUI\$value, ilTextInputGUI\getCssClass(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), ilTextInputGUI\getInlineStyle(), ilTextInputGUI\getInputType(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getMultiValues(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getSize(), ilTextInputGUI\getSubmitFormOnEnter(), ilTextInputGUI\getSuffix(), ilFormPropertyGUI\getTitle(), ilTextInputGUI\getValue(), and ilUtil\prepareFormOutput().

    {
        global $DIC;

        $tpl = new ilTemplate("tpl.prop_mail_quick_filter_input.html", true, true, "Services/Mail");
        if (strlen($this->getValue())) {
            $tpl->setCurrentBlock("prop_text_propval");
            $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
            $tpl->parseCurrentBlock();
        }
        if (strlen($this->getInlineStyle())) {
            $tpl->setCurrentBlock("stylecss");
            $tpl->setVariable("CSS_STYLE", ilUtil::prepareFormOutput($this->getInlineStyle()));
            $tpl->parseCurrentBlock();
        }
        if (strlen($this->getCssClass())) {
            $tpl->setCurrentBlock("classcss");
            $tpl->setVariable('CLASS_CSS', ilUtil::prepareFormOutput($this->getCssClass()));
            $tpl->parseCurrentBlock();
        }
        if ($this->getSubmitFormOnEnter()) {
            $tpl->touchBlock("submit_form_on_enter");
        }

        switch ($this->getInputType()) {
            case 'password':
                $tpl->setVariable('PROP_INPUT_TYPE', 'password');
                break;
            case 'hidden':
                $tpl->setVariable('PROP_INPUT_TYPE', 'hidden');
                break;
            case 'text':
            default:
                $tpl->setVariable('PROP_INPUT_TYPE', 'text');
        }
        $tpl->setVariable("ID", $this->getFieldId());
        $tpl->setVariable("ARIA_LABEL", $this->getTitle());
        $tpl->setVariable("SIZE", $this->getSize());
        if ($this->getMaxLength() != null) {
            $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
        }
        if (strlen($this->getSuffix())) {
            $tpl->setVariable("INPUT_SUFFIX", $this->getSuffix());
        }

        $postvar = $this->getPostVar();
        if ($this->getMulti() && substr($postvar, -2) != "[]") {
            $postvar .= "[]";
        }

        if ($this->getDisabled()) {
            if ($this->getMulti()) {
                $value = $this->getMultiValues();
                $hidden = "";
                if (is_array($value)) {
                    foreach ($value as $item) {
                        $hidden .= $this->getHiddenTag($postvar, $item);
                    }
                }
            } else {
                $hidden = $this->getHiddenTag($postvar, $this->getValue());
            }
            if ($hidden) {
                $tpl->setVariable("DISABLED", " disabled=\"disabled\"");
                $tpl->setVariable("HIDDEN_INPUT", $hidden);
            }
        } else {
            $tpl->setVariable("POST_VAR", $postvar);
        }

        if ($a_mode == "toolbar") {
            // block-inline hack, see: http://blog.mozilla.com/webdev/2009/02/20/cross-browser-inline-block/
            // -moz-inline-stack for FF2
            // zoom 1; *display:inline for IE6 & 7
            $tpl->setVariable("STYLE_PAR", 'display: -moz-inline-stack; display:inline-block; zoom: 1; *display:inline;');
        } else {
            $tpl->setVariable("STYLE_PAR", '');
        }

        if (is_array($this->sub_items) && $this->sub_items) {
            $tpl->setVariable("FIELD_ID", $this->getFieldId());
            $tpl->setVariable("TXT_PLACEHOLDER", $DIC->language()->txt('mail_filter_field_placeholder'));
            $tpl->setVariable("TXT_FILTER_MESSAGES_BY", $DIC->language()->txt('mail_filter_txt'));

            $subitem_html = '';
            foreach ($this->sub_items as $item) {
                $subitem_html .= $item->render('toolbar');
            }

            $tpl->setVariable('FIELD_SUBITEMS', $subitem_html);
        }

        return $tpl->get();
    }

Here is the call graph for this function:

---

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

• Services/Mail/classes/Form/class.ilMailQuickFilterInputGUI.php