Collaboration diagram for ilDataCollectionRecord:

Public Member Functions
	__construct ($a_id=0)

	doUpdate ()
	doUpdate More...

	doRead ()
	Read record. More...

	doCreate ()

	deleteField ($field_id)

	setId ($a_id)
	Set field id. More...

	getId ()
	Get field id. More...

	setTableId ($a_id)
	Set Table ID. More...

	getTableId ()
	Get Table ID. More...

	setCreateDate ($a_datetime)
	Set Creation Date. More...

	getCreateDate ()
	Get Creation Date. More...

	setLastUpdate ($a_datetime)
	Set Last Update Date. More...

	getLastUpdate ()
	Get Last Update Date. More...

	setOwner ($a_id)
	Set Owner. More...

	getOwner ()
	Get Owner. More...

	getLastEditBy ()

	setLastEditBy ($last_edit_by)

	setRecordFieldValue ($field_id, $value)
	Set a field value. More...

	setRecordFieldValueFromForm ($field_id, &$form)
	Set a field value. More...

	getRecordFieldValueFromExcel ($excel, $row, $col, $field)

	getRecordFieldValues ()

	getRecordFieldValue ($field_id)
	Get Field Value. More...

	getRecordFieldExportValue ($field_id)
	Get Field Export Value. More...

	fillRecordFieldExcelExport ($worksheet, &$row, &$col, $field_id)

	getRecordFieldHTML ($field_id, array $options=array())

	getRecordFieldSortingValue ($field_id, array $options=array())

	fillRecordFieldFormInput ($field_id, &$form)

	getRecordField ($field_id)

	doDelete ()
	Delete. More...

	deleteFile ($obj_id)
	Delete a file. More...

	deleteMob ($obj_id)
	Delete MOB. More...

	passThroughFilter (array $filter)

	hasPermissionToEdit ($ref_id)

	hasPermissionToDelete ($ref_id)

	hasPermissionToView ($ref_id)

	getRecordFields ()

	getTable ()

	getComments ()
	Get all comments of this record. More...

Protected Member Functions
	setStandardFieldFromForm ($field_id, &$form)

	setStandardField ($field_id, $value)

	fillStandardFieldFormInput ($field_id, &$form)

	getStandardField ($field_id)

Protected Attributes
	$recordfields

	$id

	$table_id

	$table

	$last_edit_by

	$owner

	$last_update

	$create_date

	$comments

Private Member Functions
	getStandardFieldHTML ($field_id, array $options=array())

	loadRecordFields ()
	Load record fields. More...

	loadTable ()
	Load table. More...

Detailed Description

Class ilDataCollectionRecord.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Marcel Raimann mr@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; Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id:

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

Constructor & Destructor Documentation

◆ __construct()

ilDataCollectionRecord::__construct ( $a_id = 0 )

Parameters

int $a_id

Definition at line 71 of file class.ilDataCollectionRecord.php.

References doRead().

                                                {
                 if ($a_id != 0) {
                         $this->id = $a_id;
                         $this->doRead();
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ deleteField()

ilDataCollectionRecord::deleteField ( $field_id )

Parameters

$field_id

Definition at line 166 of file class.ilDataCollectionRecord.php.

References doDelete(), and loadRecordFields().

                                                {
                 $this->loadRecordFields();
                 $this->recordfields[$field_id]->delete();
                 if (count($this->recordfields) == 1) {
                         $this->doDelete();
                 }
         }

Here is the call graph for this function:

◆ deleteFile()

ilDataCollectionRecord::deleteFile ( $obj_id )

Delete a file.

Parameters

$original_id	integer
$new_fields	array($old_field_id => $new_field)
$obj_id

Definition at line 675 of file class.ilDataCollectionRecord.php.

References $file, and ilObject2\_exists().

Referenced by doDelete().

                                             {
                 if (ilObject2::_exists($obj_id, false)) {
                         $file = new ilObjFile($obj_id, false);
                         $file->delete();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteMob()

ilDataCollectionRecord::deleteMob ( $obj_id )

Delete MOB.

Parameters

$obj_id

Definition at line 688 of file class.ilDataCollectionRecord.php.

References ilObject2\_exists().

Referenced by doDelete().

                                            {
                 if (ilObject2::_exists($obj_id)) {
                         $mob = new ilObjMediaObject($obj_id);
                         $mob->delete();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCreate()

ilDataCollectionRecord::doCreate ( )

Exceptions

ilException

Definition at line 139 of file class.ilDataCollectionRecord.php.

References $id, $ilDB, $query, ilDataCollectionTable\_tableExists(), getCreateDate(), getId(), getLastEditBy(), getLastUpdate(), getOwner(), getTableId(), and setId().

                                    {
                 global $ilDB;
 
                 if (! ilDataCollectionTable::_tableExists($this->getTableId())) {
                         throw new ilException("The field does not have a related table!");
                 }
 
                 $id = $ilDB->nextId("il_dcl_record");
                 $this->setId($id);
                 $query = "INSERT INTO il_dcl_record (
                         id,
                         table_id,
                         create_date,
                         Last_update,
                         owner,
                         last_edit_by
                         ) VALUES (" . $ilDB->quote($this->getId(), "integer") . "," . $ilDB->quote($this->getTableId(), "integer") . ","
                         . $ilDB->quote($this->getCreateDate(), "timestamp") . "," . $ilDB->quote($this->getLastUpdate(), "timestamp") . ","
                         . $ilDB->quote($this->getOwner(), "integer") . "," . $ilDB->quote($this->getLastEditBy(), "integer") . "
                         )";
                 $ilDB->manipulate($query);
         }

Here is the call graph for this function:

◆ doDelete()

ilDataCollectionRecord::doDelete ( )

Delete.

Definition at line 626 of file class.ilDataCollectionRecord.php.

References $ilDB, $query, deleteFile(), deleteMob(), getId(), getTableId(), ilDataCollectionDatatype\INPUTFORMAT_FILE, ilDataCollectionDatatype\INPUTFORMAT_MOB, loadRecordFields(), and ilObjDataCollection\sendNotification().

Referenced by deleteField().

                                    {
                 global $ilDB;
 
                 $this->loadRecordFields();
                 foreach ($this->recordfields as $recordfield) {
                         if ($recordfield->getField()->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_FILE) {
                                 $this->deleteFile($recordfield->getValue());
                         }
 
                         if ($recordfield->getField()->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_MOB) {
                                 $this->deleteMob($recordfield->getValue());
                         }
 
                         $recordfield->delete();
                 }
 
                 $query = "DELETE FROM il_dcl_record WHERE id = " . $ilDB->quote($this->getId(), "integer");
                 $ilDB->manipulate($query);
 
                 ilObjDataCollection::sendNotification("delete_record", $this->getTableId(), $this->getId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doRead()

ilDataCollectionRecord::doRead ( )

Read record.

Definition at line 120 of file class.ilDataCollectionRecord.php.

References $ilDB, $query, getId(), setCreateDate(), setLastEditBy(), setLastUpdate(), setOwner(), and setTableId().

Referenced by __construct().

                                  {
                 global $ilDB;
                 //build query
                 $query = "Select * From il_dcl_record WHERE id = " . $ilDB->quote($this->getId(), "integer") . " ORDER BY id";
 
                 $set = $ilDB->query($query);
                 $rec = $ilDB->fetchAssoc($set);
 
                 $this->setTableId($rec["table_id"]);
                 $this->setCreateDate($rec["create_date"]);
                 $this->setLastUpdate($rec["last_update"]);
                 $this->setOwner($rec["owner"]);
                 $this->setLastEditBy($rec["last_edit_by"]);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilDataCollectionRecord::doUpdate ( )

doUpdate

Definition at line 82 of file class.ilDataCollectionRecord.php.

References $ilDB, getLastEditBy(), getLastUpdate(), getOwner(), getRecordFields(), getTableId(), and ilObjDataCollection\sendNotification().

                                    {
                 global $ilDB;
 
                 $ilDB->update("il_dcl_record", array(
                         "table_id" => array(
                                 "integer",
                                 $this->getTableId()
                         ),
                         "last_update" => array(
                                 "date",
                                 $this->getLastUpdate()
                         ),
                         "owner" => array(
                                 "text",
                                 $this->getOwner()
                         ),
                         "last_edit_by" => array(
                                 "text",
                                 $this->getLastEditBy()
                         )
                 ), array(
                         "id" => array(
                                 "integer",
                                 $this->id
                         )
                 ));
 
                 foreach ($this->getRecordFields() as $recordfield) {
                         $recordfield->doUpdate();
                 }
 
                 ilObjDataCollection::sendNotification("update_record", $this->getTableId(), $this->id);
         }

Here is the call graph for this function:

◆ fillRecordFieldExcelExport()

ilDataCollectionRecord::fillRecordFieldExcelExport	(		$worksheet,
		&	$row,
		&	$col,
			$field_id
	)

Parameters

$worksheet
$row
$col
$field_id

Definition at line 393 of file class.ilDataCollectionRecord.php.

References $row, ilDataCollectionStandardField\_isStandardField(), getStandardFieldHTML(), and loadRecordFields().

                                                                                         {
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         $worksheet->writeString($row, $col, $this->getStandardFieldHTML($field_id));
                         $col++;
                 } else {
                         $this->recordfields[$field_id]->fillExcelExport($worksheet, $row, $col);
                 }
         }

Here is the call graph for this function:

◆ fillRecordFieldFormInput()

ilDataCollectionRecord::fillRecordFieldFormInput	(		$field_id,
		&	$form
	)

Parameters

$field_id
$form	ilPropertyFormGUI

Definition at line 486 of file class.ilDataCollectionRecord.php.

References ilDataCollectionStandardField\_isStandardField(), fillStandardFieldFormInput(), and loadRecordFields().

                                                                     {
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         $this->fillStandardFieldFormInput($field_id, $form);
                 } else {
                         $this->recordfields[$field_id]->fillFormInput($form);
                 }
         }

Here is the call graph for this function:

◆ fillStandardFieldFormInput()

ilDataCollectionRecord::fillStandardFieldFormInput	(		$field_id,
		&	$form
	)

protected

Parameters

$field_id
$form

Definition at line 524 of file class.ilDataCollectionRecord.php.

References getStandardField().

Referenced by fillRecordFieldFormInput().

                                                                          {
                 if ($item = $form->getItemByPostVar('field_' . $field_id)) {
                         $item->setValue($this->getStandardField($field_id));
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComments()

ilDataCollectionRecord::getComments ( )

Get all comments of this record.

Returns: array ilNote[]

Definition at line 772 of file class.ilDataCollectionRecord.php.

References $comments, ilNote\_getNotesOfObject(), getId(), and IL_NOTE_PUBLIC.

Referenced by getStandardFieldHTML().

                                       {
                 if ($this->comments === NULL) {
                         $this->comments = ilNote::_getNotesOfObject($this->table->getCollectionObject()->getId(), $this->getId(), 'dcl', IL_NOTE_PUBLIC);
                 }
 
                 return $this->comments;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCreateDate()

ilDataCollectionRecord::getCreateDate ( )

Get Creation Date.

Returns: ilDateTime

Definition at line 230 of file class.ilDataCollectionRecord.php.

References $create_date.

Referenced by doCreate(), and getStandardFieldHTML().

                                         {
                 return $this->create_date;
         }

Here is the caller graph for this function:

◆ getId()

ilDataCollectionRecord::getId ( )

Get field id.

Returns: int

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

References $id.

Referenced by doCreate(), doDelete(), doRead(), getComments(), and getStandardFieldHTML().

                                 {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getLastEditBy()

ilDataCollectionRecord::getLastEditBy ( )

Definition at line 278 of file class.ilDataCollectionRecord.php.

References $last_edit_by.

Referenced by doCreate(), doUpdate(), getStandardField(), and getStandardFieldHTML().

                                         {
                 return $this->last_edit_by;
         }

Here is the caller graph for this function:

◆ getLastUpdate()

ilDataCollectionRecord::getLastUpdate ( )

Get Last Update Date.

Returns: ilDateTime

Definition at line 250 of file class.ilDataCollectionRecord.php.

References $last_update.

Referenced by doCreate(), doUpdate(), and getStandardFieldHTML().

                                         {
                 return $this->last_update;
         }

Here is the caller graph for this function:

◆ getOwner()

ilDataCollectionRecord::getOwner ( )

Get Owner.

Returns: int

Definition at line 270 of file class.ilDataCollectionRecord.php.

References $owner.

Referenced by doCreate(), ilDataCollectionTable\doesRecordBelongToUser(), doUpdate(), getStandardField(), and getStandardFieldHTML().

                                    {
                 return $this->owner;
         }

Here is the caller graph for this function:

◆ getRecordField()

ilDataCollectionRecord::getRecordField ( $field_id )

Parameters

$field_id

Returns: ilDataCollectionRecordField

Definition at line 616 of file class.ilDataCollectionRecord.php.

References loadRecordFields().

                                                   {
                 $this->loadRecordFields();
 
                 return $this->recordfields[$field_id];
         }

Here is the call graph for this function:

◆ getRecordFieldExportValue()

ilDataCollectionRecord::getRecordFieldExportValue ( $field_id )

Get Field Export Value.

Parameters

int $field_id

Returns: array

Definition at line 378 of file class.ilDataCollectionRecord.php.

References ilDataCollectionStandardField\_isStandardField(), getStandardFieldHTML(), and loadRecordFields().

                                                              {
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         return $this->getStandardFieldHTML($field_id);
                 } else {
                         return $this->recordfields[$field_id]->getExportValue();
                 }
         }

Here is the call graph for this function:

◆ getRecordFieldHTML()

ilDataCollectionRecord::getRecordFieldHTML	(		$field_id,
		array	$options = `array()`
	)

Parameters

	$field_id
array	$options

Returns: array|mixed|string

Definition at line 409 of file class.ilDataCollectionRecord.php.

References $html, $options, ilDataCollectionStandardField\_isStandardField(), getStandardFieldHTML(), and loadRecordFields().

                                                                                 {
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         $html = $this->getStandardFieldHTML($field_id, $options);
                 } else {
                         if (is_object($this->recordfields[$field_id])) {
                                 $html = $this->recordfields[$field_id]->getHTML();
                         } else {
                                 $html = '';
                         }
                 }
 
                 // This is a workaround as templating in ILIAS currently has some issues with curly brackets.see: http://www.ilias.de/mantis/view.php?id=12681#bugnotes
                 // SW 16.07.2014 Uncommented again, as some fields are outputting javascript that was broken due to entity encode the curly brackets
                 //              $html = str_ireplace("{", "&#123;", $html);
                 //              $html = str_ireplace("}", "&#125;", $html);
 
                 return $html;
         }

Here is the call graph for this function:

◆ getRecordFields()

ilDataCollectionRecord::getRecordFields ( )

Returns: ilDataCollectionRecordField[]

Definition at line 750 of file class.ilDataCollectionRecord.php.

References $recordfields, and loadRecordFields().

Referenced by doUpdate().

                                           {
                 $this->loadRecordFields();
 
                 return $this->recordfields;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordFieldSortingValue()

ilDataCollectionRecord::getRecordFieldSortingValue	(		$field_id,
		array	$options = `array()`
	)

Parameters

	$field_id
array	$options

Returns: array|mixed|string

Definition at line 436 of file class.ilDataCollectionRecord.php.

References $html, $options, ilDataCollectionStandardField\_isStandardField(), getStandardFieldHTML(), and loadRecordFields().

                                                                                         {
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         $html = $this->getStandardFieldHTML($field_id, $options);
                 } else {
                         if (is_object($this->recordfields[$field_id])) {
                                 $html = $this->recordfields[$field_id]->getSortingValue();
                         } else {
                                 $html = '';
                         }
                 }
 
                 // This is a workaround as templating in ILIAS currently has some issues with curly brackets.see: http://www.ilias.de/mantis/view.php?id=12681#bugnotes
                 // SW 16.07.2014 Uncommented again, as some fields are outputting javascript that was broken due to entity encode the curly brackets
                 //              $html = str_ireplace("{", "&#123;", $html);
                 //              $html = str_ireplace("}", "&#125;", $html);
 
                 return $html;
         }

Here is the call graph for this function:

◆ getRecordFieldValue()

ilDataCollectionRecord::getRecordFieldValue ( $field_id )

Get Field Value.

Parameters

int $field_id

Returns: array

Definition at line 358 of file class.ilDataCollectionRecord.php.

References ilDataCollectionStandardField\_isStandardField(), getStandardField(), and loadRecordFields().

Referenced by ilDataCollectionDatatype\passThroughFilter().

                                                        {
                 if ($field_id === NULL) {
                         return NULL;
                 }
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         return $this->getStandardField($field_id);
                 } else {
                         return $this->recordfields[$field_id]->getValue();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordFieldValueFromExcel()

ilDataCollectionRecord::getRecordFieldValueFromExcel	(	$excel,
		$row,
		$col,
		$field
	)

Parameters

$excel
$row
$col
$field	ilDataCollectionField

Returns: array|string

Definition at line 330 of file class.ilDataCollectionRecord.php.

References $row, and loadRecordFields().

                                                                                  {
                 $this->loadRecordFields();
                 return $this->recordfields[$field->getId()]->getValueFromExcel($excel, $row, $col);
         }

Here is the call graph for this function:

◆ getRecordFieldValues()

ilDataCollectionRecord::getRecordFieldValues ( )

Deprecated:

Returns: array

Definition at line 340 of file class.ilDataCollectionRecord.php.

References $id, and loadRecordFields().

                                                {
                 $this->loadRecordFields();
                 $return = array();
                 foreach ($this->recordfields as $id => $record_field) {
                         $return[$id] = $record_field->getValue();
                 }
 
                 return $return;
         }

Here is the call graph for this function:

◆ getStandardField()

ilDataCollectionRecord::getStandardField ( $field_id )

protected

Parameters

$field_id

Returns: int

Definition at line 536 of file class.ilDataCollectionRecord.php.

References ilObjUser\_lookupName(), getLastEditBy(), and getOwner().

Referenced by fillStandardFieldFormInput(), and getRecordFieldValue().

                                                        {
                 switch ($field_id) {
                         case "last_edit_by":
                                 return $this->getLastEditBy();
                                 break;
                         case 'owner':
                                 $usr_data = ilObjUser::_lookupName($this->getOwner());
 
                                 return $usr_data['login'];
                                 break;
                 }
 
                 return $this->$field_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStandardFieldHTML()

ilDataCollectionRecord::getStandardFieldHTML	(		$field_id,
		array	$options = `array()`
	)

private

Parameters

string	$field_id
array	$options

Returns: array|string

Definition at line 558 of file class.ilDataCollectionRecord.php.

References $_GET, ilCommonActionDispatcherGUI\buildAjaxHash(), ilDatePresentation\formatDate(), getComments(), getCreateDate(), getId(), ilUtil\getImagePath(), getLastEditBy(), getLastUpdate(), ilNoteGUI\getListCommentsJSCall(), ilUserUtil\getNamePresentation(), getOwner(), and IL_CAL_DATETIME.

Referenced by fillRecordFieldExcelExport(), getRecordFieldExportValue(), getRecordFieldHTML(), and getRecordFieldSortingValue().

                                                                                    {
                 switch ($field_id) {
                         case 'id':
                                 return $this->getId();
                         case 'owner':
                                 return ilUserUtil::getNamePresentation($this->getOwner());
                         case 'last_edit_by':
                                 return ilUserUtil::getNamePresentation($this->getLastEditBy());
                         case 'last_update':
                                 return ilDatePresentation::formatDate(new ilDateTime($this->getLastUpdate(), IL_CAL_DATETIME));
                         case 'create_date':
                                 return ilDatePresentation::formatDate(new ilDateTime($this->getCreateDate(), IL_CAL_DATETIME));
                         case 'comments':
                                 $nComments = count($this->getComments());
                                 $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(1, $_GET['ref_id'], 'dcl', $this->table->getCollectionObject()
                                         ->getId(), 'dcl', $this->getId());
                                 $ajax_link = ilNoteGUI::getListCommentsJSCall($ajax_hash, '');
 
                                 return "<a class='dcl_comment' href='#' onclick=\"return " . $ajax_link . "\">
                         <img src='" . ilUtil::getImagePath("comment_unlabeled.svg")
                                 . "' alt='{$nComments} Comments'><span class='ilHActProp'>{$nComments}</span></a>";
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTable()

ilDataCollectionRecord::getTable ( )

Returns: ilDataCollectionTable

Definition at line 760 of file class.ilDataCollectionRecord.php.

References $table, and loadTable().

Referenced by hasPermissionToDelete(), hasPermissionToEdit(), hasPermissionToView(), and ilDataCollectionRecordListGUI\recordBelongsToCollection().

                                    {
                 $this->loadTable();
 
                 return $this->table;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableId()

ilDataCollectionRecord::getTableId ( )

Get Table ID.

Returns: int

Definition at line 210 of file class.ilDataCollectionRecord.php.

References $table_id.

Referenced by ilDataCollectionRecordViewGUI\_getViewDefinitionId(), doCreate(), doDelete(), doUpdate(), ilDataCollectionRecordViewGUI\hasValidViewDefinition(), and loadTable().

                                      {
                 return $this->table_id;
         }

Here is the caller graph for this function:

◆ hasPermissionToDelete()

ilDataCollectionRecord::hasPermissionToDelete ( $ref_id )

Parameters

int $ref_id

Returns: bool

Definition at line 732 of file class.ilDataCollectionRecord.php.

References $ref_id, and getTable().

                                                        {
                 return $this->getTable()->hasPermissionToDeleteRecord($ref_id, $this);
         }

Here is the call graph for this function:

◆ hasPermissionToEdit()

ilDataCollectionRecord::hasPermissionToEdit ( $ref_id )

Parameters

int $ref_id

Returns: bool

Definition at line 722 of file class.ilDataCollectionRecord.php.

References $ref_id, and getTable().

                                                      {
                 return $this->getTable()->hasPermissionToEditRecord($ref_id, $this);
         }

Here is the call graph for this function:

◆ hasPermissionToView()

ilDataCollectionRecord::hasPermissionToView ( $ref_id )

Parameters

$ref_id

Returns: bool

Definition at line 742 of file class.ilDataCollectionRecord.php.

References $ref_id, and getTable().

                                                      {
                 return $this->getTable()->hasPermissionToViewRecord($ref_id, $this);
         }

Here is the call graph for this function:

◆ loadRecordFields()

ilDataCollectionRecord::loadRecordFields ( )

private

Load record fields.

Definition at line 586 of file class.ilDataCollectionRecord.php.

References $recordfields, ilDataCollectionCache\getRecordFieldCache(), and loadTable().

Referenced by deleteField(), doDelete(), fillRecordFieldExcelExport(), fillRecordFieldFormInput(), getRecordField(), getRecordFieldExportValue(), getRecordFieldHTML(), getRecordFields(), getRecordFieldSortingValue(), getRecordFieldValue(), getRecordFieldValueFromExcel(), getRecordFieldValues(), setRecordFieldValue(), and setRecordFieldValueFromForm().

                                             {
                 if ($this->recordfields == NULL) {
                         $this->loadTable();
                         $recordfields = array();
                         foreach ($this->table->getRecordFields() as $field) {
                                 if ($recordfields[$field->getId()] == NULL) {
                                         $recordfields[$field->getId()] = ilDataCollectionCache::getRecordFieldCache($this, $field);
                                 }
                         }
 
                         $this->recordfields = $recordfields;
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadTable()

ilDataCollectionRecord::loadTable ( )

private

Load table.

Definition at line 604 of file class.ilDataCollectionRecord.php.

References ilDataCollectionCache\getTableCache(), and getTableId().

Referenced by getTable(), loadRecordFields(), passThroughFilter(), setRecordFieldValue(), and setRecordFieldValueFromForm().

                                      {
                 if ($this->table == NULL) {
                         $this->table = ilDataCollectionCache::getTableCache($this->getTableId());
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ passThroughFilter()

ilDataCollectionRecord::passThroughFilter ( array $filter )

Parameters

array $filter

Returns: bool

Definition at line 701 of file class.ilDataCollectionRecord.php.

References loadTable(), and ilDataCollectionDatatype\passThroughFilter().

                                                          {
                 $this->loadTable();
                 // If one field returns false, the whole record does not pass the filter #performance-improvements
                 foreach ($this->table->getFilterableFields() as $field) {
                         if (! isset($filter["filter_" . $field->getId()]) || ! $filter["filter_" . $field->getId()]) {
                                 continue;
                         }
                         if (! ilDataCollectionDatatype::passThroughFilter($this, $field, $filter["filter_" . $field->getId()])) {
                                 return false;
                         }
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ setCreateDate()

ilDataCollectionRecord::setCreateDate ( $a_datetime )

Set Creation Date.

Parameters

ilDateTime $a_datetime

Definition at line 220 of file class.ilDataCollectionRecord.php.

Referenced by doRead().

                                                    {
                 $this->create_date = $a_datetime;
         }

Here is the caller graph for this function:

◆ setId()

ilDataCollectionRecord::setId ( $a_id )

Set field id.

Parameters

int $a_id

Definition at line 180 of file class.ilDataCollectionRecord.php.

Referenced by doCreate().

                                      {
                 $this->id = $a_id;
         }

Here is the caller graph for this function:

◆ setLastEditBy()

ilDataCollectionRecord::setLastEditBy ( $last_edit_by )

Definition at line 286 of file class.ilDataCollectionRecord.php.

References $last_edit_by.

Referenced by doRead(), and setStandardField().

                                                      {
                 $this->last_edit_by = $last_edit_by;
         }

Here is the caller graph for this function:

◆ setLastUpdate()

ilDataCollectionRecord::setLastUpdate ( $a_datetime )

Set Last Update Date.

Parameters

ilDateTime $a_datetime

Definition at line 240 of file class.ilDataCollectionRecord.php.

Referenced by doRead().

                                                    {
                 $this->last_update = $a_datetime;
         }

Here is the caller graph for this function:

◆ setOwner()

ilDataCollectionRecord::setOwner ( $a_id )

Set Owner.

Parameters

int $a_id

Definition at line 260 of file class.ilDataCollectionRecord.php.

Referenced by doRead().

                                         {
                 $this->owner = $a_id;
         }

Here is the caller graph for this function:

◆ setRecordFieldValue()

ilDataCollectionRecord::setRecordFieldValue	(	$field_id,
		$value
	)

Set a field value.

Parameters

int	$field_id
string	$value

Definition at line 297 of file class.ilDataCollectionRecord.php.

References ilDataCollectionStandardField\_isStandardField(), loadRecordFields(), loadTable(), and setStandardField().

                                                                {
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         $this->setStandardField($field_id, $value);
                 } else {
                         $this->loadTable();
                         $this->recordfields[$field_id]->setValue($value);
                 }
         }

Here is the call graph for this function:

◆ setRecordFieldValueFromForm()

ilDataCollectionRecord::setRecordFieldValueFromForm	(		$field_id,
		&	$form
	)

Set a field value.

Parameters

int	$field_id
string	$value

Definition at line 313 of file class.ilDataCollectionRecord.php.

References ilDataCollectionStandardField\_isStandardField(), loadRecordFields(), loadTable(), and setStandardFieldFromForm().

                                                                        {
                 $this->loadRecordFields();
                 if (ilDataCollectionStandardField::_isStandardField($field_id)) {
                         $this->setStandardFieldFromForm($field_id, $form);
                 } else {
                         $this->loadTable();
                         $this->recordfields[$field_id]->setValueFromForm($form);
                 }
         }

Here is the call graph for this function:

◆ setStandardField()

ilDataCollectionRecord::setStandardField	(	$field_id,
		$value
	)

protected

Parameters

$field_id
$value

Definition at line 510 of file class.ilDataCollectionRecord.php.

References setLastEditBy().

Referenced by setRecordFieldValue(), and setStandardFieldFromForm().

                                                                {
                 switch ($field_id) {
                         case "last_edit_by":
                                 $this->setLastEditBy($value);
 
                                 return;
                 }
                 $this->$field_id = $value;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStandardFieldFromForm()

ilDataCollectionRecord::setStandardFieldFromForm	(		$field_id,
		&	$form
	)

protected

Parameters

	$field_id
ilPropertyFormGUI	$form

Definition at line 500 of file class.ilDataCollectionRecord.php.

References setStandardField().

Referenced by setRecordFieldValueFromForm().

                                                                        {
                 if ($item = $form->getItemByPostVar("field_".$field_id)) {
                         $this->setStandardField($item->getValue());
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTableId()

ilDataCollectionRecord::setTableId ( $a_id )

Set Table ID.

Parameters

int $a_id

Definition at line 200 of file class.ilDataCollectionRecord.php.

Referenced by doRead().

                                           {
                 $this->table_id = $a_id;
         }

Here is the caller graph for this function:

Field Documentation

◆ $comments

ilDataCollectionRecord::$comments

protected

Definition at line 65 of file class.ilDataCollectionRecord.php.

Referenced by getComments().

◆ $create_date

ilDataCollectionRecord::$create_date

protected

Definition at line 61 of file class.ilDataCollectionRecord.php.

Referenced by getCreateDate().

◆ $id

ilDataCollectionRecord::$id

protected

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

Referenced by doCreate(), getId(), and getRecordFieldValues().

◆ $last_edit_by

ilDataCollectionRecord::$last_edit_by

protected

Definition at line 49 of file class.ilDataCollectionRecord.php.

Referenced by getLastEditBy(), and setLastEditBy().

◆ $last_update

ilDataCollectionRecord::$last_update

protected

Definition at line 57 of file class.ilDataCollectionRecord.php.

Referenced by getLastUpdate().

◆ $owner

ilDataCollectionRecord::$owner

protected

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

Referenced by getOwner().

◆ $recordfields

ilDataCollectionRecord::$recordfields

protected

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

Referenced by getRecordFields(), and loadRecordFields().

◆ $table

ilDataCollectionRecord::$table

protected

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

Referenced by getTable().

◆ $table_id

ilDataCollectionRecord::$table_id

protected

Definition at line 39 of file class.ilDataCollectionRecord.php.

Referenced by getTableId().

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

Modules/DataCollection/classes/class.ilDataCollectionRecord.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteField()

◆ deleteFile()

◆ deleteMob()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ fillRecordFieldExcelExport()

◆ fillRecordFieldFormInput()

◆ fillStandardFieldFormInput()

◆ getComments()

◆ getCreateDate()

◆ getId()

◆ getLastEditBy()

◆ getLastUpdate()

◆ getOwner()

◆ getRecordField()

◆ getRecordFieldExportValue()

◆ getRecordFieldHTML()

◆ getRecordFields()

◆ getRecordFieldSortingValue()

◆ getRecordFieldValue()

◆ getRecordFieldValueFromExcel()

◆ getRecordFieldValues()

◆ getStandardField()

◆ getStandardFieldHTML()

◆ getTable()

◆ getTableId()

◆ hasPermissionToDelete()

◆ hasPermissionToEdit()

◆ hasPermissionToView()

◆ loadRecordFields()

◆ loadTable()

◆ passThroughFilter()

◆ setCreateDate()

◆ setId()

◆ setLastEditBy()

◆ setLastUpdate()

◆ setOwner()

◆ setRecordFieldValue()

◆ setRecordFieldValueFromForm()

◆ setStandardField()

◆ setStandardFieldFromForm()

◆ setTableId()

Field Documentation

◆ $comments

◆ $create_date

◆ $id

◆ $last_edit_by

◆ $last_update

◆ $owner

◆ $recordfields

◆ $table

◆ $table_id