ilIdentifiedMultiValuesJsPositionIndexRemover Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilIdentifiedMultiValuesJsPositionIndexRemover:

Collaboration diagram for ilIdentifiedMultiValuesJsPositionIndexRemover:

Public Member Functions
	manipulateFormInputValues (array $inputValues)
	manipulateFormSubmitValues (array $submitValues)

Data Fields
const	IDENTIFIER_INDICATOR_PREFIX = 'IDENTIFIER~'

Protected Member Functions
	brandIdentifiersWithIndicator (array $origValues)
	getIndicatorBrandedIdentifier (string $identifier)
	cleanSubmitCommandFromPossibleIdentifierIndicators ($cmdArrayLevel)
	removePositionIndexLevels (array $values)
	isPositionIndexLevel ($val)
	isValueIdentifier ($key)
	removeIdentifierIndicator ($key)
	fetchPositionIndexedValue ($value)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Definition at line 22 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

Member Function Documentation

brandIdentifiersWithIndicator()

ilIdentifiedMultiValuesJsPositionIndexRemover::brandIdentifiersWithIndicator ( array  $origValues )

protected

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

References getIndicatorBrandedIdentifier().

Referenced by manipulateFormInputValues().

                                                                       : array
    {
        $brandedValues = array();

        foreach ($origValues as $identifier => $val) {
            $brandedValues[$this->getIndicatorBrandedIdentifier($identifier)] = $val;
        }

        return $brandedValues;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cleanSubmitCommandFromPossibleIdentifierIndicators()

ilIdentifiedMultiValuesJsPositionIndexRemover::cleanSubmitCommandFromPossibleIdentifierIndicators (   $cmdArrayLevel )

protected

Definition at line 53 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

References isValueIdentifier(), and removeIdentifierIndicator().

    {
        if (is_array($cmdArrayLevel)) {
            $currentKey = key($cmdArrayLevel);
            $nextLevel = current($cmdArrayLevel);

            $nextLevel = $this->cleanSubmitCommandFromPossibleIdentifierIndicators($nextLevel);

            unset($cmdArrayLevel[$currentKey]);

            if ($this->isValueIdentifier($currentKey)) {
                $currentKey = $this->removeIdentifierIndicator($currentKey);
            }

            $cmdArrayLevel[$currentKey] = $nextLevel;
        }

        return $cmdArrayLevel;
    }

Here is the call graph for this function:

fetchPositionIndexedValue()

ilIdentifiedMultiValuesJsPositionIndexRemover::fetchPositionIndexedValue (   $value )

protected

Definition at line 127 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

Referenced by removePositionIndexLevels().

    {
        return current($value);
    }

Here is the caller graph for this function:

getIndicatorBrandedIdentifier()

ilIdentifiedMultiValuesJsPositionIndexRemover::getIndicatorBrandedIdentifier ( string  $identifier )

protected

Definition at line 42 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

Referenced by brandIdentifiersWithIndicator().

                                                                        : string
    {
        return self::IDENTIFIER_INDICATOR_PREFIX . $identifier;
    }

Here is the caller graph for this function:

isPositionIndexLevel()

ilIdentifiedMultiValuesJsPositionIndexRemover::isPositionIndexLevel (   $val )

protected

Definition at line 94 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

Referenced by removePositionIndexLevels().

                                                 : bool
    {
        if (!is_array($val)) {
            return false;
        }

        if (count($val) != 1) {
            return false;
        }

        return true;
    }

Here is the caller graph for this function:

isValueIdentifier()

ilIdentifiedMultiValuesJsPositionIndexRemover::isValueIdentifier (   $key )

protected

Definition at line 107 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by cleanSubmitCommandFromPossibleIdentifierIndicators(), and removePositionIndexLevels().

                                              : bool
    {
        $indicatorPrefixLength = self::IDENTIFIER_INDICATOR_PREFIX;

        if (strlen($key) <= strlen($indicatorPrefixLength)) {
            return false;
        }

        if (substr($key, 0, strlen($indicatorPrefixLength)) != $indicatorPrefixLength) {
            return false;
        }

        return true;
    }

Here is the caller graph for this function:

manipulateFormInputValues()

ilIdentifiedMultiValuesJsPositionIndexRemover::manipulateFormInputValues

(

array

$inputValues

)

Implements ilFormValuesManipulator.

Definition at line 26 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

References brandIdentifiersWithIndicator().

                                                                 : array
    {
        return $this->brandIdentifiersWithIndicator($inputValues);
    }

Here is the call graph for this function:

manipulateFormSubmitValues()

ilIdentifiedMultiValuesJsPositionIndexRemover::manipulateFormSubmitValues

(

array

$submitValues

)

Implements ilFormValuesManipulator.

Definition at line 47 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

References removePositionIndexLevels().

                                                                   : array
    {
        //$_POST['cmd'] = $this->cleanSubmitCommandFromPossibleIdentifierIndicators($_POST['cmd']);
        return $this->removePositionIndexLevels($submitValues);
    }

Here is the call graph for this function:

removeIdentifierIndicator()

ilIdentifiedMultiValuesJsPositionIndexRemover::removeIdentifierIndicator (   $key )

protected

Definition at line 122 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by cleanSubmitCommandFromPossibleIdentifierIndicators(), and removePositionIndexLevels().

    {
        return str_replace(self::IDENTIFIER_INDICATOR_PREFIX, '', $key);
    }

Here is the caller graph for this function:

removePositionIndexLevels()

ilIdentifiedMultiValuesJsPositionIndexRemover::removePositionIndexLevels ( array  $values )

protected

Definition at line 73 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

References ILIAS\LTI\ToolProvider\$key, fetchPositionIndexedValue(), isPositionIndexLevel(), isValueIdentifier(), and removeIdentifierIndicator().

Referenced by manipulateFormSubmitValues(), and ilIdentifiedMultiFilesJsPositionIndexRemover\prepareMultiFilesSubmitValues().

                                                               : array
    {
        foreach ($values as $key => $val) {
            unset($values[$key]);

            if ($this->isValueIdentifier($key)) {
                $key = $this->removeIdentifierIndicator($key);

                if ($this->isPositionIndexLevel($val)) {
                    $val = $this->fetchPositionIndexedValue($val);
                }
            } elseif (is_array($val)) {
                $val = $this->removePositionIndexLevels($val);
            }

            $values[$key] = $val;
        }

        return $values;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

IDENTIFIER_INDICATOR_PREFIX

const ilIdentifiedMultiValuesJsPositionIndexRemover::IDENTIFIER_INDICATOR_PREFIX = 'IDENTIFIER~'

Definition at line 24 of file class.ilIdentifiedMultiValuesJsPositionIndexRemover.php.

Referenced by ilAssOrderingFormValuesObjectsConverter\wasImageRemovalRequested().

---

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

• Modules/TestQuestionPool/classes/forms/class.ilIdentifiedMultiValuesJsPositionIndexRemover.php