ilDataCollectionNReferenceField Class Reference

Class ilDataCollectionNReferenceField. More...

Inheritance diagram for ilDataCollectionNReferenceField:

Collaboration diagram for ilDataCollectionNReferenceField:

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 ilDataCollectionReferenceField
	__construct (ilDataCollectionRecord $record, ilDataCollectionField $field)
	getExportValue ()
	getValueFromExcel ($excel, $row, $col)
	getReferenceFromValue ($value)
Public Member Functions inherited from ilDataCollectionRecordField
	__construct (ilDataCollectionRecord $record, ilDataCollectionField $field)
	doUpdate ()
	Update object in database. More...
	delete ()
	Delete record field in database. More...
	getValue ()
	setValue ($value, $omit_parsing=false)
	Set value for record field. More...
	setValueFromForm (&$form)
	getValueFromExcel ($excel, $row, $col)
	fillFormInput (&$form)
	getExportValue ()
	fillExcelExport ($worksheet, &$row, &$col)
	getPlainText ()
	getHTML ($link=true)
	getSortingValue ($link=true)
	getSingleHTML ()
	getField ()
	getId ()
	getRecord ()

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...
	getLinkHTML ($link_name=NULL, $value)
Protected Member Functions inherited from ilDataCollectionRecordField
	doRead ()
	Read object data from database. More...
	doCreate ()
	Creates an Id and a database entry. More...
	getFormInput ()
	loadValue ()
	Load the value. More...

Protected Attributes
	$max_reference_length = 20
Protected Attributes inherited from ilDataCollectionReferenceField
	$dcl_obj_id
	$properties = array()
Protected Attributes inherited from ilDataCollectionRecordField
	$id
	$field
	$record
	$value
	$user
	$ctrl
	$db
	$lng

Detailed Description

Class ilDataCollectionNReferenceField.

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 9 of file class.ilDataCollectionNReferenceField.php.

Member Function Documentation

doUpdate()

ilDataCollectionNReferenceField::doUpdate

(

)

Update object in database.

Reimplemented from ilDataCollectionRecordField.

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

                                   {
                global $ilDB;
 
                $values = $this->getValue();
                if (!is_array($values)) {
                        $values = array( $values );
                }
                $datatype = $this->field->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 $ilDB, $query, ilDataCollectionRecordField\$value, ilDataCollectionRecordField\getId(), and getValue().

Referenced by ilDataCollectionNReferenceFieldGUI\buildTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

getExportValue()

ilDataCollectionNReferenceField::getExportValue

(

)

Returns

int|string

Reimplemented from ilDataCollectionReferenceField.

Definition at line 201 of file class.ilDataCollectionNReferenceField.php.

                                         {
                $values = $this->getValue();
                $names = array();
                foreach ($values as $value) {
                        if ($value) {
                                $ref_rec = ilDataCollectionCache::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 ilDataCollectionRecordField\$value, ilDataCollectionRecordField\getField(), ilDataCollectionCache\getRecordCache(), and getValue().

Here is the call graph for this function:

getHTML()

ilDataCollectionNReferenceField::getHTML

(

)

Returns

array|mixed|string

Definition at line 179 of file class.ilDataCollectionNReferenceField.php.

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

getLinkHTML()

ilDataCollectionNReferenceField::getLinkHTML	(		$link,
			$value
	)

Parameters

null	$link
	$value

Returns

string

Reimplemented from ilDataCollectionReferenceField.

Definition at line 167 of file class.ilDataCollectionNReferenceField.php.

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

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

Referenced by ilDataCollectionNReferenceFieldGUI\buildTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxReferenceLength()

ilDataCollectionNReferenceField::getMaxReferenceLength

(

)

Returns

int

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

                                                {
                return $this->max_reference_length;
        }

References $max_reference_length.

getReferencesFromString()

ilDataCollectionNReferenceField::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[]

Definition at line 229 of file class.ilDataCollectionNReferenceField.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 ilDataCollectionReferenceField\getReferenceFromValue().

Referenced by getValueFromExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

getSingleHTML()

ilDataCollectionNReferenceField::getSingleHTML

(

$options = NULL

)

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

Returns

mixed

Definition at line 154 of file class.ilDataCollectionNReferenceField.php.

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

References $options.

getValue()

ilDataCollectionNReferenceField::getValue

(

)

Returns

string

Reimplemented from ilDataCollectionRecordField.

Definition at line 66 of file class.ilDataCollectionNReferenceField.php.

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

References ilDataCollectionRecordField\$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()

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

Parameters

$excel
$row
$col

Returns

array|string

Reimplemented from ilDataCollectionReferenceField.

Definition at line 184 of file class.ilDataCollectionNReferenceField.php.

                                                             {
                global $lng;
                $stringValue = $excel->val($row, $col);
                $this->getReferencesFromString($stringValue);
                $referenceIds = $this->getReferencesFromString($stringValue);
                if (!count($referenceIds)) {
                        $warning = "(" . $col . ", " . ilDataCollectionImporter::getExcelCharForInteger($col) . ") " . $lng->txt("dcl_no_such_reference") . " "
                                . $stringValue;
                        return array('warning' => $warning);
                }
 
                return $referenceIds;
        }

References ilDataCollectionRecordField\$lng, $row, ilDataCollectionImporter\getExcelCharForInteger(), and getReferencesFromString().

Here is the call graph for this function:

loadValue()

ilDataCollectionNReferenceField::loadValue ( )

protected

Load the value.

Reimplemented from ilDataCollectionRecordField.

Definition at line 134 of file class.ilDataCollectionNReferenceField.php.

                                       {
                if ($this->value === NULL) {
                        global $ilDB;
                        $datatype = $this->field->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 $ilDB, and $query.

Referenced by getValue().

Here is the caller graph for this function:

loadValueSorted()

ilDataCollectionNReferenceField::loadValueSorted ( )

protected

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

                                             {
                if ($this->value === NULL) {
 
                        global $ilDB;
                        $datatype = $this->field->getDatatype();
                        $refField = ilDataCollectionCache::getFieldCache($this->getField()->getFieldRef());
 
                        $supported_internal_types = array(
                                ilDataCollectionDatatype::INPUTFORMAT_ILIAS_REF,
                                ilDataCollectionDatatype::INPUTFORMAT_MOB,
                                ilDataCollectionDatatype::INPUTFORMAT_FILE,
                        );
 
                        $supported_types = array_merge(array(
                                ilDataCollectionDatatype::INPUTFORMAT_TEXT,
                                ilDataCollectionDatatype::INPUTFORMAT_NUMBER,
                                ilDataCollectionDatatype::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 ilDataCollectionDatatype::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 ilDataCollectionDatatype::INPUTFORMAT_MOB:
                                case ilDataCollectionDatatype::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 $ilDB, $query, ilDataCollectionRecordField\getField(), ilDataCollectionCache\getFieldCache(), ilDataCollectionDatatype\INPUTFORMAT_BOOLEAN, ilDataCollectionDatatype\INPUTFORMAT_FILE, ilDataCollectionDatatype\INPUTFORMAT_ILIAS_REF, ilDataCollectionDatatype\INPUTFORMAT_MOB, ilDataCollectionDatatype\INPUTFORMAT_NUMBER, and ilDataCollectionDatatype\INPUTFORMAT_TEXT.

Here is the call graph for this function:

setMaxReferenceLength()

ilDataCollectionNReferenceField::setMaxReferenceLength

(

$max_reference_length

)

Parameters

int

$max_reference_length

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

                                                                     {
                $this->max_reference_length = $max_reference_length;
        }

References $max_reference_length.

Field Documentation

$max_reference_length

ilDataCollectionNReferenceField::$max_reference_length = 20

protected

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

Referenced by getMaxReferenceLength(), and setMaxReferenceLength().

---

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

• Modules/DataCollection/classes/class.ilDataCollectionNReferenceField.php