ilLTIConsumerProviderSelectionFormTableGUI Class Reference

Inheritance diagram for ilLTIConsumerProviderSelectionFormTableGUI:

Collaboration diagram for ilLTIConsumerProviderSelectionFormTableGUI:

Public Member Functions
	__construct (string $newType, ilObjLTIConsumerGUI $parentGui, string $parentCmd, string $applyFilterCmd, string $resetFilterCmd)
	ilLTIConsumerProviderSelectionFormGUI constructor. More...
	setTitle (string $a_title)
	getTitle ()
	getHTML ()
	applyFilter ()
	resetFilter ()
	getFilter (string $a_field)
	setData (array $data)
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 ()

Protected Attributes
ilLTIConsumerProviderTableGUI	$table
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

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()

Detailed Description

Definition at line 29 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

Constructor & Destructor Documentation

__construct()

ilLTIConsumerProviderSelectionFormTableGUI::__construct	(	string	$newType,
		ilObjLTIConsumerGUI	$parentGui,
		string	$parentCmd,
		string	$applyFilterCmd,
		string	$resetFilterCmd
	)

ilLTIConsumerProviderSelectionFormGUI constructor.

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
        parent::__construct();
 
        $this->table = new ilLTIConsumerProviderTableGUI($parentGui, $parentCmd);
 
        $this->table->setFilterCommand($applyFilterCmd);
        $this->table->setResetCommand($resetFilterCmd);
 
        $this->table->setSelectProviderCmd('save');
        $this->table->setOwnProviderColumnEnabled(true);
 
        $this->table->setDefaultFilterVisiblity(true);
        $this->table->setDisableFilterHiding(true);
 
        $this->table->init();
 
        $this->setTitle($DIC->language()->txt($newType . '_select_provider'));
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and setTitle().

Here is the call graph for this function:

Member Function Documentation

applyFilter()

ilLTIConsumerProviderSelectionFormTableGUI::applyFilter

(

)

Definition at line 76 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

                                 : void
    {
        $this->table->writeFilterToSession();
        $this->table->resetOffset();
    }

getFilter()

ilLTIConsumerProviderSelectionFormTableGUI::getFilter

(

string

$a_field

)

Returns

string|bool

Definition at line 91 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

    {
        $field = $this->table->getFilterItemByPostVar($a_field);
 
        if ($field instanceof ilCheckboxInputGUI) {
            return $field->getChecked();
        }
 
        return $field->getValue();
    }

getHTML()

ilLTIConsumerProviderSelectionFormTableGUI::getHTML

(

)

Reimplemented from ilPropertyFormGUI.

Definition at line 71 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

                             : string
    {
        return $this->table->getHTML();
    }

getTitle()

ilLTIConsumerProviderSelectionFormTableGUI::getTitle

(

)

Reimplemented from ilPropertyFormGUI.

Definition at line 66 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

                              : string
    {
        return $this->table->getTitle();
    }

resetFilter()

ilLTIConsumerProviderSelectionFormTableGUI::resetFilter

(

)

Definition at line 82 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

                                 : void
    {
        $this->table->resetFilter();
        $this->table->resetOffset();
    }

setData()

ilLTIConsumerProviderSelectionFormTableGUI::setData

(

array

$data

)

Definition at line 102 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

                                        : void
    {
        $this->table->setData($data);
    }

References $data.

setTitle()

ilLTIConsumerProviderSelectionFormTableGUI::setTitle

(

string

$a_title

)

Reimplemented from ilPropertyFormGUI.

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

                                             : void
    {
        $this->table->setTitle($a_title);
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$table

ilLTIConsumerProviderTableGUI ilLTIConsumerProviderSelectionFormTableGUI::$table

protected

Definition at line 34 of file class.ilLTIConsumerProviderSelectionFormTableGUI.php.

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumerProviderSelectionFormTableGUI.php