ilAssMatchingPairCorrectionsInputGUI Class Reference

Inheritance diagram for ilAssMatchingPairCorrectionsInputGUI:

Collaboration diagram for ilAssMatchingPairCorrectionsInputGUI:

Public Member Functions
	getPairs ()
	setThumbsWebPathWithPrefix (string $path_including_prefix)
	setValue ($a_value)
	checkInput ()
	Check input, strip slashes etc. More...
	insert (ilTemplate $a_tpl)
	Insert property html. More...
Public Member Functions inherited from ilMatchingPairWizardInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValue ($a_value)
	setTerms ($a_terms)
	Set terms. More...
	setDefinitions ($a_definitions)
	Set definitions. More...
	setPairs ($a_pairs)
	Set pairs. More...
	setAllowMove ($a_allow_move)
	Set allow move. More...
	getAllowMove ()
	Get allow move. More...
	checkInput ()
	Check input, strip slashes etc. More...
	insert (ilTemplate $a_tpl)
	Insert property html. More...
Public Member Functions inherited from ilTextInputGUI
	__construct (string $a_title="", string $a_postvar="")
	setValue ($a_value)
	getValue ()
	setValidationFailureMessage (string $a_msg)
	getValidationFailureMessage ()
	setValidationRegexp (string $a_value)
	getValidationRegexp ()
	setMaxLength (?int $a_maxlength)
	getMaxLength ()
	setSize (int $a_size)
	setInlineStyle (string $a_style)
	getInlineStyle ()
	setCssClass (string $a_class)
	getCssClass ()
	setValueByArray (array $a_values)
	getSize ()
	setSuffix (string $a_value)
	getSuffix ()
	setInputType (string $a_type)
	set input type More...
	getInputType ()
	setSubmitFormOnEnter (bool $a_val)
	getSubmitFormOnEnter ()
	checkInput ()
	Check input, strip slashes etc. More...
	getInput ()
	getDataSource ()
	setDataSource (string $href, ?string $a_delimiter=null)
	setDataSourceSubmitOnSelection (bool $a_stat)
	getDataSourceSubmitOnSelection ()
	setDataSourceSubmitUrl (string $a_url)
	getDataSourceSubmitUrl ()
	setMultiValues (array $a_values)
	render (string $a_mode="")
	insert (ilTemplate $a_tpl)
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...
	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...
	setDisableHtmlAutoComplete (bool $autocomplete)
	isHtmlAutoCompleteDisabled ()
	getPostValueForComparison ()
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)
	getSubItems ()
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...
	checkSubItemsInput ()
	Check SubItems. More...
	getSubForm ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. More...
Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")
	executeCommand ()
	getType ()
	setTitle (string $a_title)
	getTitle ()
	setPostVar (string $a_postvar)
	getPostVar ()
	getFieldId ()
	setInfo (string $a_info)
	getInfo ()
	setAlert (string $a_alert)
	getAlert ()
	setRequired (bool $a_required)
	getRequired ()
	setDisabled (bool $a_disabled)
	getDisabled ()
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm (ilPropertyFormGUI $a_parentform)
	getParentForm ()
	setParent (ilFormPropertyGUI $a_val)
	getParent ()
	getSubForm ()
	hideSubForm ()
	setHiddenTitle (string $a_val)
	getHiddenTitle ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. More...
	serializeData ()
	unserializeData (string $a_data)
	setParentTable ($a_val)
	Set parent table. More...
	getParentTable ()
	Get parent table. More...
	writeToSession ()
	clearFromSession ()
	readFromSession ()
	getHiddenTag (string $a_post_var, string $a_value)
	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)
	getMulti ()
	setMultiValues (array $a_values)
	getMultiValues ()
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback (string $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...
	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...
Public Member Functions inherited from ilTableFilterItem
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...
	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Private Attributes
string	$path_including_prefix

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...
Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()
	setType (string $a_type)
	checkParentFormTable ()
	getSessionKey ()
	getMultiIconsHTML ()
	int ($key)
	intArray ($key)
	str ($key)
	raw ($key)
	strArray ($key)
	arrayArray ($key)
	isRequestParamArray (string $key)
	getRequestParam (string $key, Refinery\Transformation $t)
Protected Attributes inherited from ilMatchingPairWizardInputGUI
	$pairs = []
	$allowMove = false
	$terms = []
	$definitions = []
ilTestLegacyFormsHelper	$forms_helper
GlyphFactory	$glyph_factory
Renderer	$renderer
Protected Attributes inherited from ilTextInputGUI
	$value = null
int	$maxlength = 200
int	$size = 40
string	$validationRegexp = ""
string	$validationFailureMessage = ''
string	$suffix = ""
string	$style_css = ""
string	$css_class = ""
string	$ajax_datasource = ""
string	$ajax_datasource_delimiter = null
bool	$ajax_datasource_commit = false
string	$ajax_datasource_commit_url = ""
bool	$submit_form_on_enter = false
bool	$autocomplete_disabled = false
string	$input_type = ""
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []
ilTable2GUI	$parent_table = null
ilFormPropertyGUI	$parent_gui = null
ilCtrl	$ctrl
ilLanguage	$lng
string	$type = ""
string	$title = ""
string	$postvar = ""
string	$info = ""
string	$alert = ""
bool	$required = false
ilPropertyFormGUI	$parentform = null
string	$hidden_title = ""
bool	$multi = false
bool	$multi_sortable = false
bool	$multi_addremove = true
array	$multi_values = []
RequestInterface	$request
HTTP Services	$http
Refinery Factory	$refinery = null
bool	$disabled = false
ilGlobalTemplateInterface	$global_tpl = null

Detailed Description

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

Member Function Documentation

checkInput()

ilAssMatchingPairCorrectionsInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

Reimplemented from ilMatchingPairWizardInputGUI.

Definition at line 51 of file class.ilAssMatchingPairCorrectionsInputGUI.php.

                                : bool
    {
        $data = $this->raw($this->getPostVar());
        $result = $this->forms_helper->checkPointsInput($data, $this->getRequired());
 
        if (!is_array($result)) {
            $this->setAlert($this->lng->txt($result));
            return false;
        }
 
        if (max($result) <= 0) {
            $this->setAlert($this->lng->txt('enter_enough_positive_points'));
            return false;
        }
 
        return $this->checkSubItemsInput();
    }

References $data, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ILIAS\Repository\lng(), ilFormPropertyGUI\raw(), and ilFormPropertyGUI\setAlert().

Here is the call graph for this function:

getPairs()

ilAssMatchingPairCorrectionsInputGUI::getPairs

(

)

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

                              : array
    {
        return $this->pairs;
    }

References ilMatchingPairWizardInputGUI\$pairs.

insert()

ilAssMatchingPairCorrectionsInputGUI::insert

(

ilTemplate

$a_tpl

)

Insert property html.

Returns

void Size

Reimplemented from ilMatchingPairWizardInputGUI.

Definition at line 69 of file class.ilAssMatchingPairCorrectionsInputGUI.php.

                                             : void
    {
        $tpl = new ilTemplate('tpl.prop_matchingpaircorrection_input.html', true, true, 'components/ILIAS/TestQuestionPool');
        $i = 0;
        $term_ids = [];
        $definition_ids = [];
        foreach ($this->pairs as $pair) {
            $tpl->setCurrentBlock('row');
 
            foreach ($this->terms as $term) {
                if ($pair->getTerm()->getIdentifier() !== $term->getIdentifier()) {
                    continue;
                }
                $term_ids[] = $term->getIdentifier();
                if ($term->getText() !== '') {
                    $tpl->setVariable('TERM', ilLegacyFormElementsUtil::prepareTextareaOutput($term->getText(), true, true));
                }
                if ($term->getPicture() !== '') {
                    $tpl->setCurrentBlock('term_image');
                    $tpl->setVariable('THUMBNAIL_HREF', $this->path_including_prefix . $term->getPicture());
                    $tpl->setVariable('THUMB_ALT', $this->lng->txt('image'));
                    $tpl->setVariable('THUMB_TITLE', $this->lng->txt('image'));
                    $tpl->parseCurrentBlock();
                    $tpl->setCurrentBlock('row');
                }
                break;
            }
            foreach ($this->definitions as $definition) {
                if ($pair->getDefinition()->getIdentifier() !== $definition->getIdentifier()) {
                    continue;
                }
                $definition_ids[] = $definition->getIdentifier();
                if ($definition->getText() !== '') {
                    $tpl->setVariable('DEFINITION', ilLegacyFormElementsUtil::prepareTextareaOutput($definition->getText(), true, true));
                }
                if ($definition->getPicture() !== '') {
                    $tpl->setCurrentBlock('definition_image');
                    $tpl->setVariable('THUMBNAIL_HREF', $this->path_including_prefix . $definition->getPicture());
                    $tpl->setVariable('THUMB_ALT', $this->lng->txt('image'));
                    $tpl->setVariable('THUMB_TITLE', $this->lng->txt('image'));
                    $tpl->parseCurrentBlock();
                    $tpl->setCurrentBlock('row');
                }
                break;
            }
 
            $tpl->setVariable('POINTS_VALUE', $pair->getPoints());
            $tpl->setVariable('ROW_NUMBER', $i);
 
            $tpl->setVariable('ID', $this->getPostVar() . "[$i]");
            $tpl->setVariable('POST_VAR', $this->getPostVar());
 
            $tpl->parseCurrentBlock();
 
            $i++;
        }
 
        $tpl->setCurrentBlock('term_ids');
        $tpl->setVariable('POST_VAR', $this->getPostVar());
        $tpl->setVariable('TERM_IDS', join(',', $term_ids));
        $tpl->parseCurrentBlock();
 
        $tpl->setCurrentBlock('definition_ids');
        $tpl->setVariable('POST_VAR', $this->getPostVar());
        $tpl->setVariable('DEFINITION_IDS', join(',', $definition_ids));
        $tpl->parseCurrentBlock();
 
        $tpl->setVariable('ELEMENT_ID', $this->getPostVar());
        $tpl->setVariable('TEXT_POINTS', $this->lng->txt('points'));
        $tpl->setVariable('TEXT_DEFINITION', $this->lng->txt('definition'));
        $tpl->setVariable('TEXT_TERM', $this->lng->txt('term'));
        $tpl->setVariable('TEXT_ACTIONS', $this->lng->txt('actions'));
 
        $a_tpl->setCurrentBlock('prop_generic');
        $a_tpl->setVariable('PROP_GENERIC', $tpl->get());
        $a_tpl->parseCurrentBlock();
    }

References ilFormPropertyGUI\getPostVar(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareTextareaOutput(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

setThumbsWebPathWithPrefix()

ilAssMatchingPairCorrectionsInputGUI::setThumbsWebPathWithPrefix

(

string

$path_including_prefix

)

Definition at line 36 of file class.ilAssMatchingPairCorrectionsInputGUI.php.

                                                                             : void
    {
        $this->path_including_prefix = $path_including_prefix;
    }

References $path_including_prefix.

setValue()

ilAssMatchingPairCorrectionsInputGUI::setValue

(

$a_value

)

Parameters

string | array

$a_value

Reimplemented from ilMatchingPairWizardInputGUI.

Definition at line 40 of file class.ilAssMatchingPairCorrectionsInputGUI.php.

                                      : void
    {
        foreach ($this->forms_helper->transformPoints($a_value) as $index => $value) {
            if ($value === null) {
                return;
            }
 
            $this->pairs[$index] = $this->pairs[$index]->withPoints($value);
        }
    }

References ilTextInputGUI\$value.

Field Documentation

$path_including_prefix

string ilAssMatchingPairCorrectionsInputGUI::$path_including_prefix

private

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

Referenced by setThumbsWebPathWithPrefix().

---

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

• components/ILIAS/TestQuestionPool/classes/forms/class.ilAssMatchingPairCorrectionsInputGUI.php