ilDclBaseRecordModel Class Reference

Class ilDclBaseRecordModel. More...

Collaboration diagram for ilDclBaseRecordModel:

Public Member Functions
	__construct ($a_id=0)
	doUpdate ($omit_notification=false)
	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)
	setStandardFieldValueFromExcel ($excel, $row, $col, $field)
	getRecordFieldValues ()
	getRecordFieldValue ($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, &$row, &$col, $field_id)
	getRecordFieldFormulaValue ($field_id)
	getRecordFieldHTML ($field_id, array $options=array())
	getRecordFieldSortingValue ($field_id, array $options=array())
	fillRecordFieldFormInput ($field_id, &$form)
	getStandardFieldFormulaValue ($field_id)
	getStandardFieldHTML ($field_id, array $options=array())
	getStandardFieldPlainText ($field_id)
	getRecordField ($field_id)
	doDelete ($omit_notification=false)
	Delete. More...
	cloneStructure ($original_id, $new_fields)
	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
	fixDate ($value)
	loadRecordFields ()
	Load record fields. More...
	loadTable ()
	Load table. More...

Detailed Description

Class ilDclBaseRecordModel.

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 16 of file class.ilDclBaseRecordModel.php.

Constructor & Destructor Documentation

__construct()

ilDclBaseRecordModel::__construct

(

$a_id = 0

)

Parameters

int

$a_id

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

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

References doRead().

Here is the call graph for this function:

Member Function Documentation

cloneStructure()

ilDclBaseRecordModel::cloneStructure	(		$original_id,
			$new_fields
	)

Parameters

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

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

    {
        $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);
    }

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

Here is the call graph for this function:

deleteField()

ilDclBaseRecordModel::deleteField

(

$field_id

)

Parameters

$field_id

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

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

References doDelete(), and loadRecordFields().

Here is the call graph for this function:

deleteFile()

ilDclBaseRecordModel::deleteFile

(

$obj_id

)

Delete a file.

Parameters

$obj_id

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

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

References ilObject2\_exists().

Referenced by doDelete().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteMob()

ilDclBaseRecordModel::deleteMob

(

$obj_id

)

Delete MOB.

Parameters

$obj_id

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

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

References ilObject2\_lookupObjId().

Referenced by doDelete().

Here is the call graph for this function:

Here is the caller graph for this function:

doCreate()

ilDclBaseRecordModel::doCreate

(

)

Exceptions

ilException

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        if (!ilDclTable::_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);
 
        $this->loadRecordFields();
        foreach ($this->getRecordFields() as $recordField) {
            $recordField->doCreate();
        }
 
        $this->getTable()->loadRecords();
    }

References $DIC, $id, $ilDB, $query, ilDclTable\_tableExists(), getCreateDate(), getId(), getLastEditBy(), getLastUpdate(), getOwner(), getRecordFields(), getTable(), getTableId(), loadRecordFields(), and setId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

doDelete()

ilDclBaseRecordModel::doDelete

(

$omit_notification = false

)

Delete.

Parameters

bool

$omit_notification

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
 
        $this->loadRecordFields();
        foreach ($this->recordfields as $recordfield) {
            if ($recordfield->getField()->getDatatypeId() == ilDclDatatype::INPUTFORMAT_FILE) {
                $this->deleteFile($recordfield->getValue());
            }
 
            if ($recordfield->getField()->getDatatypeId() == ilDclDatatype::INPUTFORMAT_MOB) {
                $this->deleteMob($recordfield->getValue());
            }
 
            $recordfield->delete();
        }
 
        $query = "DELETE FROM il_dcl_record WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($query);
 
        $this->table->loadRecords();
 
        if (!$omit_notification) {
            $objDataCollection = new ilObjDataCollection($_GET['ref_id']);
            $objDataCollection->sendNotification("delete_record", $this->getTableId(), $this->getId());
 
            $ilAppEventHandler->raise(
                'Modules/DataCollection',
                'deleteRecord',
                array(
                    'dcl' => ilDclCache::getTableCache($this->getTableId())->getCollectionObject(),
                    'table_id' => $this->table_id,
                    'record_id' => $this->getId(),
                    'record' => $this,
                )
            );
        }
    }

References $_GET, $DIC, $ilDB, $query, deleteFile(), deleteMob(), getId(), ilDclCache\getTableCache(), getTableId(), ilDclDatatype\INPUTFORMAT_FILE, ilDclDatatype\INPUTFORMAT_MOB, and loadRecordFields().

Referenced by deleteField().

Here is the call graph for this function:

Here is the caller graph for this function:

doRead()

ilDclBaseRecordModel::doRead

(

)

Read record.

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

    {
        global $DIC;
        $ilDB = $DIC['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"]);
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

doUpdate()

ilDclBaseRecordModel::doUpdate

(

$omit_notification = false

)

doUpdate

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $values = array(
            "table_id" => array(
                "integer",
                $this->getTableId(),
            ),
            "last_update" => array(
                "date",
                $this->fixDate($this->getLastUpdate()),
            ),
            "owner" => array(
                "text",
                $this->getOwner(),
            ),
            "last_edit_by" => array(
                "text",
                $this->getLastEditBy(),
            ),
        );
        $ilDB->update(
            "il_dcl_record",
            $values,
            array(
                "id" => array(
                    "integer",
                    $this->id,
                ),
            )
        );
 
        foreach ($this->getRecordFields() as $recordfield) {
            $recordfield->doUpdate();
        }
 
        //TODO: add event raise
        if (!$omit_notification) {
            $objDataCollection = new ilObjDataCollection($_GET['ref_id']);
            $objDataCollection->sendNotification("update_record", $this->getTableId(), $this->id);
        }
    }

References $_GET, $DIC, $ilDB, fixDate(), getLastEditBy(), getLastUpdate(), getOwner(), getRecordFields(), and getTableId().

Referenced by ilDclRecordEditGUI\save().

Here is the call graph for this function:

Here is the caller graph for this function:

fillRecordFieldExcelExport()

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

Parameters

$worksheet
$row
$col
$field_id

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

    {
        $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']);
                $col++;
            } else {
                $worksheet->setCell($row, $col, $this->getStandardFieldHTML($field_id));
                $col++;
            }
        } else {
            $this->recordfields[$field_id]->fillExcelExport($worksheet, $row, $col);
        }
    }

References ilDclStandardField\_isStandardField(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), getOwner(), getStandardFieldHTML(), loadRecordFields(), and ilExcel\setCell().

Referenced by ilDclContentExporter\fillRowExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

fillRecordFieldFormInput()

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

Parameters

$field_id
$form	ilPropertyFormGUI

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

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

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

Referenced by ilDclRecordEditGUI\sendFailure().

Here is the call graph for this function:

Here is the caller graph for this function:

fillStandardFieldFormInput()

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

protected

Parameters

$field_id
$form

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

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

References getStandardField().

Referenced by fillRecordFieldFormInput().

Here is the call graph for this function:

Here is the caller graph for this function:

fixDate()

ilDclBaseRecordModel::fixDate (   $value )

private

Parameters

$value

Returns

string

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

    {
        return $value;
    }

Referenced by doUpdate().

Here is the caller graph for this function:

getComments()

ilDclBaseRecordModel::getComments

(

)

Get all comments of this record.

Returns

array ilNote[]

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

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

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

Referenced by getStandardFieldHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

getCreateDate()

ilDclBaseRecordModel::getCreateDate

(

)

Get Creation Date.

Returns

ilDateTime

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

    {
        return $this->create_date;
    }

References $create_date.

Referenced by doCreate(), and getStandardFieldHTML().

Here is the caller graph for this function:

getId()

ilDclBaseRecordModel::getId

(

)

Get field id.

Returns

int

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

    {
        return $this->id;
    }

References $id.

Referenced by cloneStructure(), doCreate(), doDelete(), doRead(), ilDclFieldFactory\getRecordFieldInstance(), getStandardFieldHTML(), ilDclRecordEditGUI\save(), and ilDclRecordEditGUI\sendFailure().

Here is the caller graph for this function:

getLastEditBy()

ilDclBaseRecordModel::getLastEditBy

(

)

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

    {
        return $this->last_edit_by;
    }

References $last_edit_by.

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

Here is the caller graph for this function:

getLastUpdate()

ilDclBaseRecordModel::getLastUpdate

(

)

Get Last Update Date.

Returns

ilDateTime

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

    {
        return $this->last_update;
    }

References $last_update.

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

Here is the caller graph for this function:

getOwner()

ilDclBaseRecordModel::getOwner

(

)

Get Owner.

Returns

int

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

    {
        return $this->owner;
    }

References $owner.

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

Here is the caller graph for this function:

getRecordField()

ilDclBaseRecordModel::getRecordField

(

$field_id

)

Parameters

$field_id

Returns

ilDclBaseRecordFieldModel

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

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

References loadRecordFields().

Here is the call graph for this function:

getRecordFieldExportValue()

ilDclBaseRecordModel::getRecordFieldExportValue

(

$field_id

)

Get Field Export Value.

Parameters

int

$field_id

Returns

array

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

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

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

Here is the call graph for this function:

getRecordFieldFormulaValue()

ilDclBaseRecordModel::getRecordFieldFormulaValue

(

$field_id

)

Parameters

int | string

$field_id

Returns

array|mixed|string

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

    {
        $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;
    }

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

Here is the call graph for this function:

getRecordFieldHTML()

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

Parameters

	$field_id
array	$options

Returns

array|mixed|string

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

    {
        $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]->getRecordRepresentation()->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("{", "{", $html);
        //              $html = str_ireplace("}", "}", $html);
 
        return $html;
    }

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

Here is the call graph for this function:

getRecordFieldPlainText()

ilDclBaseRecordModel::getRecordFieldPlainText

(

$field_id

)

Get Field Export Value.

Parameters

int

$field_id

Returns

array

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

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

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

Here is the call graph for this function:

getRecordFieldRepresentationValue()

ilDclBaseRecordModel::getRecordFieldRepresentationValue

(

$field_id

)

Get Field Value for Representation in a Form.

Parameters

$field_id

Returns

array|int|null|string

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

    {
        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();
        }
    }

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

Here is the call graph for this function:

getRecordFields()

ilDclBaseRecordModel::getRecordFields

(

)

Returns

ilDclBaseRecordFieldModel[]

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

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

References $recordfields, and loadRecordFields().

Referenced by doCreate(), and doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordFieldSortingValue()

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

Parameters

	$field_id
array	$options

Returns

array|mixed|string

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

    {
        $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 = '';
            }
        }
 
        // 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("{", "{", $html);
        //              $html = str_ireplace("}", "}", $html);
 
        return $html;
    }

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

Here is the call graph for this function:

getRecordFieldValue()

ilDclBaseRecordModel::getRecordFieldValue

(

$field_id

)

Get Field Value.

Parameters

int

$field_id

Returns

array

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

    {
        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();
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordFieldValueFromExcel()

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

Parameters

$excel	ilExcel
$row
$col
$field	ilDclBaseFieldModel

Returns

array|string

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

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

References loadRecordFields().

Here is the call graph for this function:

getRecordFieldValues()

ilDclBaseRecordModel::getRecordFieldValues

(

)

Returns

array

Deprecated:

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

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

References $id, and loadRecordFields().

Here is the call graph for this function:

getStandardField()

ilDclBaseRecordModel::getStandardField (   $field_id )

protected

Parameters

$field_id

Returns

int

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

    {
        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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardFieldFormulaValue()

ilDclBaseRecordModel::getStandardFieldFormulaValue

(

$field_id

)

Parameters

$field_id

Returns

array|string

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

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

References getStandardFieldHTML().

Referenced by getRecordFieldFormulaValue().

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardFieldHTML()

ilDclBaseRecordModel::getStandardFieldHTML	(		$field_id,
		array	$options = array()
	)

Parameters

string	$field_id
array	$options

Returns

array|string

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

    {
        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>";
        }
    }

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(), getRecordFieldPlainText(), getRecordFieldSortingValue(), getStandardFieldFormulaValue(), and getStandardFieldPlainText().

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardFieldPlainText()

ilDclBaseRecordModel::getStandardFieldPlainText

(

$field_id

)

Parameters

string

$field_id

Returns

array|string

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

    {
        switch ($field_id) {
            case 'comments':
                return count(ilNote::_getNotesOfObject(
                    $this->table->getCollectionObject()->getId(),
                    $this->getId(),
                    "dcl",
                    2,
                    false,
                    "",
                    "y",
                    true,
                    true
                ));
            default:
                return strip_tags($this->getStandardFieldHTML($field_id));
        }
    }

References ilNote\_getNotesOfObject(), and getStandardFieldHTML().

Here is the call graph for this function:

getTable()

ilDclBaseRecordModel::getTable

(

)

Returns

ilDclTable

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

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

References $table, and loadTable().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTableId()

ilDclBaseRecordModel::getTableId

(

)

Get Table ID.

Returns

int

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

    {
        return $this->table_id;
    }

References $table_id.

Referenced by doCreate(), doDelete(), doUpdate(), and loadTable().

Here is the caller graph for this function:

hasPermissionToDelete()

ilDclBaseRecordModel::hasPermissionToDelete

(

$ref_id

)

Parameters

int

$ref_id

Returns

bool

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

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

References getTable().

Here is the call graph for this function:

hasPermissionToEdit()

ilDclBaseRecordModel::hasPermissionToEdit

(

$ref_id

)

Parameters

int

$ref_id

Returns

bool

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

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

References getTable().

Referenced by ilDclRecordEditGUI\save().

Here is the call graph for this function:

Here is the caller graph for this function:

hasPermissionToView()

ilDclBaseRecordModel::hasPermissionToView

(

$ref_id

)

Parameters

$ref_id

Returns

bool

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

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

References getTable().

Here is the call graph for this function:

loadRecordFields()

ilDclBaseRecordModel::loadRecordFields ( )

private

Load record fields.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

loadTable()

ilDclBaseRecordModel::loadTable ( )

private

Load table.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

passThroughFilter()

ilDclBaseRecordModel::passThroughFilter

(

array

$filter

)

Parameters

array

$filter

Returns

bool

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

    {
        $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 (!ilDclCache::getFieldRepresentation($field)->passThroughFilter($this, $filter["filter_" . $field->getId()])) {
                return false;
            }
        }
 
        return true;
    }

References ilDclCache\getFieldRepresentation(), loadTable(), and passThroughFilter().

Referenced by passThroughFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

setCreateDate()

ilDclBaseRecordModel::setCreateDate

(

$a_datetime

)

Set Creation Date.

Parameters

ilDateTime

$a_datetime

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

    {
        $this->create_date = $a_datetime;
    }

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

Here is the caller graph for this function:

setId()

ilDclBaseRecordModel::setId

(

$a_id

)

Set field id.

Parameters

int

$a_id

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

    {
        $this->id = $a_id;
    }

Referenced by doCreate().

Here is the caller graph for this function:

setLastEditBy()

ilDclBaseRecordModel::setLastEditBy

(

$last_edit_by

)

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

    {
        $this->last_edit_by = $last_edit_by;
    }

References $last_edit_by.

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

Here is the caller graph for this function:

setLastUpdate()

ilDclBaseRecordModel::setLastUpdate

(

$a_datetime

)

Set Last Update Date.

Parameters

ilDateTime

$a_datetime

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

    {
        $this->last_update = $a_datetime;
    }

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

Here is the caller graph for this function:

setOwner()

ilDclBaseRecordModel::setOwner

(

$a_id

)

Set Owner.

Parameters

int

$a_id

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

    {
        $this->owner = $a_id;
    }

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

Here is the caller graph for this function:

setRecordFieldValue()

ilDclBaseRecordModel::setRecordFieldValue	(		$field_id,
			$value
	)

Set a field value.

Parameters

int	$field_id
string	$value

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

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

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

Referenced by ilDclRecordEditGUI\save().

Here is the call graph for this function:

Here is the caller graph for this function:

setRecordFieldValueFromForm()

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

Set a field value.

Parameters

int	$field_id
string	$value

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

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

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

Referenced by ilDclRecordEditGUI\save().

Here is the call graph for this function:

Here is the caller graph for this function:

setStandardField()

ilDclBaseRecordModel::setStandardField (   $field_id,   $value  )

protected

Parameters

$field_id
$value

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

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

References setLastEditBy().

Referenced by setRecordFieldValue(), and setStandardFieldFromForm().

Here is the call graph for this function:

Here is the caller graph for this function:

setStandardFieldFromForm()

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

protected

Parameters

	$field_id
ilPropertyFormGUI	$form

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

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

References setStandardField().

Referenced by setRecordFieldValueFromForm().

Here is the call graph for this function:

Here is the caller graph for this function:

setStandardFieldValueFromExcel()

ilDclBaseRecordModel::setStandardFieldValueFromExcel	(		$excel,
			$row,
			$col,
			$field
	)

Parameters

$excel	ilExcel
$row
$col
$field	ilDclStandardField

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

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

setTableId()

ilDclBaseRecordModel::setTableId

(

$a_id

)

Set Table ID.

Parameters

int

$a_id

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

    {
        $this->table_id = $a_id;
    }

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

Here is the caller graph for this function:

Field Documentation

$comments

ilDclBaseRecordModel::$comments

protected

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

Referenced by getComments().

$create_date

ilDclBaseRecordModel::$create_date

protected

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

Referenced by getCreateDate().

$id

ilDclBaseRecordModel::$id

protected

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

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

$last_edit_by

ilDclBaseRecordModel::$last_edit_by

protected

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

Referenced by getLastEditBy(), and setLastEditBy().

$last_update

ilDclBaseRecordModel::$last_update

protected

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

Referenced by getLastUpdate().

$owner

ilDclBaseRecordModel::$owner

protected

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

Referenced by getOwner().

$recordfields

ilDclBaseRecordModel::$recordfields

protected

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

Referenced by getRecordFields(), and loadRecordFields().

$table

ilDclBaseRecordModel::$table

protected

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

Referenced by getTable().

$table_id

ilDclBaseRecordModel::$table_id

protected

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

Referenced by getTableId().

---

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

• Modules/DataCollection/classes/Fields/Base/class.ilDclBaseRecordModel.php