ilBiblLibraryFormGUI Class Reference

Bibliographic Libraries Form. More...

Inheritance diagram for ilBiblLibraryFormGUI:

Collaboration diagram for ilBiblLibraryFormGUI:

Public Member Functions
	__construct (protected ilBiblLibraryInterface $object)
	ilBiblLibraryFormGUI constructor. More...
	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 ()

Private Member Functions
	initForm ()
	Init settings property form. More...
	fillForm ()

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()
	checkForRequiredField ()
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

Bibliographic Libraries Form.

Author

Theodor Truffer

Martin Studer ms@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 29 of file class.ilBiblLibraryFormGUI.php.

Constructor & Destructor Documentation

__construct()

ilBiblLibraryFormGUI::__construct

(

protected ilBiblLibraryInterface

$object

)

ilBiblLibraryFormGUI constructor.

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

    {
        $this->ctrl()->setParameterByClass(ilBiblLibraryGUI::class, ilBiblLibraryGUI::F_LIB_ID, $this->object->getId());
        $this->initForm();
 
        if ($this->object->getId()) {
            $this->fillForm();
        }
        parent::__construct();
    }

References ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ilBiblLibraryGUI\F_LIB_ID, fillForm(), initForm(), and ILIAS\Repository\object().

Here is the call graph for this function:

Member Function Documentation

fillForm()

ilBiblLibraryFormGUI::fillForm ( )

private

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

                               : void
    {
        $this->setValuesByArray([
            'name' => $this->object->getName(),
            'url' => $this->object->getUrl(),
            'img' => $this->object->getImg(),
            'show_in_list' => $this->object->isShownInList(),
        ]);
    }

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

Referenced by __construct(), and initForm().

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilBiblLibraryFormGUI::initForm ( )

private

Init settings property form.

@access private

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

                               : void
    {
        $this->setFormAction($this->ctrl()->getFormActionByClass(ilBiblLibraryGUI::class));
        $name = new ilTextInputGUI($this->lng()->txt("bibl_library_name"), 'name');
        $name->setRequired(true);
        $name->setValue('');
        $this->addItem($name);
        $url = new ilTextInputGUI($this->lng()->txt("bibl_library_url"), 'url');
        $url->setRequired(true);
        $url->setValue('');
        $this->addItem($url);
        $img = new ilTextInputGUI($this->lng()->txt("bibl_library_img"), 'img');
        $img->setValue('');
        $this->addItem($img);
        $show_in_list = new ilCheckboxInputGUI($this->lng()
            ->txt("bibl_library_show_in_list"), 'show_in_list');
        $show_in_list->setValue('1');
        $this->addItem($show_in_list);
        if ($this->object->getId()) {
            $this->addCommandButton('update', $this->lng()->txt('save'));
            $this->fillForm();
            $this->setTitle($this->lng()->txt("bibl_settings_edit"));
        } else {
            $this->setTitle($this->lng()->txt("bibl_settings_new"));
            $this->addCommandButton('create', $this->lng()->txt('save'));
        }
        $this->addCommandButton('cancel', $this->lng()->txt("cancel"));
    }

References ilFormGUI\$name, $url, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), fillForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

ilBiblLibraryFormGUI::saveObject

(

)

Definition at line 95 of file class.ilBiblLibraryFormGUI.php.

                                : bool
    {
        if (!$this->checkInput()) {
            return false;
        }
        $this->object->setName($this->getInput("name"));
        $this->object->setUrl($this->getInput("url"));
        $this->object->setImg($this->getInput("img"));
        $this->object->setShowInList((bool) $this->getInput("show_in_list"));
        $this->object->store();
 
        return true;
    }

References ilPropertyFormGUI\checkInput(), and ilPropertyFormGUI\getInput().

Here is the call graph for this function:

---

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

• components/ILIAS/Bibliographic/classes/Admin/Library/class.ilBiblLibraryFormGUI.php