ilDclSelectionRecordFieldModel Class Reference

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 ()
	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)

Protected Member Functions
	getMultipleValuesFromString (string $stringValues)
	Copied from reference field and slightly adjusted. More...
	getValueFromString (string $string)
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

Definition at line 21 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 78 of file class.ilDclSelectionRecordFieldModel.php.

References getValueFromString().

Referenced by getValueFromExcel().

                                                                        : array
    {
        $delimiter = strpos($stringValues, '; ') ? '; ' : ', ';
        $slicedStrings = explode($delimiter, $stringValues);
        $slicedReferences = [];
        $resolved = 0;
        for ($i = 0; $i < count($slicedStrings); $i++) {
            $searchString = implode(array_slice($slicedStrings, $resolved, $i - $resolved + 1));
            if ($ref = $this->getValueFromString($searchString)) {
                $slicedReferences[] = $ref;
                $resolved = $i;
                continue;
            }

            $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 26 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 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 48 of file class.ilDclSelectionRecordFieldModel.php.

References ilDataCollectionImporter\getExcelCharForInteger(), ilDclBaseRecordFieldModel\getField(), getMultipleValuesFromString(), getValueFromString(), 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:

getValueFromString()

ilDclSelectionRecordFieldModel::getValueFromString ( string  $string )

protected

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

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

Referenced by getMultipleValuesFromString(), and getValueFromExcel().

                                                         : ?int
    {
        foreach ($this->getField()->getProperty($this->field::PROP_SELECTION_OPTIONS) as $id => $value) {
            if ($value == $string) {
                return $id;
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseExportValue()

ilDclSelectionRecordFieldModel::parseExportValue

(

$value

)

Parameters

array | string | int

$value

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

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

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

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

Here is the call graph for this function:

---

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

• components/ILIAS/DataCollection/classes/Fields/Selection/class.ilDclSelectionRecordFieldModel.php