ilDclSelectionRecordFieldModel 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 ilDclSelectionRecordFieldModel:

Collaboration diagram for ilDclSelectionRecordFieldModel:

Public Member Functions
	getValue ()
	parseExportValue ($value)
	getValueFromExcel (ilExcel $excel, int $row, int $col)
Public Member Functions inherited from ilDclBaseRecordFieldModel
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	doCreate ()
	Creates an Id and a database entry. More...
	doUpdate ()
	Update object in database. More...
	delete ()
	Delete record field in database. More...
	getValue ()
	getValueForRepresentation ()
	serializeData ($value)
	Serialize data before storing to db. More...
	deserializeData ($value)
	Deserialize data before applying to field. More...
	setValue ($value, bool $omit_parsing=false)
	Set value for record field. More...
	setValueFromForm (ilPropertyFormGUI $form)
	getFormulaValue ()
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	getValueFromExcel (ilExcel $excel, int $row, int $col)
	parseValue ($value)
	Function to parse incoming data from form input value $value. More...
	getExportValue ()
	fillExcelExport (ilExcel $worksheet, int &$row, int &$col)
	getPlainText ()
	getSortingValue (bool $link=true)
	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)
	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...
	cloneStructure (ilDclBaseRecordFieldModel $old_record_field)
	afterClone ()
	getField ()
	getId ()
	getRecord ()
	getRecordRepresentation ()
	setRecordRepresentation (ilDclBaseRecordRepresentation $record_representation)
	getFieldRepresentation ()
	setFieldRepresentation (ilDclBaseFieldRepresentation $field_representation)

Data Fields
const	PROP_SELECTION_TYPE = ''
const	PROP_SELECTION_OPTIONS = ''

Protected Member Functions
	getMultipleValuesFromString (string $stringValues)
	Copied from reference field and slightly adjusted. More...
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...
	loadValue ()
	Load the value. More...

Additional Inherited Members
Protected Attributes inherited from ilDclBaseRecordFieldModel
int	$id = null
ilDclBaseFieldModel	$field
ilDclBaseRecordModel	$record
ilDclBaseRecordRepresentation	$record_representation = null
ilDclBaseFieldRepresentation	$field_representation = null
	$value
ilObjUser	$user
ilCtrl	$ctrl
ilDBInterface	$db
ilLanguage	$lng
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery

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

Definition at line 19 of file class.ilDclSelectionRecordFieldModel.php.

Member Function Documentation

getMultipleValuesFromString()

ilDclSelectionRecordFieldModel::getMultipleValuesFromString ( string  $stringValues )

protected

Copied from reference field and slightly adjusted.

This method tries to get as many valid values out of a string separated by commata. This is problematic as a string value could contain commata itself. It is optimized to work with an exported list from this DataCollection. And works fine in most cases. Only areference list with the values "hello" and "hello, world" Will mess with it.

Parameters

$stringValues

string

Returns

int[]

Definition at line 80 of file class.ilDclSelectionRecordFieldModel.php.

References $i, and ilDclBaseRecordFieldModel\getField().

Referenced by getValueFromExcel().

                                                                        : array
    {
        $delimiter = strpos($stringValues, '; ') ? '; ' : ', ';
        $slicedStrings = explode($delimiter, $stringValues);
        $slicedReferences = [];
        $resolved = 0;
        for ($i = 0; $i < count($slicedStrings); $i++) {
            //try to find a reference since the last resolved value separated by a comma.
            // $i = 1; $resolved = 0; $string = "hello, world, gaga" -> try to match "hello, world".
            $searchString = implode(array_slice($slicedStrings, $resolved, $i - $resolved + 1));
            if ($ref = $this->getValueFromString($searchString)) {
                $slicedReferences[] = $ref;
                $resolved = $i;
                continue;
            }

            //try to find a reference with the current index.
            // $i = 1; $resolved = 0; $string = "hello, world, gaga" -> try to match "world".
            $searchString = $slicedStrings[$i];
            if ($ref = $this->getValueFromString($searchString)) {
                $slicedReferences[] = $ref;
                $resolved = $i;
            }
        }

        return $slicedReferences;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValue()

ilDclSelectionRecordFieldModel::getValue

(

)

Returns

array|string

Definition at line 28 of file class.ilDclSelectionRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, and ilDclBaseRecordFieldModel\getField().

    {
        if ($this->getField()->isMulti() && !is_array($this->value)) {
            return [$this->value];
        }
        if (!$this->getField()->isMulti() && is_array($this->value)) {
            return (count($this->value) == 1) ? array_shift($this->value) : '';
        }

        return $this->value;
    }

Here is the call graph for this function:

getValueFromExcel()

ilDclSelectionRecordFieldModel::getValueFromExcel	(	ilExcel	$excel,
		int	$row,
		int	$col
	)

Definition at line 50 of file class.ilDclSelectionRecordFieldModel.php.

References ilDataCollectionImporter\getExcelCharForInteger(), ilDclBaseRecordFieldModel\getField(), getMultipleValuesFromString(), and ILIAS\Repository\lng().

    {
        $string = parent::getValueFromExcel($excel, $row, $col);
        $old = $string;
        if ($this->getField()->isMulti()) {
            $string = $this->getMultipleValuesFromString($string);
            $has_value = count($string);
        } else {
            $string = $this->getValueFromString($string);
            $has_value = $string;
        }

        if (!$has_value && $old) {
            $warning = "(" . $row . ", " . ilDataCollectionImporter::getExcelCharForInteger($col + 1) . ") " . $this->lng->txt("dcl_no_such_reference") . " "
                . $old;

            return ['warning' => $warning];
        }

        return $string;
    }

Here is the call graph for this function:

parseExportValue()

ilDclSelectionRecordFieldModel::parseExportValue

(

$value

)

Parameters

array | string | int

$value

Definition at line 43 of file class.ilDclSelectionRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), and ilDclSelectionOption\getValues().

                                            : string
    {
        $values = ilDclSelectionOption::getValues($this->getField()->getId(), $value);

        return implode("; ", $values);
    }

Here is the call graph for this function:

Field Documentation

PROP_SELECTION_OPTIONS

const ilDclSelectionRecordFieldModel::PROP_SELECTION_OPTIONS = ''

Definition at line 23 of file class.ilDclSelectionRecordFieldModel.php.

PROP_SELECTION_TYPE

const ilDclSelectionRecordFieldModel::PROP_SELECTION_TYPE = ''

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

---

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

• Modules/DataCollection/classes/Fields/Selection/class.ilDclSelectionRecordFieldModel.php