ilBiblFieldFilterFormGUI Class Reference

Class ilBiblFieldFilterFormGUI. More...

Inheritance diagram for ilBiblFieldFilterFormGUI:

Collaboration diagram for ilBiblFieldFilterFormGUI:

Public Member Functions
	__construct (protected \ilBiblFieldFilterGUI $parent_gui, protected \ilBiblFieldFilterInterface $filter, protected \ilBiblFactoryFacade $facade)
	ilBiblFieldFilterFormGUI constructor. More...
	initForm ()
	fillForm ()
	saveObject ()
Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	executeCommand ()
	setTableWidth (string $a_width)
	getTableWidth ()
	setMode (string $a_mode)
	getMode ()
	setTitle (string $a_title)
	getTitle ()
	setTitleIcon (string $a_titleicon)
	getTitleIcon ()
	setDescription (string $a_val)
	getDescription ()
	setTopAnchor (string $a_val)
	getTopAnchor ()
	setShowTopButtons (bool $a_val)
	getShowTopButtons ()
	setForceTopButtons (bool $a_val)
	getForceTopButtons ()
	addItem ($a_item)
	removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)
	getItemByPostVar (string $a_post_var)
	setItems (array $a_items)
	getItems ()
	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...
	setDisableStandardMessage (bool $a_val)
	getDisableStandardMessage ()
	getHideLabels ()
	setHideLabels (bool $a_value=true)
	setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)
	setValuesByPost ()
	checkInput ()
	getInput (string $a_post_var, bool $ensureValidation=true)
	Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...
	addCommandButton (string $a_cmd, string $a_text, string $a_id="")
	getCommandButtons ()
	clearCommandButtons ()
	getContent ()
	insertItem ( $item, bool $a_sub_item=false)
	addAsyncOnloadCode (string $code)
	getHTML ()
	getHTMLAsync ()
	getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	Get file upload data. More...
	hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
	Move upload to target directory. More...
Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)
	getFormAction ()
	setTarget (string $a_target)
	getTarget ()
	setMultipart (bool $a_multipart)
	getMultipart ()
	setId (string $a_id)
	getId ()
	setName (string $a_name)
	getName ()
	setKeepOpen (bool $a_keepopen)
	getKeepOpen ()
	setOpenTag (bool $a_open)
	getOpenTag ()
	setCloseTag (bool $a_val)
	getCloseTag ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	getHTML ()
	getContent ()

Data Fields
const	F_FIELD_ID = "field_id"
const	F_FILTER_TYPE = "filter_type"

Protected Member Functions
	fillObject ()
	initButtons ()
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()
	checkForRequiredField ()

Protected Attributes
int	$filter_id
Protected Attributes inherited from ilPropertyFormGUI
bool	$required_text = false
ilLanguage	$lng
ilCtrl	$ctrl
ilTemplate	$tpl
ilObjUser	$user = null
ilSetting	$settings = null
string	$mode = "std"
bool	$check_input_called = false
bool	$disable_standard_message = false
string	$top_anchor = "il_form_top"
string	$title = ''
string	$titleicon = ""
string	$description = ""
string	$tbl_width = ""
bool	$show_top_buttons = true
bool	$hide_labels = false
bool	$force_top_buttons = false
HTTP Services	$http
Refinery Factory	$refinery = null
ilGlobalTemplateInterface	$global_tpl = null
	$onload_code = []
Protected Attributes inherited from ilFormGUI
string	$formaction = ""
bool	$multipart = false
bool	$keepopen = false
bool	$opentag = true
string	$id = ''
string	$name = ''
string	$target = ''
bool	$prevent_double_submission = false

Detailed Description

Class ilBiblFieldFilterFormGUI.

Author

Benjamin Seglias bs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilBiblFieldFilterFormGUI::__construct	(	protected \ilBiblFieldFilterGUI	$parent_gui,
		protected \ilBiblFieldFilterInterface	$filter,
		protected \ilBiblFactoryFacade	$facade
	)

ilBiblFieldFilterFormGUI constructor.

Definition at line 37 of file class.ilBiblFieldFilterFormGUI.php.

References ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), ilBiblFieldFilterGUI\FILTER_ID, initForm(), and ILIAS\Repository\lng().

    {
        $this->filter_id = $this->filter->getId();

        $this->lng()->loadLanguageModule('bibl');
        $this->ctrl()->saveParameterByClass(ilBiblFieldFilterGUI::class, ilBiblFieldFilterGUI::FILTER_ID);

        parent::__construct();
        $this->initForm();
    }

Here is the call graph for this function:

Member Function Documentation

fillForm()

ilBiblFieldFilterFormGUI::fillForm

(

)

Definition at line 113 of file class.ilBiblFieldFilterFormGUI.php.

References ILIAS\Repository\filter(), and ilPropertyFormGUI\setValuesByArray().

                              : void
    {
        $array = [self::F_FIELD_ID => $this->filter->getFieldId(), self::F_FILTER_TYPE => $this->filter->getFilterType(),];
        $this->setValuesByArray($array);
    }

Here is the call graph for this function:

fillObject()

ilBiblFieldFilterFormGUI::fillObject ( )

protected

Definition at line 120 of file class.ilBiblFieldFilterFormGUI.php.

References ilPropertyFormGUI\checkInput(), ILIAS\Repository\filter(), and ilPropertyFormGUI\getInput().

Referenced by saveObject().

                                   : bool
    {
        if (!$this->checkInput()) {
            return false;
        }

        $this->filter->setFieldId($this->getInput(self::F_FIELD_ID));
        $this->filter->setFilterType($this->getInput(self::F_FILTER_TYPE));

        if ($this->filter->getId()) {
            $this->filter->update();
        } else {
            $this->filter->create();
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initButtons()

ilBiblFieldFilterFormGUI::initButtons ( )

protected

Definition at line 145 of file class.ilBiblFieldFilterFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ilBiblFieldFilterGUI\CMD_CANCEL, ilBiblFieldFilterGUI\CMD_CREATE, ilBiblFieldFilterGUI\CMD_UPDATE, ILIAS\Repository\filter(), and ILIAS\Repository\lng().

Referenced by initForm().

                                    : void
    {
        if ($this->filter->getId()) {
            $this->addCommandButton(ilBiblFieldFilterGUI::CMD_UPDATE, $this->lng()->txt('save'));
            $this->addCommandButton(ilBiblFieldFilterGUI::CMD_CANCEL, $this->lng()->txt("cancel"));
        } else {
            $this->addCommandButton(ilBiblFieldFilterGUI::CMD_CREATE, $this->lng()->txt('create'));
            $this->addCommandButton(ilBiblFieldFilterGUI::CMD_CANCEL, $this->lng()->txt("cancel"));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilBiblFieldFilterFormGUI::initForm

(

)

Definition at line 49 of file class.ilBiblFieldFilterFormGUI.php.

References ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ilBiblFieldFilterInterface\FILTER_TYPE_MULTI_SELECT_INPUT, ilBiblFieldFilterInterface\FILTER_TYPE_SELECT_INPUT, ilBiblFieldFilterInterface\FILTER_TYPE_TEXT_INPUT, initButtons(), ILIAS\Repository\lng(), null, ilFormGUI\setFormAction(), ilFormGUI\setTarget(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

                              : void
    {
        $this->setTarget('_top');

        $available_fields_for_object = $this->facade->fieldFactory()->getAvailableFieldsForObjId($this->facade->iliasObjId());
        if (null !== $this->filter_id && $this->filter_id > 0) {
            $edited_filter = $this->facade->filterFactory()->findById($this->filter_id);
        }

        $existing_fields_of_object = $this->facade->filterFactory()->getAllForObjectId($this->facade->iliasObjId());
        $existing_field_ids = [];
        foreach ($existing_fields_of_object as $existing_field) {
            $existing_field_ids[] = $existing_field->getFieldId();
        }

        //show only the fields as options which don't have already a filter
        $options = [];
        foreach ($available_fields_for_object as $available_field) {
            if (isset($edited_filter) && $edited_filter->getFieldId() === $available_field->getId()) {
                array_unshift($options, $available_field);
                continue;
            }
            if (!in_array($available_field->getId(), $existing_field_ids, false)) {
                $options[] = $available_field;
            }
        }

        $select_options = [];
        foreach ($options as $ilBiblField) {
            $select_options[$ilBiblField->getId()] = $this->facade->translationFactory()->translate($ilBiblField);
        }

        asort($select_options);
        $si = new ilSelectInputGUI($this->lng()->txt("field"), self::F_FIELD_ID);
        $si->setInfo($this->lng()->txt("filter_field_info"));
        $si->setOptions($select_options);
        $si->setRequired(true);
        $this->addItem($si);

        $options = [
            ilBiblFieldFilterInterface::FILTER_TYPE_TEXT_INPUT => $this->lng()->txt(
                "filter_type_" . ilBiblFieldFilterInterface::FILTER_TYPE_TEXT_INPUT
            ),
            ilBiblFieldFilterInterface::FILTER_TYPE_SELECT_INPUT => $this->lng()->txt(
                "filter_type_" . ilBiblFieldFilterInterface::FILTER_TYPE_SELECT_INPUT
            ),
            ilBiblFieldFilterInterface::FILTER_TYPE_MULTI_SELECT_INPUT => $this->lng()->txt(
                "filter_type_" . ilBiblFieldFilterInterface::FILTER_TYPE_MULTI_SELECT_INPUT
            ),
        ];
        $si = new ilSelectInputGUI($this->lng()->txt("filter_type"), self::F_FILTER_TYPE);
        $si->setInfo($this->lng()->txt("filter_type_info"));
        $si->setOptions($options);
        $si->setRequired(true);
        $this->addItem($si);

        $this->setTitle($this->lng()->txt('filter_form_title'));

        $this->initButtons();

        $this->setFormAction($this->ctrl->getFormAction($this->parent_gui));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

ilBiblFieldFilterFormGUI::saveObject

(

)

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

References fillObject().

                                : bool
    {
        return $this->fillObject();
    }

Here is the call graph for this function:

Field Documentation

$filter_id

int ilBiblFieldFilterFormGUI::$filter_id

protected

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

F_FIELD_ID

const ilBiblFieldFilterFormGUI::F_FIELD_ID = "field_id"

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

F_FILTER_TYPE

const ilBiblFieldFilterFormGUI::F_FILTER_TYPE = "filter_type"

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

---

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

• components/ILIAS/Bibliographic/classes/FieldFilter/class.ilBiblFieldFilterFormGUI.php