ilDclBaseRecordModel Class Reference

Collaboration diagram for ilDclBaseRecordModel:

Public Member Functions
	__construct (?int $a_id=0)
	doUpdate (bool $omit_notification=false)
	doRead ()
	doCreate ()
	deleteField (int $field_id)
	setId (int $a_id)
	getId ()
	setTableId (int $a_id)
	getTableId ()
	setCreateDate (ilDateTime $a_datetime)
	getCreateDate ()
	setLastUpdate (ilDateTime $a_datetime)
	getLastUpdate ()
	setOwner (int $a_id)
	getOwner ()
	getLastEditBy ()
	setLastEditBy (?int $last_edit_by)
	setRecordFieldValue ($field_id, $value)
	setRecordFieldValueFromForm (int $field_id, ilPropertyFormGUI $form)
	Set a field value. More...
	getRecordFieldValueFromExcel (ilExcel $excel, int $row, int $col, ilDclBaseFieldModel $field)
	setStandardFieldValueFromExcel (ilExcel $excel, int $row, int $col, ilDclBaseFieldModel $field)
	getRecordFieldValues ()
	getRecordFieldValue (?string $field_id)
	Get Field Value. More...
	getRecordFieldRepresentationValue ($field_id)
	Get Field Value for Representation in a Form. More...
	getRecordFieldExportValue ($field_id)
	Get Field Export Value. More...
	getRecordFieldPlainText ($field_id)
	Get Field Export Value. More...
	fillRecordFieldExcelExport (ilExcel $worksheet, int &$row, int &$col, $field_id)
	getRecordFieldFormulaValue ($field_id)
	getRecordFieldHTML ($field_id, array $options=[])
	getRecordFieldSortingValue ($field_id, array $options=[])
	fillRecordFieldFormInput ($field_id, ilPropertyFormGUI $form)
	getStandardFieldFormulaValue ($field_id)
	getStandardFieldHTML (string $field_id, array $options=[])
	getStandardFieldPlainText (string $field_id)
	getRecordField (int $field_id)
	doDelete (bool $omit_notification=false)
	cloneStructure (int $original_id, array $new_fields)
	deleteFile (int $obj_id)
	deleteMob (int $obj_id)
	hasPermissionToEdit (int $ref_id)
	hasPermissionToDelete (int $ref_id)
	hasPermissionToView (int $ref_id)
	getRecordFields ()
	getTable ()
	getNrOfComments ()
	Get nr of comments of this record. More...

Protected Member Functions
	setStandardFieldFromForm ($field_id, ilPropertyFormGUI $form)
	setStandardField ($field_id, $value)
	fillStandardFieldFormInput ($field_id, ilPropertyFormGUI $form)
	getStandardField ($field_id)

Protected Attributes
ILIAS UI Factory	$ui_factory
ILIAS UI Renderer	$renderer
Service	$notes
array	$recordfields = null
int	$id = 0
int	$table_id
ilDclTable	$table = null
int	$last_edit_by = null
int	$owner = 0
ilDateTime	$last_update
ilDateTime	$create_date
int	$nr_of_comments = null
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ilDBInterface	$db
ilAppEventHandler	$event

Private Member Functions
	loadRecordFields ()
	loadTable ()

Private Attributes
ilObjUser	$user

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDclBaseRecordModel::__construct

(

?int

$a_id = 0

)

Definition at line 47 of file class.ilDclBaseRecordModel.php.

References $DIC, doRead(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), renderer(), and ILIAS\Repository\user().

    {
        global $DIC;
        $this->db = $DIC->database();
        $this->event = $DIC->event();
        $this->user = $DIC->user();
        $this->ui_factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();

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

        $this->notes = $DIC->notes();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
    }

Here is the call graph for this function:

Member Function Documentation

cloneStructure()

ilDclBaseRecordModel::cloneStructure	(	int	$original_id,
		array	$new_fields
	)

Definition at line 668 of file class.ilDclBaseRecordModel.php.

References doCreate(), getId(), ilDclCache\getRecordCache(), ilDclCache\getRecordFieldCache(), ilDclCache\setCloneOf(), setCreateDate(), setLastEditBy(), setLastUpdate(), setOwner(), and ilDclCache\TYPE_RECORD.

                                                                       : void
    {
        $original = ilDclCache::getRecordCache($original_id);
        $this->setCreateDate($original->getCreateDate());
        $this->setLastEditBy($original->getLastEditBy());
        $this->setLastUpdate($original->getLastUpdate());
        $this->setOwner($original->getOwner());
        $this->doCreate();
        foreach ($new_fields as $old => $new) {
            $old_rec_field = $original->getRecordField($old);
            $new_rec_field = ilDclCache::getRecordFieldCache($this, $new);
            $new_rec_field->cloneStructure($old_rec_field);
            $this->recordfields[] = $new_rec_field;
        }

        // mandatory for all cloning functions
        ilDclCache::setCloneOf($original_id, $this->getId(), ilDclCache::TYPE_RECORD);
    }

Here is the call graph for this function:

deleteField()

ilDclBaseRecordModel::deleteField

(

int

$field_id

)

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

References doDelete(), and loadRecordFields().

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

Here is the call graph for this function:

deleteFile()

ilDclBaseRecordModel::deleteFile

(

int

$obj_id

)

Definition at line 687 of file class.ilDclBaseRecordModel.php.

References ilObject\_exists().

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

Here is the call graph for this function:

deleteMob()

ilDclBaseRecordModel::deleteMob

(

int

$obj_id

)

Definition at line 695 of file class.ilDclBaseRecordModel.php.

References ilObject\_lookupObjId().

Referenced by doDelete().

                                          : void
    {
        if (ilObject2::_lookupObjId($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()

ilDclBaseRecordModel::doCreate

(

)

Exceptions

ilException

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

References ilDclTable\_tableExists(), getCreateDate(), getId(), getLastEditBy(), getLastUpdate(), getOwner(), getRecordFields(), getTable(), getTableId(), IL_CAL_DATETIME, loadRecordFields(), and setId().

Referenced by cloneStructure(), and ilDclRecordEditGUI\save().

                              : void
    {
        if (!ilDclTable::_tableExists($this->getTableId())) {
            throw new ilException("The field does not have a related table!");
        }

        $id = $this->db->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 (" . $this->db->quote($this->getId(), "integer") . "," . $this->db->quote(
                $this->getTableId(),
                "integer"
            ) . ","
            . $this->db->quote($this->getCreateDate()->get(IL_CAL_DATETIME), "timestamp") . "," . $this->db->quote(
                $this->getLastUpdate()->get(IL_CAL_DATETIME),
                "timestamp"
            ) . ","
            . $this->db->quote($this->getOwner(), "integer") . "," . $this->db->quote($this->getLastEditBy(), "integer") . "
                        )";
        $this->db->manipulate($query);

        $this->loadRecordFields();
        foreach ($this->getRecordFields() as $recordField) {
            $recordField->doCreate();
        }

        $this->getTable()->loadRecords();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doDelete()

ilDclBaseRecordModel::doDelete

(

bool

$omit_notification = false

)

Definition at line 633 of file class.ilDclBaseRecordModel.php.

References $ref_id, deleteMob(), getId(), ilDclCache\getTableCache(), getTableId(), ILIAS\FileDelivery\http(), ilDclDatatype\INPUTFORMAT_MOB, loadRecordFields(), and ILIAS\Repository\refinery().

Referenced by ilDclRecordEditGUI\delete(), and deleteField().

                                                             : void
    {
        $this->loadRecordFields();
        foreach ($this->recordfields as $recordfield) {
            if ($recordfield->getField()->getDatatypeId() == ilDclDatatype::INPUTFORMAT_MOB) {
                $this->deleteMob((int) $recordfield->getValue());
            }

            $recordfield->delete();
        }

        $query = "DELETE FROM il_dcl_record WHERE id = " . $this->db->quote($this->getId(), "integer");
        $this->db->manipulate($query);

        $this->table->loadRecords();

        if (!$omit_notification) {
            $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
            $objDataCollection = new ilObjDataCollection($ref_id);
            $objDataCollection->sendNotification("delete_record", $this->getTableId(), $this->getId());

            $this->event->raise(
                'components/ILIAS/DataCollection',
                'deleteRecord',
                [
                    'dcl' => ilDclCache::getTableCache($this->getTableId())->getCollectionObject(),
                    'table_id' => $this->table_id,
                    'record_id' => $this->getId(),
                    'record' => $this,
                ]
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doRead()

ilDclBaseRecordModel::doRead

(

)

Definition at line 109 of file class.ilDclBaseRecordModel.php.

References getId(), IL_CAL_DATETIME, loadTable(), null, setCreateDate(), setLastEditBy(), setLastUpdate(), setOwner(), and setTableId().

Referenced by __construct().

                            : void
    {
        //build query
        $query = "Select * From il_dcl_record WHERE id = " . $this->db->quote($this->getId(), "integer") . " ORDER BY id";

        $set = $this->db->query($query);
        $rec = $this->db->fetchAssoc($set);

        if (!$rec) {
            $this->id = 0;
            return;
        }

        $this->setTableId((int) $rec["table_id"]);
        $this->loadTable();
        if (null !== $rec["create_date"]) {
            $this->setCreateDate(new ilDateTime($rec["create_date"], IL_CAL_DATETIME));
        }
        if (null !== $rec["last_update"]) {
            $this->setLastUpdate(new ilDateTime($rec["last_update"], IL_CAL_DATETIME));
        } else {
            $this->setLastUpdate(new ilDateTime($rec["create_date"], IL_CAL_DATETIME));
        }
        $this->setOwner((int) $rec["owner"]);
        if (null !== $rec["last_edit_by"]) {
            $this->setLastEditBy((int) $rec["last_edit_by"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doUpdate()

ilDclBaseRecordModel::doUpdate

(

bool

$omit_notification = false

)

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

References $ref_id, getLastEditBy(), getLastUpdate(), getOwner(), getRecordFields(), getTableId(), ILIAS\FileDelivery\http(), IL_CAL_DATETIME, and ILIAS\Repository\refinery().

Referenced by ilDclRecordEditGUI\save().

                                                             : void
    {
        $values = [
            "table_id" => [
                "integer",
                $this->getTableId(),
            ],
            "last_update" => [
                "date",
                $this->getLastUpdate()->get(IL_CAL_DATETIME),
            ],
            "owner" => [
                "integer",
                $this->getOwner(),
            ],
            "last_edit_by" => [
                "integer",
                $this->getLastEditBy(),
            ],
        ];
        $this->db->update(
            "il_dcl_record",
            $values,
            [
                "id" => [
                    "integer",
                    $this->id,
                ],
            ]
        );

        foreach ($this->getRecordFields() as $recordfield) {
            $recordfield->doUpdate();
        }

        //TODO: add event raise
        if (!$omit_notification) {
            $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
            $objDataCollection = new ilObjDataCollection($ref_id);
            $objDataCollection->sendNotification("update_record", $this->getTableId(), $this->id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillRecordFieldExcelExport()

ilDclBaseRecordModel::fillRecordFieldExcelExport	(	ilExcel	$worksheet,
		int &	$row,
		int &	$col,
			$field_id
	)

Parameters

int | string

$field_id

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

References ilDclStandardField\_isStandardField(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), getCreateDate(), getLastUpdate(), getOwner(), getStandardFieldHTML(), IL_CAL_DATETIME, loadRecordFields(), ilExcel\setCell(), and ILIAS\Repository\user().

Referenced by ilDclContentExporter\fillRowExcel().

                                                                                                   : void
    {
        $this->loadRecordFields();
        if (ilDclStandardField::_isStandardField($field_id)) {
            if ($field_id === 'owner') {
                $worksheet->setCell($row, $col, ilObjUser::_lookupLogin($this->getOwner()));
                $col++;
                $name_array = ilObjUser::_lookupName($this->getOwner());
                $worksheet->setCell($row, $col, $name_array['lastname'] . ', ' . $name_array['firstname']);
            } elseif ($field_id === 'last_update') {
                $date_time = $this->getLastUpdate()->get(IL_CAL_DATETIME, '', $this->user->getTimeZone());
                $worksheet->setCell($row, $col, $date_time);
            } elseif ($field_id === 'create_date') {
                $date_time = $this->getCreateDate()->get(IL_CAL_DATETIME, '', $this->user->getTimeZone());
                $worksheet->setCell($row, $col, $date_time);
            } else {
                $worksheet->setCell($row, $col, $this->getStandardFieldHTML($field_id));
            }
            $col++;
        } else {
            $this->recordfields[$field_id]->fillExcelExport($worksheet, $row, $col);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillRecordFieldFormInput()

ilDclBaseRecordModel::fillRecordFieldFormInput	(		$field_id,
		ilPropertyFormGUI	$form
	)

Parameters

int | string

$field_id

Definition at line 483 of file class.ilDclBaseRecordModel.php.

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

Referenced by ilDclRecordEditGUI\sendFailure().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fillStandardFieldFormInput()

ilDclBaseRecordModel::fillStandardFieldFormInput (   $field_id, ilPropertyFormGUI  $form  )

protected

Parameters

int | string

$field_id

Definition at line 519 of file class.ilDclBaseRecordModel.php.

References ilPropertyFormGUI\getItemByPostVar(), and getStandardField().

Referenced by fillRecordFieldFormInput().

                                                                                     : void
    {
        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:

getCreateDate()

ilDclBaseRecordModel::getCreateDate

(

)

Definition at line 211 of file class.ilDclBaseRecordModel.php.

References $create_date.

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

                                   : ilDateTime
    {
        return $this->create_date;
    }

Here is the caller graph for this function:

getId()

ilDclBaseRecordModel::getId

(

)

Definition at line 191 of file class.ilDclBaseRecordModel.php.

References $id.

Referenced by cloneStructure(), ilDclRecordEditGUI\confirmDelete(), doCreate(), doDelete(), doRead(), ilDclReferenceRecordRepresentation\getLinkHTML(), getNrOfComments(), ilDclReferenceRecordFieldModel\getReferenceFromValue(), getStandardFieldHTML(), ilDclRecordEditGUI\save(), and ilDclRecordEditGUI\sendFailure().

                           : ?int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getLastEditBy()

ilDclBaseRecordModel::getLastEditBy

(

)

Definition at line 236 of file class.ilDclBaseRecordModel.php.

References $last_edit_by.

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

                                   : ?int
    {
        return $this->last_edit_by;
    }

Here is the caller graph for this function:

getLastUpdate()

ilDclBaseRecordModel::getLastUpdate

(

)

Definition at line 221 of file class.ilDclBaseRecordModel.php.

References $last_update.

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

                                   : ilDateTime
    {
        return $this->last_update;
    }

Here is the caller graph for this function:

getNrOfComments()

ilDclBaseRecordModel::getNrOfComments

(

)

Get nr of comments of this record.

Definition at line 738 of file class.ilDclBaseRecordModel.php.

References $context, $nr_of_comments, getId(), and null.

Referenced by getStandardFieldHTML(), and getStandardFieldPlainText().

                                     : int
    {
        if ($this->nr_of_comments === null) {
            $context = $this->notes
                ->data()
                ->context(
                    $this->table->getCollectionObject()->getId(),
                    $this->getId(),
                    'dcl'
                );
            $this->nr_of_comments = $this->notes
                ->domain()
                ->getNrOfCommentsForContext($context);
        }

        return $this->nr_of_comments;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOwner()

ilDclBaseRecordModel::getOwner

(

)

Definition at line 231 of file class.ilDclBaseRecordModel.php.

References $owner.

Referenced by doCreate(), ilDclTable\doesRecordBelongToUser(), doUpdate(), fillRecordFieldExcelExport(), getStandardField(), getStandardFieldHTML(), and ilDclTable\hasPermissionToViewRecord().

                              : int
    {
        return $this->owner;
    }

Here is the caller graph for this function:

getRecordField()

ilDclBaseRecordModel::getRecordField

(

int

$field_id

)

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

References loadRecordFields().

Referenced by ilDclRecordEditGUI\cancelSave(), and ilDclReferenceRecordFieldModel\getReferenceFromValue().

                                                 : ilDclBaseRecordFieldModel
    {
        $this->loadRecordFields();

        return $this->recordfields[$field_id];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordFieldExportValue()

ilDclBaseRecordModel::getRecordFieldExportValue

(

$field_id

)

Get Field Export Value.

Parameters

?int|string

$field_id

Returns

int|string

Definition at line 350 of file class.ilDclBaseRecordModel.php.

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

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

Here is the call graph for this function:

getRecordFieldFormulaValue()

ilDclBaseRecordModel::getRecordFieldFormulaValue

(

$field_id

)

Parameters

int | string

$field_id

Definition at line 405 of file class.ilDclBaseRecordModel.php.

References ilDclStandardField\_isStandardField(), getStandardFieldFormulaValue(), and loadRecordFields().

                                                         : string
    {
        $this->loadRecordFields();
        if (ilDclStandardField::_isStandardField($field_id)) {
            $value = $this->getStandardFieldFormulaValue($field_id);
        } else {
            if (is_object($this->recordfields[$field_id])) {
                $value = $this->recordfields[$field_id]->getFormulaValue();
            } else {
                $value = '';
            }
        }

        return $value;
    }

Here is the call graph for this function:

getRecordFieldHTML()

ilDclBaseRecordModel::getRecordFieldHTML	(		$field_id,
		array	$options = []
	)

Parameters

int | string

$field_id

Definition at line 424 of file class.ilDclBaseRecordModel.php.

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

Referenced by ilDclReferenceRecordRepresentation\getLinkHTML().

                                                                      : string
    {
        $this->loadRecordFields();
        if (ilDclStandardField::_isStandardField($field_id)) {
            $html = $this->getStandardFieldHTML($field_id, $options);
        } else {
            if (array_key_exists($field_id, $this->recordfields) && is_object($this->recordfields[$field_id])) {
                $html = $this->recordfields[$field_id]->getRecordRepresentation()->getHTML(true, $options);
            } else {
                $html = '';
            }
        }

        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordFieldPlainText()

ilDclBaseRecordModel::getRecordFieldPlainText

(

$field_id

)

Get Field Export Value.

Parameters

int | string

$field_id

Returns

int|string

Definition at line 365 of file class.ilDclBaseRecordModel.php.

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

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

Here is the call graph for this function:

getRecordFieldRepresentationValue()

ilDclBaseRecordModel::getRecordFieldRepresentationValue

(

$field_id

)

Get Field Value for Representation in a Form.

Parameters

?int|string

$field_id

Returns

array|int|null|string

Definition at line 332 of file class.ilDclBaseRecordModel.php.

References ilDclStandardField\_isStandardField(), getStandardField(), loadRecordFields(), and null.

    {
        if ($field_id === null) {
            return null;
        }
        $this->loadRecordFields();
        if (ilDclStandardField::_isStandardField($field_id)) {
            return $this->getStandardField($field_id);
        } else {
            return $this->recordfields[$field_id]->getValueForRepresentation();
        }
    }

Here is the call graph for this function:

getRecordFields()

ilDclBaseRecordModel::getRecordFields

(

)

Returns

ilDclBaseRecordFieldModel[]

Definition at line 721 of file class.ilDclBaseRecordModel.php.

References $recordfields, and loadRecordFields().

Referenced by doCreate(), and doUpdate().

                                     : array
    {
        $this->loadRecordFields();

        return $this->recordfields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordFieldSortingValue()

ilDclBaseRecordModel::getRecordFieldSortingValue	(		$field_id,
		array	$options = []
	)

Parameters

int | string

$field_id

Definition at line 443 of file class.ilDclBaseRecordModel.php.

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

                                                                              : string
    {
        $this->loadRecordFields();
        if (ilDclStandardField::_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 = '';
            }
        }

        return $html;
    }

Here is the call graph for this function:

getRecordFieldValue()

ilDclBaseRecordModel::getRecordFieldValue

(

?string

$field_id

)

Get Field Value.

Returns

int|string|array|null

Definition at line 314 of file class.ilDclBaseRecordModel.php.

References ilDclStandardField\_isStandardField(), getStandardField(), loadRecordFields(), and null.

Referenced by ilDclMobFieldRepresentation\passThroughFilter(), ilDclTextFieldRepresentation\passThroughFilter(), ilDclDatetimeFieldRepresentation\passThroughFilter(), ilDclRatingFieldRepresentation\passThroughFilter(), ilDclBooleanFieldRepresentation\passThroughFilter(), ilDclIliasReferenceFieldRepresentation\passThroughFilter(), ilDclNumberFieldRepresentation\passThroughFilter(), ilDclBaseFieldRepresentation\passThroughFilter(), ilDclCopyFieldRepresentation\passThroughFilter(), and ilDclReferenceFieldRepresentation\passThroughFilter().

    {
        if ($field_id === null) {
            return null;
        }
        $this->loadRecordFields();
        if (ilDclStandardField::_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()

ilDclBaseRecordModel::getRecordFieldValueFromExcel	(	ilExcel	$excel,
		int	$row,
		int	$col,
		ilDclBaseFieldModel	$field
	)

Returns

int|string

Definition at line 280 of file class.ilDclBaseRecordModel.php.

References ilDclBaseFieldModel\getId(), and loadRecordFields().

    {
        $this->loadRecordFields();

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

Here is the call graph for this function:

getRecordFieldValues()

ilDclBaseRecordModel::getRecordFieldValues

(

)

Definition at line 299 of file class.ilDclBaseRecordModel.php.

References $id, and loadRecordFields().

Referenced by ilDclRecordEditGUI\getRecordData().

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

        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardField()

ilDclBaseRecordModel::getStandardField (   $field_id )

protected

Parameters

int | string

$field_id

Definition at line 529 of file class.ilDclBaseRecordModel.php.

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

Referenced by fillStandardFieldFormInput(), getRecordFieldRepresentationValue(), and getRecordFieldValue().

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

        return $this->{$field_id};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardFieldFormulaValue()

ilDclBaseRecordModel::getStandardFieldFormulaValue

(

$field_id

)

Parameters

int | string

$field_id

Definition at line 544 of file class.ilDclBaseRecordModel.php.

References getStandardFieldHTML().

Referenced by getRecordFieldFormulaValue().

                                                           : string
    {
        return $this->getStandardFieldHTML($field_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardFieldHTML()

ilDclBaseRecordModel::getStandardFieldHTML	(	string	$field_id,
		array	$options = []
	)

Definition at line 549 of file class.ilDclBaseRecordModel.php.

References $ref_id, ilCommonActionDispatcherGUI\buildAjaxHash(), ilDatePresentation\formatDate(), getCreateDate(), getId(), getLastEditBy(), getLastUpdate(), ilNoteGUI\getListCommentsJSCall(), ilUserUtil\getNamePresentation(), getNrOfComments(), getOwner(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), renderer(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

Referenced by fillRecordFieldExcelExport(), getRecordFieldExportValue(), getRecordFieldHTML(), getRecordFieldPlainText(), getRecordFieldSortingValue(), getStandardFieldFormulaValue(), and getStandardFieldPlainText().

                                                                               : string
    {
        switch ($field_id) {
            case 'id':
                return (string) $this->getId();
            case 'owner':
                return ilUserUtil::getNamePresentation($this->getOwner());
            case 'last_edit_by':
                return ilUserUtil::getNamePresentation($this->getLastEditBy());
            case 'last_update':
                return ilDatePresentation::formatDate($this->getLastUpdate());
            case 'create_date':
                return ilDatePresentation::formatDate($this->getCreateDate());
            case 'comments':

                $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());

                $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(
                    1,
                    $ref_id,
                    'dcl',
                    $this->table->getCollectionObject()
                                ->getId(),
                    'dcl',
                    $this->getId()
                );
                $update_code = "il.UI.counter.getCounterObject($(\".ilc_page_Page\")).incrementStatusCount(1);";
                $ajax_link = ilNoteGUI::getListCommentsJSCall($ajax_hash, $update_code);
                $nr_comments = $this->getNrOfComments();

                $comment_glyph = $this->ui_factory->symbol()->glyph()->comment()->withCounter(
                    $this->ui_factory->counter()->status($nr_comments)
                )->withAdditionalOnLoadCode(function ($id) use ($ajax_link): string {
                    return "document.getElementById('$id').onclick = function (event) { $ajax_link; };";
                });
                return $this->renderer->render($comment_glyph);
        }

        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardFieldPlainText()

ilDclBaseRecordModel::getStandardFieldPlainText

(

string

$field_id

)

Parameters

string

$field_id

Returns

int|string

Definition at line 594 of file class.ilDclBaseRecordModel.php.

References getNrOfComments(), and getStandardFieldHTML().

    {
        switch ($field_id) {
            case 'comments':
                return $this->getNrOfComments();
            default:
                return strip_tags($this->getStandardFieldHTML($field_id));
        }
    }

Here is the call graph for this function:

getTable()

ilDclBaseRecordModel::getTable

(

)

Definition at line 728 of file class.ilDclBaseRecordModel.php.

References $table, and loadTable().

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

                              : ilDclTable
    {
        $this->loadTable();

        return $this->table;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTableId()

ilDclBaseRecordModel::getTableId

(

)

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

References $table_id.

Referenced by doCreate(), doDelete(), doUpdate(), ilDclReferenceRecordRepresentation\getLinkHTML(), and loadTable().

                                : int
    {
        return $this->table_id;
    }

Here is the caller graph for this function:

hasPermissionToDelete()

ilDclBaseRecordModel::hasPermissionToDelete

(

int

$ref_id

)

Definition at line 708 of file class.ilDclBaseRecordModel.php.

References getTable().

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

Here is the call graph for this function:

hasPermissionToEdit()

ilDclBaseRecordModel::hasPermissionToEdit

(

int

$ref_id

)

Definition at line 703 of file class.ilDclBaseRecordModel.php.

References getTable().

Referenced by ilDclRecordEditGUI\save().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasPermissionToView()

ilDclBaseRecordModel::hasPermissionToView

(

int

$ref_id

)

Definition at line 713 of file class.ilDclBaseRecordModel.php.

References getTable().

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

Here is the call graph for this function:

loadRecordFields()

ilDclBaseRecordModel::loadRecordFields ( )

private

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

References $recordfields, ilDclCache\getRecordFieldCache(), loadTable(), and null.

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

                                       : void
    {
        if ($this->recordfields == null) {
            $this->loadTable();
            $recordfields = [];
            foreach ($this->table->getRecordFields() as $field) {
                if (($recordfields[$field->getId()] ?? null) === null) {
                    $recordfields[$field->getId()] = ilDclCache::getRecordFieldCache($this, $field);
                }
            }

            $this->recordfields = $recordfields;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadTable()

ilDclBaseRecordModel::loadTable ( )

private

Definition at line 619 of file class.ilDclBaseRecordModel.php.

References ilDclCache\getTableCache(), getTableId(), and null.

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

                                : void
    {
        if ($this->table === null) {
            $this->table = ilDclCache::getTableCache($this->getTableId());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCreateDate()

ilDclBaseRecordModel::setCreateDate

(

ilDateTime

$a_datetime

)

Definition at line 206 of file class.ilDclBaseRecordModel.php.

Referenced by cloneStructure(), doRead(), and ilDclRecordEditGUI\save().

                                                         : void
    {
        $this->create_date = $a_datetime;
    }

Here is the caller graph for this function:

setId()

ilDclBaseRecordModel::setId

(

int

$a_id

)

Definition at line 186 of file class.ilDclBaseRecordModel.php.

Referenced by doCreate().

                                    : void
    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setLastEditBy()

ilDclBaseRecordModel::setLastEditBy

(

?int

$last_edit_by

)

Definition at line 241 of file class.ilDclBaseRecordModel.php.

References $last_edit_by.

Referenced by ilDclRecordEditGUI\cancelSave(), cloneStructure(), doRead(), ilDclRecordEditGUI\save(), and setStandardField().

                                                     : void
    {
        $this->last_edit_by = $last_edit_by;
    }

Here is the caller graph for this function:

setLastUpdate()

ilDclBaseRecordModel::setLastUpdate

(

ilDateTime

$a_datetime

)

Definition at line 216 of file class.ilDclBaseRecordModel.php.

Referenced by ilDclRecordEditGUI\cancelSave(), cloneStructure(), doRead(), and ilDclRecordEditGUI\save().

                                                         : void
    {
        $this->last_update = $a_datetime;
    }

Here is the caller graph for this function:

setOwner()

ilDclBaseRecordModel::setOwner

(

int

$a_id

)

Definition at line 226 of file class.ilDclBaseRecordModel.php.

Referenced by cloneStructure(), doRead(), and ilDclRecordEditGUI\save().

                                       : void
    {
        $this->owner = $a_id;
    }

Here is the caller graph for this function:

setRecordFieldValue()

ilDclBaseRecordModel::setRecordFieldValue	(		$field_id,
			$value
	)

Parameters

int | string	$field_id
int | string	$value

Returns

void

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

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

Referenced by ilDclRecordEditGUI\save().

                                                          : void
    {
        $this->loadRecordFields();
        if (ilDclStandardField::_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:

Here is the caller graph for this function:

setRecordFieldValueFromForm()

ilDclBaseRecordModel::setRecordFieldValueFromForm	(	int	$field_id,
		ilPropertyFormGUI	$form
	)

Set a field value.

Parameters

int | string

$field_id

Definition at line 266 of file class.ilDclBaseRecordModel.php.

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

Referenced by ilDclRecordEditGUI\save().

                                                                                       : void
    {
        $this->loadRecordFields();
        if (ilDclStandardField::_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:

Here is the caller graph for this function:

setStandardField()

ilDclBaseRecordModel::setStandardField (   $field_id,   $value  )

protected

Parameters

int | string	$field_id
int | string	$value

Definition at line 507 of file class.ilDclBaseRecordModel.php.

References setLastEditBy().

Referenced by setRecordFieldValue(), and setStandardFieldFromForm().

    {
        if ($field_id == "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()

ilDclBaseRecordModel::setStandardFieldFromForm (   $field_id, ilPropertyFormGUI  $form  )

protected

Parameters

int | string

$field_id

Definition at line 496 of file class.ilDclBaseRecordModel.php.

References ilPropertyFormGUI\getItemByPostVar(), and setStandardField().

Referenced by setRecordFieldValueFromForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setStandardFieldValueFromExcel()

ilDclBaseRecordModel::setStandardFieldValueFromExcel	(	ilExcel	$excel,
		int	$row,
		int	$col,
		ilDclBaseFieldModel	$field
	)

Definition at line 287 of file class.ilDclBaseRecordModel.php.

References ilDclBaseFieldModel\getId().

     : void {
        $value = $field->getValueFromExcel($excel, $row, $col);
        if ($value) {
            $this->{$field->getId()} = $value;
        }
    }

Here is the call graph for this function:

setTableId()

ilDclBaseRecordModel::setTableId

(

int

$a_id

)

Definition at line 196 of file class.ilDclBaseRecordModel.php.

Referenced by ilDclRecordEditGUI\cancelSave(), doRead(), and ilDclRecordEditGUI\save().

                                         : void
    {
        $this->table_id = $a_id;
    }

Here is the caller graph for this function:

Field Documentation

$create_date

ilDateTime ilDclBaseRecordModel::$create_date

protected

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

Referenced by getCreateDate().

$db

ilDBInterface ilDclBaseRecordModel::$db

protected

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

$event

ilAppEventHandler ilDclBaseRecordModel::$event

protected

Definition at line 44 of file class.ilDclBaseRecordModel.php.

$http

ILIAS HTTP Services ilDclBaseRecordModel::$http

protected

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

$id

int ilDclBaseRecordModel::$id = 0

protected

Definition at line 33 of file class.ilDclBaseRecordModel.php.

Referenced by getId(), and getRecordFieldValues().

$last_edit_by

int ilDclBaseRecordModel::$last_edit_by = null

protected

Definition at line 36 of file class.ilDclBaseRecordModel.php.

Referenced by getLastEditBy(), and setLastEditBy().

$last_update

ilDateTime ilDclBaseRecordModel::$last_update

protected

Definition at line 38 of file class.ilDclBaseRecordModel.php.

Referenced by getLastUpdate().

$notes

Service ilDclBaseRecordModel::$notes

protected

Definition at line 27 of file class.ilDclBaseRecordModel.php.

$nr_of_comments

int ilDclBaseRecordModel::$nr_of_comments = null

protected

Definition at line 40 of file class.ilDclBaseRecordModel.php.

Referenced by getNrOfComments().

$owner

int ilDclBaseRecordModel::$owner = 0

protected

Definition at line 37 of file class.ilDclBaseRecordModel.php.

Referenced by getOwner().

$recordfields

array ilDclBaseRecordModel::$recordfields = null

protected

Definition at line 32 of file class.ilDclBaseRecordModel.php.

Referenced by getRecordFields(), and loadRecordFields().

$refinery

ILIAS Refinery Factory ilDclBaseRecordModel::$refinery

protected

Definition at line 42 of file class.ilDclBaseRecordModel.php.

$renderer

ILIAS UI Renderer ilDclBaseRecordModel::$renderer

protected

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

$table

ilDclTable ilDclBaseRecordModel::$table = null

protected

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

Referenced by getTable().

$table_id

int ilDclBaseRecordModel::$table_id

protected

Definition at line 34 of file class.ilDclBaseRecordModel.php.

Referenced by getTableId().

$ui_factory

ILIAS UI Factory ilDclBaseRecordModel::$ui_factory

protected

Definition at line 25 of file class.ilDclBaseRecordModel.php.

$user

ilObjUser ilDclBaseRecordModel::$user

private

Definition at line 45 of file class.ilDclBaseRecordModel.php.

---

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

• components/ILIAS/DataCollection/classes/Fields/Base/class.ilDclBaseRecordModel.php