ilDclNReferenceRecordFieldModel Class Reference

Inheritance diagram for ilDclNReferenceRecordFieldModel:

Collaboration diagram for ilDclNReferenceRecordFieldModel:

Public Member Functions
	getMaxReferenceLength ()
	setMaxReferenceLength ($max_reference_length)
	doUpdate ()
	Update object in database. More...
	getValue ()
	getSingleHTML ($options=null)
	@description this funciton is used to in the viewdefinition of a single record. More...
	getLinkHTML ($link, $value)
	getHTML ()
	getValueFromExcel ($excel, $row, $col)
	getExportValue ()
Public Member Functions inherited from ilDclReferenceRecordFieldModel
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	getExportValue ()
	getValueFromExcel ($excel, $row, $col)
	getReferenceFromValue ($value)
	afterClone ()
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, $omit_parsing=false)
	Set value for record field. More...
	setValueFromForm ($form)
	getFormulaValue ()
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	getValueFromExcel ($excel, $row, $col)
	parseValue ($value)
	Function to parse incoming data from form input value $value. More...
	getExportValue ()
	fillExcelExport (ilExcel $worksheet, &$row, &$col)
	getPlainText ()
	getSortingValue ($link=true)
	addHiddenItemsToConfirmation (ilConfirmationGUI &$confirmation)
	parseSortingValue ($value, $link=true)
	Returns sortable value for the specific field-types. More...
	cloneStructure (ilDclBaseRecordFieldModel $old_record_field)
	afterClone ()
	getField ()
	getId ()
	getRecord ()
	getRecordRepresentation ()
	setRecordRepresentation ($record_representation)
	getFieldRepresentation ()
	setFieldRepresentation ($field_representation)

Protected Member Functions
	loadValueSorted ()
	loadValue ()
	Load the value. More...
	getReferencesFromString ($stringValues)
	This method tries to get as many valid references out of a string separated by commata. More...
Protected Member Functions inherited from ilDclReferenceRecordFieldModel
	getReferencesFromString ($stringValues)
	This method tries to get as many valid references out of a string separated by commata. More...
	getCloneRecordId (string $clone_reference)
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...
	loadValue ()
	Load the value. More...

Protected Attributes
	$max_reference_length = 20
Protected Attributes inherited from ilDclReferenceRecordFieldModel
	$dcl_obj_id
Protected Attributes inherited from ilDclBaseRecordFieldModel
	$id
	$field
	$record
	$record_representation
	$field_representation
	$value
	$user
	$ctrl
	$db
	$lng

Detailed Description

Author

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file class.ilDclNReferenceRecordFieldModel.php.

Member Function Documentation

doUpdate()

ilDclNReferenceRecordFieldModel::doUpdate

(

)

Update object in database.

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 35 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $values = $this->getValue();
        if (!is_array($values)) {
            $values = array($values);
        }
        $datatype = $this->getField()->getDatatype();
 
        $query = "DELETE FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value WHERE record_field_id = "
            . $ilDB->quote($this->id, "integer");
        $ilDB->manipulate($query);
 
        if (!count($values) || $values[0] == 0) {
            return;
        }
 
        $query = "INSERT INTO il_dcl_stloc" . $datatype->getStorageLocation() . "_value (value, record_field_id, id) VALUES";
        foreach ($values as $value) {
            $next_id = $ilDB->nextId("il_dcl_stloc" . $datatype->getStorageLocation() . "_value");
            $query .= " (" . $ilDB->quote($value, $datatype->getDbType()) . ", " . $ilDB->quote($this->getId(), "integer") . ", "
                . $ilDB->quote($next_id, "integer") . "),";
        }
        $query = substr($query, 0, -1);
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), and getValue().

Referenced by ilDclNReferenceFieldGUI\buildTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

getExportValue()

ilDclNReferenceRecordFieldModel::getExportValue

(

)

Returns

int|string

Reimplemented from ilDclReferenceRecordFieldModel.

Definition at line 219 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        $values = $this->getValue();
        $names = array();
        foreach ($values as $value) {
            if ($value) {
                $ref_rec = ilDclCache::getRecordCache($value);
                $names[] = $ref_rec->getRecordField($this->getField()->getFieldRef())->getValue();
            }
        }
        $string = "";
        foreach ($names as $name) {
            $string .= $name . ", ";
        }
        if (!count($names)) {
            return "";
        }
        $string = substr($string, 0, -2);
 
        return $string;
    }

References $name, ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclCache\getRecordCache(), and getValue().

Here is the call graph for this function:

getHTML()

ilDclNReferenceRecordFieldModel::getHTML

(

)

Returns

array|mixed|string

Definition at line 190 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        $ilDataCollectionNReferenceFieldGUI = new ilDclNReferenceFieldGUI($this);
 
        return $ilDataCollectionNReferenceFieldGUI->getHTML();
    }

getLinkHTML()

ilDclNReferenceRecordFieldModel::getLinkHTML	(		$link,
			$value
	)

Parameters

null	$link
	$value

Returns

string

Definition at line 177 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        if ($link == "[" . $this->getField()->getTitle() . "]") {
            $link = null;
        }
 
        return parent::getLinkHTML($link, $value);
    }

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

Referenced by ilDclNReferenceFieldGUI\buildTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxReferenceLength()

ilDclNReferenceRecordFieldModel::getMaxReferenceLength

(

)

Returns

int

Definition at line 20 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        return $this->max_reference_length;
    }

References $max_reference_length.

getReferencesFromString()

ilDclNReferenceRecordFieldModel::getReferencesFromString (   $stringValues )

protected

This method tries to get as many valid references 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[]

Reimplemented from ilDclReferenceRecordFieldModel.

Definition at line 251 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        $slicedStrings = explode(", ", $stringValues);
        $slicedReferences = array();
        $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->getReferenceFromValue($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->getReferenceFromValue($searchString)) {
                $slicedReferences[] = $ref;
                $resolved = $i;
                continue;
            }
        }
 
        return $slicedReferences;
    }

References $i, and ilDclReferenceRecordFieldModel\getReferenceFromValue().

Referenced by getValueFromExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

getSingleHTML()

ilDclNReferenceRecordFieldModel::getSingleHTML

(

$options = null

)

@description this funciton is used to in the viewdefinition of a single record.

Returns

mixed

Definition at line 163 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        $ilDataCollectionNReferenceFieldGUI = new ilDclNReferenceFieldGUI($this);
 
        return $ilDataCollectionNReferenceFieldGUI->getSingleHTML($options);
    }

getValue()

ilDclNReferenceRecordFieldModel::getValue

(

)

Returns

string

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 68 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        $this->loadValue();
 
        return $this->value;
    }

References ilDclBaseRecordFieldModel\$value, and loadValue().

Referenced by doUpdate(), and getExportValue().

Here is the call graph for this function:

Here is the caller graph for this function:

getValueFromExcel()

ilDclNReferenceRecordFieldModel::getValueFromExcel	(		$excel,
			$row,
			$col
	)

Parameters

$excel
$row
$col

Returns

array|string

Reimplemented from ilDclReferenceRecordFieldModel.

Definition at line 198 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        global $DIC;
        $lng = $DIC['lng'];
        $stringValue = parent::getValueFromExcel($excel, $row, $col);
        $this->getReferencesFromString($stringValue);
        $referenceIds = $this->getReferencesFromString($stringValue);
        if (!count($referenceIds) && $stringValue) {
            $warning = "(" . $row . ", " . ilDataCollectionImporter::getExcelCharForInteger($col + 1) . ") " . $lng->txt("dcl_no_such_reference") . " "
                . $stringValue;
 
            return array('warning' => $warning);
        }
 
        return $referenceIds;
    }

References $DIC, ilDclBaseRecordFieldModel\$lng, ilDataCollectionImporter\getExcelCharForInteger(), and getReferencesFromString().

Here is the call graph for this function:

loadValue()

ilDclNReferenceRecordFieldModel::loadValue ( )

protected

Load the value.

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 141 of file class.ilDclNReferenceRecordFieldModel.php.

    {
        if ($this->value === null) {
            global $DIC;
            $ilDB = $DIC['ilDB'];
            $datatype = $this->getField()->getDatatype();
            $query = "SELECT * FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value WHERE record_field_id = "
                . $ilDB->quote($this->id, "integer");
            $set = $ilDB->query($query);
            $this->value = array();
            while ($rec = $ilDB->fetchAssoc($set)) {
                $this->value[] = $rec['value'];
            }
        }
    }

References $DIC, $ilDB, $query, and ilDclBaseRecordFieldModel\getField().

Referenced by getValue().

Here is the call graph for this function:

Here is the caller graph for this function:

loadValueSorted()

ilDclNReferenceRecordFieldModel::loadValueSorted ( )

protected

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

    {
        if ($this->value === null) {
            global $DIC;
            $ilDB = $DIC['ilDB'];
            $datatype = $this->getField()->getDatatype();
            $refField = ilDclCache::getFieldCache($this->getField()->getFieldRef());
 
            $supported_internal_types = array(
                ilDclDatatype::INPUTFORMAT_ILIAS_REF,
                ilDclDatatype::INPUTFORMAT_MOB,
                ilDclDatatype::INPUTFORMAT_FILE,
            );
 
            $supported_types = array_merge(
                array(
                    ilDclDatatype::INPUTFORMAT_TEXT,
                    ilDclDatatype::INPUTFORMAT_NUMBER,
                    ilDclDatatype::INPUTFORMAT_BOOLEAN,
                ),
                $supported_internal_types
            );
            $datatypeId = $refField->getDatatypeId();
            if (in_array($datatypeId, $supported_types)) {
                if (in_array($datatypeId, $supported_internal_types)) {
                    $query = "SELECT stlocOrig.value AS value,  ilias_object.title AS value_ref ";
                } else {
                    $query = "SELECT stlocOrig.value AS value,  stlocRef.value AS value_ref ";
                }
                $query .= "FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value AS stlocOrig  ";
 
                $query .= " INNER JOIN il_dcl_record_field AS refField ON stlocOrig.value = refField.record_id AND refField.field_id = "
                    . $ilDB->quote($refField->getId(), "integer");
                $query .= " INNER JOIN il_dcl_stloc" . $refField->getStorageLocation()
                    . "_value AS stlocRef ON stlocRef.record_field_id = refField.id ";
            } else {
                $query = "SELECT stlocOrig.value AS value ";
                $query .= "FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value AS stlocOrig  ";
            }
 
            switch ($datatypeId) {
                case ilDclDatatype::INPUTFORMAT_ILIAS_REF:
                    $query .= " INNER JOIN object_reference AS ilias_ref ON ilias_ref.ref_id = stlocRef.value ";
                    $query .= " INNER JOIN object_data AS ilias_object ON ilias_object.obj_id = ilias_ref.obj_id ";
                    break;
                case ilDclDatatype::INPUTFORMAT_MOB:
                case ilDclDatatype::INPUTFORMAT_FILE:
                    $query .= " INNER JOIN object_data AS ilias_object ON ilias_object.obj_id =  stlocRef.value ";
                    break;
            }
            $query .= " WHERE stlocOrig.record_field_id = " . $ilDB->quote($this->id, "integer");
            if (in_array($datatypeId, $supported_types)) {
                $query .= " ORDER BY value_ref ASC";
            }
 
            $set = $ilDB->query($query);
 
            $this->value = array();
            while ($rec = $ilDB->fetchAssoc($set)) {
                $this->value[] = $rec['value'];
            }
        }
    }

References $DIC, $ilDB, $query, ilDclBaseRecordFieldModel\getField(), ilDclCache\getFieldCache(), ilDclDatatype\INPUTFORMAT_BOOLEAN, ilDclDatatype\INPUTFORMAT_FILE, ilDclDatatype\INPUTFORMAT_ILIAS_REF, ilDclDatatype\INPUTFORMAT_MOB, ilDclDatatype\INPUTFORMAT_NUMBER, and ilDclDatatype\INPUTFORMAT_TEXT.

Here is the call graph for this function:

setMaxReferenceLength()

ilDclNReferenceRecordFieldModel::setMaxReferenceLength

(

$max_reference_length

)

Parameters

int

$max_reference_length

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

    {
        $this->max_reference_length = $max_reference_length;
    }

References $max_reference_length.

Field Documentation

$max_reference_length

ilDclNReferenceRecordFieldModel::$max_reference_length = 20

protected

Definition at line 14 of file class.ilDclNReferenceRecordFieldModel.php.

Referenced by getMaxReferenceLength(), and setMaxReferenceLength().

---

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

• Modules/DataCollection/classes/Fields/NReference/class.ilDclNReferenceRecordFieldModel.php