ilDclTable Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilDclTable:

Public Member Functions
	__construct (int $a_id=0)
	doRead ()
	Read table. More...
	doDelete (bool $delete_only_content=false, bool $omit_notification=false)
	Delete table Attention this does not delete the maintable of it's the maintable of the collection. More...
	doCreate (bool $create_tablefield_setting=true, bool $create_standardview=true)
	doUpdate ()
	setId (int $a_id)
	Set table id. More...
	getId ()
	Get table id. More...
	setObjId (int $a_id)
	getObjId ()
	setTitle (string $a_title)
	getTitle ()
	getCollectionObject ()
	getRecords ()
	loadRecords ()
	deleteField (int $field_id)
	getField (string $field_id)
	getFieldIds ()
	getCustomFields ()
	getNewFieldOrder ()
	getNewOrder More...
	getNewTableviewOrder ()
	sortTableViews (array $tableviews=null)
	getFields ()
	Returns all fields of this table including the standard fields. More...
	reloadFields ()
	getTableViews ()
	getVisibleTableViews (int $ref_id, bool $with_active_detailedview=false, int $user_id=0)
	For current user. More...
	getFirstTableViewId (int $ref_id, int $user_id=0, bool $with_detailed_view=false)
	get id of first (for current user) available view More...
	getFieldsForFormula ()
	Returns all fields of this table including the standard fields, wich are supported for formulas. More...
	getRecordFields ()
	Returns all fields of this table which are NOT standard fields. More...
	getEditableFields (bool $creation_mode)
	getExportableFields ()
	Return all the fields that are marked as exportable. More...
	hasPermissionToEditRecord (int $ref_id, ilDclBaseRecordModel $record)
	hasPermissionToDeleteRecord (int $ref_id, ilDclBaseRecordModel $record)
	hasPermissionToDeleteRecords (int $ref_id)
	hasPermissionToViewRecord (int $ref_id, ilDclBaseRecordModel $record, int $user_id=0)
	checkLimit ()
	updateFields ()
	Update fields. More...
	sortFields (array &$fields)
	sortFields More...
	buildOrderFields ()
	buildOrderFields orders the fields. More...
	getFieldByTitle (string $title)
	Get a field by title. More...
	setAddPerm (bool $add_perm)
	getAddPerm ()
	setDeletePerm (bool $delete_perm)
	getDeletePerm ()
	setEditByOwner (bool $edit_by_owner)
	getEditByOwner ()
	getDeleteByOwner ()
	setDeleteByOwner (bool $delete_by_owner)
	setEditPerm (bool $edit_perm)
	getEditPerm ()
	setLimited (bool $limited)
	getLimited ()
	setLimitEnd (?string $limit_end)
	getLimitEnd ()
	setLimitStart (?string $limit_start)
	getLimitStart ()
	setIsVisible (bool $is_visible)
	getIsVisible ()
	setDescription (string $description)
	getDescription ()
	setDefaultSortField (string $default_sort_field)
	getDefaultSortField ()
	setDefaultSortFieldOrder (string $default_sort_field_order)
	getDefaultSortFieldOrder ()
	setPublicCommentsEnabled (bool $public_comments)
	getPublicCommentsEnabled ()
	setViewOwnRecordsPerm (bool $view_own_perm)
	getViewOwnRecordsPerm ()
	getSaveConfirmation ()
	setSaveConfirmation (bool $save_confirmation)
	hasCustomFields ()
	hasCustomFields More...
	compareOrder (ilDclBaseFieldModel $a, ilDclBaseFieldModel $b)
	cloneStructure (ilDclTable $original)
	afterClone ()
	_hasRecords ()
	_hasRecords More...
	addField (ilDclBaseFieldModel $field)
	setExportEnabled (bool $export_enabled)
	getExportEnabled ()
	getOrder ()
	updateOrder ()
	setOrder (int $table_order)
	setImportEnabled (bool $import_enabled)
	getImportEnabled ()
	getPartialRecords (string $ref_id, string $sort, string $direction, ?int $limit, int $offset, array $filter=[])
	Return only the needed subset of record objects for the table, according to sorting, paging and filters. More...
	showInvalidFields (bool $value)

Static Public Member Functions
static	_tableExists (int $table_id)
static	_getTableIdByTitle (string $title, int $obj_id)
static	_hasFieldByTitle (string $title, int $obj_id)
	Checks if a table has a field with the given title. More...

Protected Member Functions
	loadObj ()
	loadCustomFields ()
	doesRecordBelongToUser (ilDclBaseRecordModel $record)
	sortByOrder (array &$array)

Protected Attributes
int	$id = 0
int	$objId = null
ilObjDataCollection	$obj = null
string	$title = ""
array	$fields = []
array	$stdFields = []
array	$records = []
bool	$is_visible = false
bool	$add_perm = false
bool	$edit_perm = false
bool	$delete_perm = false
bool	$edit_by_owner = false
bool	$delete_by_owner = false
bool	$save_confirmation = false
bool	$limited = false
string	$limit_start = null
string	$limit_end = null
bool	$export_enabled = false
int	$table_order = 0
bool	$import_enabled = false
	$default_sort_field = 0
	ID of the default sorting field. More...
string	$default_sort_field_order = 'asc'
	Default sort-order (asc|desc) More...
string	$description = ''
	Description for this table displayed above records. More...
int	$public_comments = 0
	True if users can add comments on each record of this table. More...
int	$view_own_records_perm = 0
	True if user can only view his/her own entries in the table. More...
array	$all_fields = null
	table fields and std fields combined More...
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ilObjUser	$user
ilDBInterface	$db
bool	$show_invalid = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 of file class.ilDclTable.php.

Constructor & Destructor Documentation

__construct()

ilDclTable::__construct

(

int

$a_id = 0

)

Definition at line 81 of file class.ilDclTable.php.

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

    {
        global $DIC;

        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->db = $DIC->database();
        $this->user = $DIC->user();

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

Here is the call graph for this function:

Member Function Documentation

_getTableIdByTitle()

static ilDclTable::_getTableIdByTitle ( string  $title, int  $obj_id  )

static

Parameters

int

$obj_id

Datacollection object ID where the table belongs to

Definition at line 1114 of file class.ilDclTable.php.

References $DIC, $id, and $ilDB.

Referenced by ilObjDataCollection\reorderTables().

                                                                         : int
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->query(
            'SELECT id FROM il_dcl_table WHERE title = ' . $ilDB->quote($title, 'text') . ' AND obj_id = '
            . $ilDB->quote($obj_id, 'integer')
        );
        $id = 0;
        while ($rec = $ilDB->fetchAssoc($result)) {
            $id = $rec['id'];
        }

        return $id;
    }

Here is the caller graph for this function:

_hasFieldByTitle()

static ilDclTable::_hasFieldByTitle ( string  $title, int  $obj_id  )

static

Checks if a table has a field with the given title.

Parameters

string	$title	Title of field
int	$obj_id	of the table

Definition at line 1183 of file class.ilDclTable.php.

References $DIC, and $ilDB.

Referenced by ilDclFieldEditGUI\checkInput().

                                                                       : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $result = $ilDB->query(
            'SELECT * FROM il_dcl_field WHERE table_id = ' . $ilDB->quote($obj_id, 'integer') . ' AND title = '
            . $ilDB->quote($title, 'text')
        );

        return (bool) $ilDB->numRows($result);
    }

Here is the caller graph for this function:

_hasRecords()

ilDclTable::_hasRecords

(

)

_hasRecords

Definition at line 1084 of file class.ilDclTable.php.

References getRecords().

                                 : bool
    {
        return count($this->getRecords()) > 0;
    }

Here is the call graph for this function:

_tableExists()

static ilDclTable::_tableExists ( int  $table_id )

static

Returns

bool returns true if there exists a table with id $table_id

Definition at line 1100 of file class.ilDclTable.php.

References $DIC, $ilDB, and $query.

Referenced by ilDclBaseRecordModel\doCreate(), and ilDclBaseFieldModel\doCreate().

                                                      : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM il_dcl_table WHERE id = " . $table_id;
        $result = $ilDB->query($query);

        return $result->numRows() != 0;
    }

Here is the caller graph for this function:

addField()

ilDclTable::addField

(

ilDclBaseFieldModel

$field

)

Parameters

ilDclBaseFieldModel

$field

add an already created field for eg. ordering.

Definition at line 1092 of file class.ilDclTable.php.

References ilDclBaseFieldModel\getId().

                                                        : void
    {
        $this->all_fields[$field->getId()] = $field;
    }

Here is the call graph for this function:

afterClone()

ilDclTable::afterClone

(

)

Definition at line 1074 of file class.ilDclTable.php.

References getFields(), and getRecords().

                                : void
    {
        foreach ($this->getFields() as $field) {
            $field->afterClone($this->getRecords());
        }
    }

Here is the call graph for this function:

buildOrderFields()

ilDclTable::buildOrderFields

(

)

buildOrderFields orders the fields.

Definition at line 777 of file class.ilDclTable.php.

References getFields(), and sortByOrder().

Referenced by doCreate().

                                      : void
    {
        $fields = $this->getFields();
        $this->sortByOrder($fields);
        $count = 10;
        $offset = 10;
        foreach ($fields as $field) {
            if (!is_null($field->getOrder())) {
                $field->setOrder($count);
                $count = $count + $offset;
                $field->doUpdate();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkLimit()

ilDclTable::checkLimit

(

)

Definition at line 724 of file class.ilDclTable.php.

References getLimited(), getLimitEnd(), getLimitStart(), and IL_CAL_DATE.

Referenced by hasPermissionToDeleteRecord(), and hasPermissionToEditRecord().

                                : bool
    {
        if ($this->getLimited()) {
            $now = new ilDateTime(date("Y-m-d H:i:s"), IL_CAL_DATE);
            $from = new ilDateTime($this->getLimitStart(), IL_CAL_DATE);
            $to = new ilDateTime($this->getLimitEnd(), IL_CAL_DATE);

            return ($from <= $now && $now <= $to);
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneStructure()

ilDclTable::cloneStructure

(

ilDclTable

$original

)

Definition at line 1000 of file class.ilDclTable.php.

References $default_sort_field, doCreate(), doUpdate(), getAddPerm(), getDefaultSortField(), getDefaultSortFieldOrder(), getDeleteByOwner(), getDeletePerm(), getDescription(), getEditByOwner(), getEditPerm(), getExportEnabled(), ilDclReferenceFieldModel\getFieldRef(), getFields(), getId(), getImportEnabled(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getOrder(), getPublicCommentsEnabled(), getRecords(), getSaveConfirmation(), getTableViews(), getTitle(), getViewOwnRecordsPerm(), setAddPerm(), ilDclCache\setCloneOf(), setDefaultSortField(), setDefaultSortFieldOrder(), setDeleteByOwner(), setDeletePerm(), setDescription(), setEditByOwner(), setEditPerm(), setExportEnabled(), setImportEnabled(), setIsVisible(), setLimited(), setLimitEnd(), setLimitStart(), setOrder(), setPublicCommentsEnabled(), setSaveConfirmation(), setTitle(), setViewOwnRecordsPerm(), and ilDclCache\TYPE_TABLE.

                                                        : void
    {
        $this->setTitle($original->getTitle());
        $this->setDescription($original->getDescription());
        $this->setIsVisible($original->getIsVisible());
        $this->setEditByOwner($original->getEditByOwner());
        $this->setAddPerm($original->getAddPerm());
        $this->setEditPerm($original->getEditPerm());
        $this->setDeleteByOwner($original->getDeleteByOwner());
        $this->setSaveConfirmation($original->getSaveConfirmation());
        $this->setDeletePerm($original->getDeletePerm());
        $this->setLimited($original->getLimited());
        $this->setLimitStart($original->getLimitStart());
        $this->setLimitEnd($original->getLimitEnd());
        $this->setViewOwnRecordsPerm($original->getViewOwnRecordsPerm());
        $this->setExportEnabled($original->getExportEnabled());
        $this->setImportEnabled($original->getImportEnabled());
        $this->setPublicCommentsEnabled($original->getPublicCommentsEnabled());
        $this->setDefaultSortFieldOrder($original->getDefaultSortFieldOrder());
        $this->setOrder($original->getOrder());

        $this->doCreate(true, false);
        // reset stdFields to get new for the created object

        $default_sort_field = 0;
        // Clone standard-fields
        $org_std_fields = $original->getStandardFields();
        foreach ($this->getStandardFields() as $element_key => $std_field) {
            $std_field->clone($org_std_fields[$element_key]);
            if ($std_field->getId() === $original->getDefaultSortField()) {
                $default_sort_field = $std_field->getId();
            }
        }

        // Clone fields
        $new_fields = [];
        foreach ($original->getFields() as $orig_field) {
            if (!$orig_field->isStandardField()) {
                $class_name = get_class($orig_field);
                $new_field = new $class_name();
                if ($new_field instanceof ilDclReferenceFieldModel && $new_field->getFieldRef()->getTableId() === 0) {
                    continue;
                }
                $new_field->setTableId($this->getId());
                $new_field->cloneStructure($orig_field->getId());
                $new_fields[$orig_field->getId()] = $new_field;

                if ($orig_field->getId() === $original->getDefaultSortField()) {
                    $default_sort_field = $new_field->getId();
                }
            }
        }

        $this->setDefaultSortField($default_sort_field);
        $this->doUpdate();

        // Clone Records with recordfields
        foreach ($original->getRecords() as $orig_record) {
            $new_record = new ilDclBaseRecordModel();
            $new_record->setTableId($this->getId());
            $new_record->cloneStructure($orig_record->getId(), $new_fields);
        }

        //clone tableviews (includes pageobjects)
        foreach ($original->getTableViews() as $orig_tableview) {
            $new_tableview = new ilDclTableView();
            $new_tableview->setTableId($this->getId());
            $new_tableview->cloneStructure($orig_tableview, $new_fields);
        }

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

Here is the call graph for this function:

compareOrder()

ilDclTable::compareOrder	(	ilDclBaseFieldModel	$a,
		ilDclBaseFieldModel	$b
	)

Definition at line 985 of file class.ilDclTable.php.

References ilDclBaseFieldModel\getOrder().

                                                                                : int
    {
        if (is_null($a->getOrder() == null) && is_null($b->getOrder() == null)) {
            return 0;
        }
        if (is_null($a->getOrder())) {
            return 1;
        }
        if (is_null($b->getOrder())) {
            return -1;
        }

        return $a->getOrder() < $b->getOrder() ? -1 : 1;
    }

Here is the call graph for this function:

deleteField()

ilDclTable::deleteField

(

int

$field_id

)

Definition at line 334 of file class.ilDclTable.php.

References ilDclCache\getFieldCache(), and getRecords().

                                              : void
    {
        $field = ilDclCache::getFieldCache($field_id);
        $records = $this->getRecords();

        foreach ($records as $record) {
            $record->deleteField($field_id);
        }

        $field->doDelete();
    }

Here is the call graph for this function:

doCreate()

ilDclTable::doCreate	(	bool	$create_tablefield_setting = true,
		bool	$create_standardview = true
	)

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

References $query, buildOrderFields(), ilDclTableView\createOrGetStandardView(), getAddPerm(), getDefaultSortField(), getDefaultSortFieldOrder(), getDeleteByOwner(), getDeletePerm(), getDescription(), getEditByOwner(), getEditPerm(), getExportEnabled(), getId(), getImportEnabled(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getObjId(), getOrder(), getPublicCommentsEnabled(), getSaveConfirmation(), getTitle(), getViewOwnRecordsPerm(), and setId().

Referenced by cloneStructure().

                                                                                                      : void
    {
        $id = $this->db->nextId("il_dcl_table");
        $this->setId($id);
        $query = "INSERT INTO il_dcl_table (" . "id" . ", obj_id" . ", title" . ", add_perm" . ", edit_perm" . ", delete_perm" . ", edit_by_owner"
            . ", limited" . ", limit_start" . ", limit_end" . ", is_visible" . ", export_enabled" . ", import_enabled" . ", default_sort_field_id"
            . ", default_sort_field_order" . ", description" . ", public_comments" . ", view_own_records_perm"
            . ", delete_by_owner, save_confirmation , table_order ) VALUES (" . $this->db->quote(
                $this->getId(),
                "integer"
            ) . ","
            . $this->db->quote($this->getObjId(), "integer") . "," . $this->db->quote($this->getTitle(), "text") . ","
            . $this->db->quote($this->getAddPerm() ? 1 : 0, "integer") . "," . $this->db->quote(
                $this->getEditPerm() ? 1 : 0,
                "integer"
            ) . ","
            . $this->db->quote(
                $this->getDeletePerm() ? 1 : 0,
                "integer"
            ) . "," . $this->db->quote($this->getEditByOwner() ? 1 : 0, "integer") . ","
            . $this->db->quote($this->getLimited() ? 1 : 0, "integer") . "," . $this->db->quote(
                $this->getLimitStart(),
                "timestamp"
            ) . ","
            . $this->db->quote($this->getLimitEnd(), "timestamp") . "," . $this->db->quote(
                $this->getIsVisible() ? 1 : 0,
                "integer"
            ) . ","
            . $this->db->quote(
                $this->getExportEnabled() ? 1 : 0,
                "integer"
            ) . "," . $this->db->quote($this->getImportEnabled() ? 1 : 0, "integer") . ","
            . $this->db->quote($this->getDefaultSortField(), "text") . "," . $this->db->quote(
                $this->getDefaultSortFieldOrder(),
                "text"
            ) . ","
            . $this->db->quote($this->getDescription(), "text") . "," . $this->db->quote(
                $this->getPublicCommentsEnabled(),
                "integer"
            ) . ","
            . $this->db->quote(
                $this->getViewOwnRecordsPerm(),
                "integer"
            ) . "," . $this->db->quote($this->getDeleteByOwner() ? 1 : 0, 'integer') . ","
            . $this->db->quote($this->getSaveConfirmation() ? 1 : 0, 'integer') . "," . $this->db->quote(
                $this->getOrder(),
                'integer'
            ) . ")";

        $this->db->manipulate($query);

        if ($create_standardview) {
            //standard tableview
            ilDclTableView::createOrGetStandardView($this->id);
        }

        if ($create_tablefield_setting) {
            $this->buildOrderFields();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doDelete()

ilDclTable::doDelete	(	bool	$delete_only_content = false,
		bool	$omit_notification = false
	)

Delete table Attention this does not delete the maintable of it's the maintable of the collection.

unlink the the maintable in the collections object to make this work.

Definition at line 140 of file class.ilDclTable.php.

References $query, getId(), getRecordFields(), and getRecords().

                                                                                                : void
    {
        foreach ($this->getRecords() as $record) {
            $record->doDelete($omit_notification);
        }

        foreach ($this->getRecordFields() as $field) {
            $field->doDelete();
        }

        //              // SW: Fix #12794 und #11405
        //              // Problem is that when the DC object gets deleted, $this::getCollectionObject() tries to load the DC but it's not in the DB anymore
        //              // If $delete_main_table is true, avoid getting the collection object
        //              $exec_delete = false;
        //              if ($delete_main_table) {
        //                      $exec_delete = true;
        //              }
        //              if (!$exec_delete && $this->getCollectionObject()->getFirstVisibleTableId() != $this->getId()) {
        //                      $exec_delete = true;
        //              }
        if (!$delete_only_content) {
            $query = "DELETE FROM il_dcl_table WHERE id = " . $this->db->quote($this->getId(), "integer");
            $this->db->manipulate($query);
        }
    }

Here is the call graph for this function:

doesRecordBelongToUser()

ilDclTable::doesRecordBelongToUser ( ilDclBaseRecordModel  $record )

protected

Definition at line 719 of file class.ilDclTable.php.

References ilDclBaseRecordModel\getOwner(), and ILIAS\Repository\user().

Referenced by hasPermissionToDeleteRecord(), and hasPermissionToEditRecord().

                                                                           : bool
    {
        return ($this->user->getId() == $record->getOwner());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doRead()

ilDclTable::doRead

(

)

Read table.

Definition at line 99 of file class.ilDclTable.php.

References $query, getId(), setAddPerm(), setDefaultSortField(), setDefaultSortFieldOrder(), setDeleteByOwner(), setDeletePerm(), setDescription(), setEditByOwner(), setEditPerm(), setExportEnabled(), setImportEnabled(), setIsVisible(), setLimited(), setLimitEnd(), setLimitStart(), setObjId(), setOrder(), setPublicCommentsEnabled(), setSaveConfirmation(), setTitle(), and setViewOwnRecordsPerm().

Referenced by __construct().

                            : void
    {
        $query = "SELECT * FROM il_dcl_table WHERE id = " . $this->db->quote($this->getId(), "integer");
        $set = $this->db->query($query);
        $rec = $this->db->fetchAssoc($set);

        $this->setObjId($rec["obj_id"]);
        if (null !== $rec["title"]) {
            $this->setTitle($rec["title"]);
        }
        $this->setAddPerm($rec["add_perm"]);
        $this->setEditPerm($rec["edit_perm"]);
        $this->setDeletePerm($rec["delete_perm"]);
        $this->setEditByOwner($rec["edit_by_owner"]);
        if (null !== $rec["export_enabled"]) {
            $this->setExportEnabled((bool) $rec["export_enabled"]);
        }
        $this->setImportEnabled($rec["import_enabled"]);
        $this->setLimited($rec["limited"]);
        $this->setLimitStart($rec["limit_start"]);
        $this->setLimitEnd($rec["limit_end"]);
        $this->setIsVisible($rec["is_visible"]);
        if (null !== $rec['description']) {
            $this->setDescription($rec['description']);
        }
        $this->setDefaultSortField($rec['default_sort_field_id']);
        $this->setDefaultSortFieldOrder($rec['default_sort_field_order']);
        $this->setPublicCommentsEnabled($rec['public_comments']);
        $this->setViewOwnRecordsPerm($rec['view_own_records_perm']);
        $this->setDeleteByOwner($rec['delete_by_owner']);
        $this->setSaveConfirmation($rec['save_confirmation']);
        if (null !== $rec['table_order']) {
            $this->setOrder($rec['table_order']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doUpdate()

ilDclTable::doUpdate

(

)

Definition at line 227 of file class.ilDclTable.php.

References getAddPerm(), getDefaultSortField(), getDefaultSortFieldOrder(), getDeleteByOwner(), getDeletePerm(), getDescription(), getEditByOwner(), getEditPerm(), getExportEnabled(), getId(), getImportEnabled(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getObjId(), getOrder(), getPublicCommentsEnabled(), getSaveConfirmation(), getTitle(), and getViewOwnRecordsPerm().

Referenced by cloneStructure().

                              : void
    {
        $this->db->update(
            "il_dcl_table",
            [
                "obj_id" => ["integer", $this->getObjId()],
                "title" => ["text", $this->getTitle()],
                "add_perm" => ["integer", (int) $this->getAddPerm()],
                "edit_perm" => ["integer", (int) $this->getEditPerm()],
                "delete_perm" => ["integer", (int) $this->getDeletePerm()],
                "edit_by_owner" => ["integer", (int) $this->getEditByOwner()],
                "limited" => ["integer", $this->getLimited()],
                "limit_start" => ["timestamp", $this->getLimitStart()],
                "limit_end" => ["timestamp", $this->getLimitEnd()],
                "is_visible" => ["integer", $this->getIsVisible() ? 1 : 0],
                "export_enabled" => ["integer", $this->getExportEnabled() ? 1 : 0],
                "import_enabled" => ["integer", $this->getImportEnabled() ? 1 : 0],
                "description" => ["text", $this->getDescription()],
                "default_sort_field_id" => ["text", $this->getDefaultSortField()],
                "default_sort_field_order" => ["text", $this->getDefaultSortFieldOrder()],
                "public_comments" => ["integer", $this->getPublicCommentsEnabled() ? 1 : 0],
                "view_own_records_perm" => ["integer", $this->getViewOwnRecordsPerm()],
                'delete_by_owner' => ['integer', $this->getDeleteByOwner() ? 1 : 0],
                'save_confirmation' => ['integer', $this->getSaveConfirmation() ? 1 : 0],
                'table_order' => ['integer', $this->getOrder()],
            ],
            [
                "id" => ["integer", $this->getId()],
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAddPerm()

ilDclTable::getAddPerm

(

)

Definition at line 813 of file class.ilDclTable.php.

References $add_perm.

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

                                : bool
    {
        return $this->add_perm;
    }

Here is the caller graph for this function:

getCollectionObject()

ilDclTable::getCollectionObject

(

)

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

References $obj, and loadObj().

                                         : ilObjDataCollection
    {
        $this->loadObj();

        return $this->obj;
    }

Here is the call graph for this function:

getCustomFields()

ilDclTable::getCustomFields

(

)

Returns

ilDclBaseFieldModel[]

Definition at line 408 of file class.ilDclTable.php.

References $fields, fields, and loadCustomFields().

                                     : array
    {
        if (!$this->fields) {
            $this->loadCustomFields();
        }

        return $this->fields;
    }

Here is the call graph for this function:

getDefaultSortField()

ilDclTable::getDefaultSortField

(

)

Definition at line 926 of file class.ilDclTable.php.

References $default_sort_field.

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

                                         : string
    {
        return $this->default_sort_field;
    }

Here is the caller graph for this function:

getDefaultSortFieldOrder()

ilDclTable::getDefaultSortFieldOrder

(

)

Definition at line 939 of file class.ilDclTable.php.

References $default_sort_field_order.

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

                                              : string
    {
        return $this->default_sort_field_order;
    }

Here is the caller graph for this function:

getDeleteByOwner()

ilDclTable::getDeleteByOwner

(

)

Definition at line 844 of file class.ilDclTable.php.

References $delete_by_owner.

Referenced by cloneStructure(), doCreate(), doUpdate(), and hasPermissionToDeleteRecord().

                                      : bool
    {
        return $this->delete_by_owner;
    }

Here is the caller graph for this function:

getDeletePerm()

ilDclTable::getDeletePerm

(

)

Definition at line 826 of file class.ilDclTable.php.

References $delete_perm.

Referenced by cloneStructure(), doCreate(), doUpdate(), hasPermissionToDeleteRecord(), and hasPermissionToDeleteRecords().

                                   : bool
    {
        return $this->delete_perm;
    }

Here is the caller graph for this function:

getDescription()

ilDclTable::getDescription

(

)

Definition at line 915 of file class.ilDclTable.php.

References $description.

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

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getEditableFields()

ilDclTable::getEditableFields

(

bool

$creation_mode

)

Parameters

bool

$creation_mode

Returns

array

Definition at line 590 of file class.ilDclTable.php.

References getRecordFields(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                                          : array
    {
        $fields = $this->getRecordFields();
        $editableFields = [];

        foreach ($fields as $field) {
            $tableview_id = $this->http->wrapper()->post()->retrieve(
                'tableview_id',
                $this->refinery->kindlyTo()->int()
            );
            if (!$field->getViewSetting($tableview_id)->isLocked($creation_mode)) {
                $editableFields[] = $field;
            }
        }

        return $editableFields;
    }

Here is the call graph for this function:

getEditByOwner()

ilDclTable::getEditByOwner

(

)

Definition at line 839 of file class.ilDclTable.php.

References $edit_by_owner.

Referenced by cloneStructure(), doCreate(), doUpdate(), and hasPermissionToEditRecord().

                                    : bool
    {
        return $this->edit_by_owner;
    }

Here is the caller graph for this function:

getEditPerm()

ilDclTable::getEditPerm

(

)

Definition at line 865 of file class.ilDclTable.php.

References $edit_perm.

Referenced by cloneStructure(), doCreate(), doUpdate(), and hasPermissionToEditRecord().

                                 : bool
    {
        return $this->edit_perm;
    }

Here is the caller graph for this function:

getExportableFields()

ilDclTable::getExportableFields

(

)

Return all the fields that are marked as exportable.

Returns

ilDclBaseFieldModel[]

Definition at line 612 of file class.ilDclTable.php.

References getFields().

                                         : array
    {
        $fields = $this->getFields();
        $exportableFields = [];
        foreach ($fields as $field) {
            if ($field->getExportable()) {
                $exportableFields[] = $field;
            }
        }

        return $exportableFields;
    }

Here is the call graph for this function:

getExportEnabled()

ilDclTable::getExportEnabled

(

)

Definition at line 1136 of file class.ilDclTable.php.

References $export_enabled.

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

                                      : bool
    {
        return $this->export_enabled;
    }

Here is the caller graph for this function:

getField()

ilDclTable::getField

(

string

$field_id

)

Definition at line 346 of file class.ilDclTable.php.

References getFields().

Referenced by getPartialRecords().

                                              : ?ilDclBaseFieldModel
    {
        $fields = $this->getFields();
        $field = null;
        foreach ($fields as $field_1) {
            if ($field_1->getId() == $field_id) {
                $field = $field_1;
            }
        }

        return $field;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldByTitle()

ilDclTable::getFieldByTitle

(

string

$title

)

Get a field by title.

Definition at line 795 of file class.ilDclTable.php.

References $title, and getFields().

Referenced by getPartialRecords().

                                                  : ?ilDclBaseFieldModel
    {
        $return = null;
        foreach ($this->getFields() as $field) {
            if ($field->getTitle() == $title) {
                $return = $field;
                break;
            }
        }

        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldIds()

ilDclTable::getFieldIds

(

)

Returns

int[]

Definition at line 362 of file class.ilDclTable.php.

References getFields().

                                 : array
    {
        $field_ids = [];
        foreach ($this->getFields() as $field) {
            if ($field->getId()) {
                $field_ids[] = $field->getId();
            }
        }

        return $field_ids;
    }

Here is the call graph for this function:

getFields()

ilDclTable::getFields

(

)

Returns all fields of this table including the standard fields.

Parameters

bool

$force_include_comments

by default false, so comments will only load when enabled in tablesettings

Returns

ilDclBaseFieldModel[]

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

References $all_fields, and reloadFields().

Referenced by afterClone(), buildOrderFields(), cloneStructure(), ilDclContentExporter\fillHeaderExcel(), ilDclContentExporter\fillRowExcel(), getExportableFields(), getField(), getFieldByTitle(), getFieldIds(), getFieldsForFormula(), getNewFieldOrder(), and updateFields().

                               : array
    {
        if ($this->all_fields == null) {
            $this->reloadFields();
        }

        return $this->all_fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldsForFormula()

ilDclTable::getFieldsForFormula

(

)

Returns all fields of this table including the standard fields, wich are supported for formulas.

Returns

ilDclBaseFieldModel[]

Definition at line 530 of file class.ilDclTable.php.

References $stdFields, ilDclStandardField\_getStandardFields(), getFields(), ilDclExpressionParser\getFunctions(), ilDclExpressionParser\getOperators(), getPublicCommentsEnabled(), and ilDclFormulaFieldModel\SUPPORTED_FIELDS.

                                         : array
    {
        $syntax_chars = array_merge(
            array_keys(ilDclExpressionParser::getOperators()),
            ilDclExpressionParser::getFunctions(),
            ['(', ')', ',']
        );
        foreach ($this->getFields() as $field) {
            if (in_array($field->getDatatypeId(), ilDclFormulaFieldModel::SUPPORTED_FIELDS)) {
                foreach ($syntax_chars as $element) {
                    if (str_contains($field->getTitle(), $element)) {
                        continue 2;
                    }
                }
                $return[] = $field;
            }
        }

        return $return;
    }

Here is the call graph for this function:

getFirstTableViewId()

ilDclTable::getFirstTableViewId	(	int	$ref_id,
		int	$user_id = 0,
		bool	$with_detailed_view = false
	)

get id of first (for current user) available view

Definition at line 517 of file class.ilDclTable.php.

References getVisibleTableViews().

                                                                                                        : ?int
    {
        $uid = $user_id;
        $array = $this->getVisibleTableViews($ref_id, $with_detailed_view, $uid);
        $tableview = array_shift($array);

        return $tableview ? $tableview->getId() : false;
    }

Here is the call graph for this function:

getId()

ilDclTable::getId

(

)

Get table id.

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

References $id.

Referenced by ilDclTableViewTableGUI\__construct(), cloneStructure(), doCreate(), doDelete(), doRead(), doUpdate(), ilDclTableListTableGUI\fillRowFromObject(), getNewTableviewOrder(), getPartialRecords(), getTableViews(), loadCustomFields(), and updateOrder().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getImportEnabled()

ilDclTable::getImportEnabled

(

)

Definition at line 1173 of file class.ilDclTable.php.

References $import_enabled.

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

                                      : bool
    {
        return $this->import_enabled;
    }

Here is the caller graph for this function:

getIsVisible()

ilDclTable::getIsVisible

(

)

Definition at line 905 of file class.ilDclTable.php.

References $is_visible.

Referenced by cloneStructure(), doCreate(), doUpdate(), and ilDclTableListTableGUI\fillRowFromObject().

                                  : bool
    {
        return $this->is_visible;
    }

Here is the caller graph for this function:

getLimited()

ilDclTable::getLimited

(

)

Definition at line 875 of file class.ilDclTable.php.

References $limited.

Referenced by checkLimit(), cloneStructure(), doCreate(), and doUpdate().

                                : bool
    {
        return $this->limited;
    }

Here is the caller graph for this function:

getLimitEnd()

ilDclTable::getLimitEnd

(

)

Definition at line 885 of file class.ilDclTable.php.

References $limit_end.

Referenced by checkLimit(), cloneStructure(), doCreate(), and doUpdate().

                                 : ?string
    {
        return $this->limit_end;
    }

Here is the caller graph for this function:

getLimitStart()

ilDclTable::getLimitStart

(

)

Definition at line 895 of file class.ilDclTable.php.

References $limit_start.

Referenced by checkLimit(), cloneStructure(), doCreate(), and doUpdate().

                                   : ?string
    {
        return $this->limit_start;
    }

Here is the caller graph for this function:

getNewFieldOrder()

ilDclTable::getNewFieldOrder

(

)

getNewOrder

Returns

int returns the place where a new field should be placed.

Definition at line 421 of file class.ilDclTable.php.

References getFields().

                                      : int
    {
        $fields = $this->getFields();
        $place = 0;
        foreach ($fields as $field) {
            if (!$field->isStandardField()) {
                $place = $field->getOrder() + 1;
            }
        }

        return $place;
    }

Here is the call graph for this function:

getNewTableviewOrder()

ilDclTable::getNewTableviewOrder

(

)

Returns

int

Definition at line 437 of file class.ilDclTable.php.

References ilDclTableView\getCountForTableId(), and getId().

                                          : int
    {
        return (ilDclTableView::getCountForTableId($this->getId()) + 1) * 10;
    }

Here is the call graph for this function:

getObjId()

ilDclTable::getObjId

(

)

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

References $objId.

Referenced by doCreate(), doUpdate(), getPartialRecords(), hasPermissionToDeleteRecord(), hasPermissionToDeleteRecords(), hasPermissionToEditRecord(), hasPermissionToViewRecord(), and ilObjDataCollectionAccess\isTableInDataCollection().

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

Here is the caller graph for this function:

getOrder()

ilDclTable::getOrder

(

)

Definition at line 1141 of file class.ilDclTable.php.

References $table_order, and updateOrder().

Referenced by cloneStructure(), doCreate(), doUpdate(), and ilDclTableListTableGUI\fillRowFromObject().

                              : int
    {
        if (!$this->table_order) {
            $this->updateOrder();
        }

        return $this->table_order;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPartialRecords()

ilDclTable::getPartialRecords	(	string	$ref_id,
		string	$sort,
		string	$direction,
		?int	$limit,
		int	$offset,
		array	$filter = []
	)

Return only the needed subset of record objects for the table, according to sorting, paging and filters.

Parameters

string	$sort	Title of a field where the ilTable2GUI is sorted
string	$direction	'desc' or 'asc'
int	$limit	Limit of records
int	$offset	Offset from records
array	$filter	Containing the filter values

Returns

array Array with two keys: 'record' => Contains the record objects, 'total' => Number of total records (without slicing)

Definition at line 1204 of file class.ilDclTable.php.

References Vendor\Package\$a, Vendor\Package\$b, $DIC, $id, ILIAS\LTI\ToolProvider\$key, $records, getField(), getFieldByTitle(), getId(), getObjId(), ilDclCache\getRecordCache(), getViewOwnRecordsPerm(), ilObjDataCollectionAccess\hasEditAccess(), ilObjDataCollectionAccess\hasWriteAccess(), ilSession\set(), and ILIAS\Repository\user().

Referenced by ilDclRecordListGUI\getRecordListTableGUI().

     : array {
        $sort_field = $this->getFieldByTitle($sort);
        $direction = strtolower($direction);
        $direction = (in_array($direction, ['desc', 'asc'])) ? $direction : 'asc';

        // Sorting by a status from an ILIAS Ref field. This column is added dynamically to the table, there is no field model
        $sort_by_status = false;
        if (substr($sort, 0, 8) == '_status_') {
            $sort_by_status = true;
            $sort_field = $this->getFieldByTitle(substr($sort, 8));
        }

        if (is_null($sort_field)) {
            $sort_field = $this->getField('id');
        }

        $sort_query_object = $sort_field->getRecordQuerySortObject($direction, $sort_by_status);

        $select_str = ($sort_query_object != null) ? $sort_query_object->getSelectStatement() : '';
        $join_str = ($sort_query_object != null) ? $sort_query_object->getJoinStatement() : '';
        $where_str = ($sort_query_object != null) ? $sort_query_object->getWhereStatement() : '';
        $order_str = ($sort_query_object != null) ? $sort_query_object->getOrderStatement() : '';
        $group_str = ($sort_query_object != null) ? $sort_query_object->getGroupStatement() : '';

        if (count($filter)) {
            foreach ($filter as $key => $filter_value) {
                $filter_field_id = substr($key, 7);
                $filter_field = $this->getField($filter_field_id);
                $filter_record_query_object = $filter_field->getRecordQueryFilterObject($filter_value, $sort_field);

                if ($filter_record_query_object) {
                    $select_str .= $filter_record_query_object->getSelectStatement();
                    $join_str .= $filter_record_query_object->getJoinStatement();
                    $where_str .= $filter_record_query_object->getWhereStatement();
                    $group_str .= $filter_record_query_object->getGroupStatement();
                }
            }
        }

        // Build the query string
        $sql = "SELECT DISTINCT record.id, record.owner";
        if ($select_str) {
            $sql .= ', ';
        }

        $as = ' AS ';

        $sql .= rtrim($select_str, ',') . " FROM il_dcl_record {$as} record ";
        $sql .= $join_str;
        $sql .= " WHERE record.table_id = " . $this->db->quote($this->getId(), 'integer');

        if (strlen($where_str) > 0) {
            $sql .= $where_str;
        }

        if (strlen($group_str) > 0) {
            $sql .= " GROUP BY " . $group_str;
        }

        if (strlen($order_str) > 0) {
            $sql .= " ORDER BY " . $order_str;
        }

        $set = $this->db->query($sql);
        $total_record_ids = [];

        $is_allowed_to_view = (ilObjDataCollectionAccess::hasWriteAccess($ref_id) || ilObjDataCollectionAccess::hasEditAccess($ref_id));
        while ($rec = $this->db->fetchAssoc($set)) {
            // Quick check if the current user is allowed to view the record
            if (!$is_allowed_to_view && ($this->getViewOwnRecordsPerm() && $this->user->getId() != $rec['owner'])) {
                continue;
            }
            $total_record_ids[] = $rec['id'];
        }
        // Save record-ids in session to enable prev/next links in detail view
        ilSession::set('dcl_table_id', $this->getId());
        ilSession::set('dcl_record_ids', $total_record_ids);

        if ($sort_query_object != null) {
            $total_record_ids = $sort_query_object->applyCustomSorting($sort_field, $total_record_ids, $direction);
        }

        if ($sort === 'n_comments') {
            global $DIC;
            $comments_nr = [];
            foreach ($total_record_ids as $id) {
                $comments_nr[$id] = $DIC->notes()->domain()->getNrOfCommentsForContext($DIC->notes()->data()->context($this->getObjId(), $id, 'dcl'));
            }
            uasort($comments_nr, static fn ($a, $b) => ($direction === 'asc' ? 1 : -1) * ($a <=> $b));
            $total_record_ids = array_keys($comments_nr);
        }

        // Now slice the array to load only the needed records in memory
        $record_ids = array_slice($total_record_ids, $offset, $limit);

        $records = [];
        foreach ($record_ids as $id) {
            $records[] = ilDclCache::getRecordCache($id);
        }

        return ['records' => $records, 'total' => count($total_record_ids)];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPublicCommentsEnabled()

ilDclTable::getPublicCommentsEnabled

(

)

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

References $public_comments.

Referenced by cloneStructure(), doCreate(), doUpdate(), ilDclTableListTableGUI\fillRowFromObject(), and getFieldsForFormula().

                                              : bool
    {
        return $this->public_comments;
    }

Here is the caller graph for this function:

getRecordFields()

ilDclTable::getRecordFields

(

)

Returns all fields of this table which are NOT standard fields.

Returns

ilDclBaseFieldModel[]

Definition at line 579 of file class.ilDclTable.php.

References $fields, and loadCustomFields().

Referenced by doDelete(), getEditableFields(), ilDclContentImporter\getImportFieldsFromTitles(), and ilDclDetailedViewGUI\renderRecord().

                                     : array
    {
        $this->loadCustomFields();

        return $this->fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecords()

ilDclTable::getRecords

(

)

Returns

ilDclBaseRecordModel[]

Definition at line 312 of file class.ilDclTable.php.

References $records, and loadRecords().

Referenced by _hasRecords(), afterClone(), cloneStructure(), deleteField(), and doDelete().

                                : array
    {
        if ($this->records == null) {
            $this->loadRecords();
        }

        return $this->records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSaveConfirmation()

ilDclTable::getSaveConfirmation

(

)

Definition at line 964 of file class.ilDclTable.php.

References $save_confirmation.

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

                                         : bool
    {
        return $this->save_confirmation;
    }

Here is the caller graph for this function:

getTableViews()

ilDclTable::getTableViews

(

)

Returns

ilDclTableView[] all tableviews ordered by tableview_order

Definition at line 487 of file class.ilDclTable.php.

References ilDclTableView\getAllForTableId(), and getId().

Referenced by cloneStructure(), getVisibleTableViews(), and sortTableViews().

                                   : array
    {
        return ilDclTableView::getAllForTableId($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTitle()

ilDclTable::getTitle

(

)

Definition at line 290 of file class.ilDclTable.php.

References $title.

Referenced by cloneStructure(), doCreate(), doUpdate(), and ilDclTableListTableGUI\fillRowFromObject().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getViewOwnRecordsPerm()

ilDclTable::getViewOwnRecordsPerm

(

)

Definition at line 959 of file class.ilDclTable.php.

References $view_own_records_perm.

Referenced by cloneStructure(), doCreate(), doUpdate(), getPartialRecords(), and hasPermissionToViewRecord().

                                           : bool
    {
        return (bool) $this->view_own_records_perm;
    }

Here is the caller graph for this function:

getVisibleTableViews()

ilDclTable::getVisibleTableViews	(	int	$ref_id,
		bool	$with_active_detailedview = false,
		int	$user_id = 0
	)

For current user.

Returns

ilDclTableView[]

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

References getTableViews(), ilObjDataCollectionAccess\hasAccessToTableView(), ilObjDataCollectionAccess\hasWriteAccess(), and ilDclDetailedViewDefinition\isActive().

Referenced by getFirstTableViewId().

                                                                                                               : array
    {
        if (ilObjDataCollectionAccess::hasWriteAccess($ref_id, $user_id) && !$with_active_detailedview) {
            return $this->getTableViews();
        }

        $visible_views = [];
        foreach ($this->getTableViews() as $tableView) {
            if (ilObjDataCollectionAccess::hasAccessToTableView($tableView, $user_id)) {
                if (!$with_active_detailedview || ilDclDetailedViewDefinition::isActive($tableView->getId())) {
                    $visible_views[] = $tableView;
                }
            }
        }

        return $visible_views;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasCustomFields()

ilDclTable::hasCustomFields

(

)

hasCustomFields

Returns

boolean

Definition at line 978 of file class.ilDclTable.php.

References fields, and loadCustomFields().

                                     : bool
    {
        $this->loadCustomFields();

        return count($this->fields) > 0;
    }

Here is the call graph for this function:

hasPermissionToDeleteRecord()

ilDclTable::hasPermissionToDeleteRecord	(	int	$ref_id,
		ilDclBaseRecordModel	$record
	)

Parameters

int	$ref_id	the reference id of the current datacollection object
ilDclBaseRecordModel	$record	the record which will be deleted

Definition at line 658 of file class.ilDclTable.php.

References ilObject\_lookupObjectId(), checkLimit(), doesRecordBelongToUser(), getDeleteByOwner(), getDeletePerm(), getObjId(), ilObjDataCollectionAccess\hasAddRecordAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

                                                                                          : bool
    {
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }
        if (ilObjDataCollectionAccess::hasWriteAccess($ref_id)) {
            return true;
        }
        if (!ilObjDataCollectionAccess::hasAddRecordAccess($ref_id)) {
            return false;
        }
        if (!$this->checkLimit()) {
            return false;
        }
        if ($this->getDeletePerm() && !$this->getDeleteByOwner()) {
            return true;
        }
        if ($this->getDeleteByOwner()) {
            return $this->doesRecordBelongToUser($record);
        }

        return false;
    }

Here is the call graph for this function:

hasPermissionToDeleteRecords()

ilDclTable::hasPermissionToDeleteRecords

(

int

$ref_id

)

Parameters

$ref_id

Returns

bool

Definition at line 686 of file class.ilDclTable.php.

References ilObject\_lookupObjectId(), getDeletePerm(), getObjId(), ilObjDataCollectionAccess\hasAddRecordAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

                                                             : bool
    {
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }

        return ((ilObjDataCollectionAccess::hasAddRecordAccess($ref_id) && $this->getDeletePerm())
            || ilObjDataCollectionAccess::hasWriteAccess($ref_id));
    }

Here is the call graph for this function:

hasPermissionToEditRecord()

ilDclTable::hasPermissionToEditRecord	(	int	$ref_id,
		ilDclBaseRecordModel	$record
	)

Parameters

$ref_id	int the reference id of the current datacollection object
$record	ilDclBaseRecordModel the record which will be edited

Returns

bool

Definition at line 630 of file class.ilDclTable.php.

References ilObject\_lookupObjectId(), checkLimit(), doesRecordBelongToUser(), getEditByOwner(), getEditPerm(), getObjId(), ilObjDataCollectionAccess\hasAddRecordAccess(), ilObjDataCollectionAccess\hasEditAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

                                                                                        : bool
    {
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }
        if (ilObjDataCollectionAccess::hasWriteAccess($ref_id) || ilObjDataCollectionAccess::hasEditAccess($ref_id)) {
            return true;
        }
        if (!ilObjDataCollectionAccess::hasAddRecordAccess($ref_id)) {
            return false;
        }
        if (!$this->checkLimit()) {
            return false;
        }
        if ($this->getEditPerm() && !$this->getEditByOwner()) {
            return true;
        }
        if ($this->getEditByOwner()) {
            return $this->doesRecordBelongToUser($record);
        }

        return false;
    }

Here is the call graph for this function:

hasPermissionToViewRecord()

ilDclTable::hasPermissionToViewRecord	(	int	$ref_id,
		ilDclBaseRecordModel	$record,
		int	$user_id = 0
	)

Definition at line 696 of file class.ilDclTable.php.

References ilObject\_lookupObjectId(), getObjId(), ilDclBaseRecordModel\getOwner(), getViewOwnRecordsPerm(), ilObjDataCollectionAccess\hasEditAccess(), ilObjDataCollectionAccess\hasReadAccess(), ilObjDataCollectionAccess\hasWriteAccess(), and ILIAS\Repository\user().

                                                                                                          : bool
    {
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }
        if (ilObjDataCollectionAccess::hasWriteAccess(
            $ref_id,
            $user_id
        ) || ilObjDataCollectionAccess::hasEditAccess($ref_id, $user_id)) {
            return true;
        }
        if (ilObjDataCollectionAccess::hasReadAccess($ref_id)) {
            // Check for view only own entries setting
            if ($this->getViewOwnRecordsPerm() && ($user_id ?: $this->user->getId()) != $record->getOwner()) {
                return false;
            }

            return true;
        }

        return false;
    }

Here is the call graph for this function:

loadCustomFields()

ilDclTable::loadCustomFields ( )

protected

Definition at line 374 of file class.ilDclTable.php.

References $fields, $query, ilDclCache\buildFieldFromRecord(), fields, ilDclDatatype\getAllDatatype(), getId(), and ilDclCache\preloadFieldProperties().

Referenced by getCustomFields(), getRecordFields(), hasCustomFields(), and reloadFields().

                                         : void
    {
        if (!$this->fields) {
            $query
                = "SELECT DISTINCT il_dcl_field.*, il_dcl_tfield_set.field_order
                                                    FROM il_dcl_field
                                                         INNER JOIN il_dcl_tfield_set
                                                            ON (    il_dcl_tfield_set.field NOT IN ('owner',
                                                                                                    'last_update',
                                                                                                    'last_edit_by',
                                                                                                    'id',
                                                                                                    'create_date')
                                                                AND il_dcl_tfield_set.table_id = il_dcl_field.table_id
                                                                AND il_dcl_tfield_set.field = " . $this->db->cast("il_dcl_field.id", "text") . ")
                                                   WHERE il_dcl_field.table_id = %s
                                                ORDER BY il_dcl_tfield_set.field_order ASC";

            $set = $this->db->queryF($query, ['integer'], [$this->getId()]);
            $fields = [];
            while ($rec = $this->db->fetchAssoc($set)) {
                $field = ilDclCache::buildFieldFromRecord($rec);
                if ($this->show_invalid || in_array($field->getDatatypeId(), array_keys(ilDclDatatype::getAllDatatype()))) {
                    $fields[] = $field;
                }
            }
            $this->fields = $fields;

            ilDclCache::preloadFieldProperties($fields);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadObj()

ilDclTable::loadObj ( )

protected

Definition at line 302 of file class.ilDclTable.php.

Referenced by getCollectionObject().

                                : void
    {
        if ($this->obj == null) {
            $this->obj = new ilObjDataCollection($this->objId, false);
        }
    }

Here is the caller graph for this function:

loadRecords()

ilDclTable::loadRecords

(

)

Definition at line 321 of file class.ilDclTable.php.

References $query, $records, and ilDclCache\getRecordCache().

Referenced by getRecords().

                                 : void
    {
        $records = [];
        $query = "SELECT id FROM il_dcl_record WHERE table_id = " . $this->db->quote($this->id, "integer");
        $set = $this->db->query($query);

        while ($rec = $this->db->fetchAssoc($set)) {
            $records[$rec['id']] = ilDclCache::getRecordCache($rec['id']);
        }

        $this->records = $records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reloadFields()

ilDclTable::reloadFields

(

)

Definition at line 473 of file class.ilDclTable.php.

References $fields, fields, loadCustomFields(), and sortByOrder().

Referenced by getFields().

                                  : void
    {
        $this->loadCustomFields();
        $this->stdFields = $this->getStandardFields();
        $fields = array_merge($this->fields, $this->stdFields);

        $this->sortByOrder($fields);

        $this->all_fields = $fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAddPerm()

ilDclTable::setAddPerm

(

bool

$add_perm

)

Definition at line 808 of file class.ilDclTable.php.

References $add_perm.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setDefaultSortField()

ilDclTable::setDefaultSortField

(

string

$default_sort_field

)

Definition at line 920 of file class.ilDclTable.php.

References $default_sort_field.

Referenced by cloneStructure(), and doRead().

                                                                   : void
    {
        $default_sort_field = ($default_sort_field) ?: 0; // Change null or empty strings to zero
        $this->default_sort_field = $default_sort_field;
    }

Here is the caller graph for this function:

setDefaultSortFieldOrder()

ilDclTable::setDefaultSortFieldOrder

(

string

$default_sort_field_order

)

Definition at line 931 of file class.ilDclTable.php.

References $default_sort_field_order.

Referenced by cloneStructure(), and doRead().

                                                                              : void
    {
        if (!in_array($default_sort_field_order, ['asc', 'desc'])) {
            $default_sort_field_order = 'asc';
        }
        $this->default_sort_field_order = $default_sort_field_order;
    }

Here is the caller graph for this function:

setDeleteByOwner()

ilDclTable::setDeleteByOwner

(

bool

$delete_by_owner

)

Definition at line 849 of file class.ilDclTable.php.

References $delete_by_owner, and setDeletePerm().

Referenced by cloneStructure(), doRead(), and setDeletePerm().

                                                           : void
    {
        $this->delete_by_owner = $delete_by_owner;
        if ($delete_by_owner) {
            $this->setDeletePerm(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDeletePerm()

ilDclTable::setDeletePerm

(

bool

$delete_perm

)

Definition at line 818 of file class.ilDclTable.php.

References $delete_perm, and setDeleteByOwner().

Referenced by cloneStructure(), doRead(), and setDeleteByOwner().

                                                    : void
    {
        $this->delete_perm = $delete_perm;
        if (!$delete_perm) {
            $this->setDeleteByOwner(false);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDescription()

ilDclTable::setDescription

(

string

$description

)

Definition at line 910 of file class.ilDclTable.php.

References $description.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setEditByOwner()

ilDclTable::setEditByOwner

(

bool

$edit_by_owner

)

Definition at line 831 of file class.ilDclTable.php.

References $edit_by_owner, and setEditPerm().

Referenced by cloneStructure(), doRead(), and setEditPerm().

                                                       : void
    {
        $this->edit_by_owner = $edit_by_owner;
        if ($edit_by_owner) {
            $this->setEditPerm(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setEditPerm()

ilDclTable::setEditPerm

(

bool

$edit_perm

)

Definition at line 857 of file class.ilDclTable.php.

References $edit_perm, and setEditByOwner().

Referenced by cloneStructure(), doRead(), and setEditByOwner().

                                                : void
    {
        $this->edit_perm = $edit_perm;
        if (!$edit_perm) {
            $this->setEditByOwner(false);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setExportEnabled()

ilDclTable::setExportEnabled

(

bool

$export_enabled

)

Definition at line 1131 of file class.ilDclTable.php.

References $export_enabled.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setId()

ilDclTable::setId

(

int

$a_id

)

Set table id.

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

Referenced by doCreate().

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

Here is the caller graph for this function:

setImportEnabled()

ilDclTable::setImportEnabled

(

bool

$import_enabled

)

Definition at line 1168 of file class.ilDclTable.php.

References $import_enabled.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setIsVisible()

ilDclTable::setIsVisible

(

bool

$is_visible

)

Definition at line 900 of file class.ilDclTable.php.

References $is_visible.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setLimited()

ilDclTable::setLimited

(

bool

$limited

)

Definition at line 870 of file class.ilDclTable.php.

References $limited.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setLimitEnd()

ilDclTable::setLimitEnd

(

?string

$limit_end

)

Definition at line 880 of file class.ilDclTable.php.

References $limit_end.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setLimitStart()

ilDclTable::setLimitStart

(

?string

$limit_start

)

Definition at line 890 of file class.ilDclTable.php.

References $limit_start.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setObjId()

ilDclTable::setObjId

(

int

$a_id

)

Definition at line 275 of file class.ilDclTable.php.

Referenced by doRead().

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

Here is the caller graph for this function:

setOrder()

ilDclTable::setOrder

(

int

$table_order

)

Definition at line 1163 of file class.ilDclTable.php.

References $table_order.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setPublicCommentsEnabled()

ilDclTable::setPublicCommentsEnabled

(

bool

$public_comments

)

Definition at line 944 of file class.ilDclTable.php.

References $public_comments.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setSaveConfirmation()

ilDclTable::setSaveConfirmation

(

bool

$save_confirmation

)

Definition at line 969 of file class.ilDclTable.php.

References $save_confirmation.

Referenced by cloneStructure(), and doRead().

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

Here is the caller graph for this function:

setTitle()

ilDclTable::setTitle

(

string

$a_title

)

Definition at line 285 of file class.ilDclTable.php.

Referenced by cloneStructure(), and doRead().

                                             : void
    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setViewOwnRecordsPerm()

ilDclTable::setViewOwnRecordsPerm

(

bool

$view_own_perm

)

Definition at line 954 of file class.ilDclTable.php.

References ILIAS\Repository\int().

Referenced by cloneStructure(), and doRead().

                                                              : void
    {
        $this->view_own_records_perm = (int) $view_own_perm;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showInvalidFields()

ilDclTable::showInvalidFields

(

bool

$value

)

Definition at line 1314 of file class.ilDclTable.php.

                                                  : void
    {
        $this->show_invalid = $value;
    }

sortByOrder()

ilDclTable::sortByOrder ( array &  $array )

protected

Parameters

ilDclBaseFieldModel[]

$array the array to sort

Definition at line 766 of file class.ilDclTable.php.

Referenced by buildOrderFields(), reloadFields(), and sortFields().

                                                 : void
    {
        // php-bug: https://bugs.php.net/bug.php?id=50688
        // fixed in php 7 but for now we need the @ a workaround
        usort($array, [$this, "compareOrder"]);
    }

Here is the caller graph for this function:

sortFields()

ilDclTable::sortFields

(

array &

$fields

)

sortFields

Parameters

ilDclBaseFieldModel[]

$fields

Definition at line 751 of file class.ilDclTable.php.

References sortByOrder().

                                              : void
    {
        $this->sortByOrder($fields);
        //After sorting the array loses it's keys respectivly their keys are set form $field->id to 1,2,3... so we reset the keys.
        $named = [];
        foreach ($fields as $field) {
            $named[$field->getId()] = $field;
        }

        $fields = $named;
    }

Here is the call graph for this function:

sortTableViews()

ilDclTable::sortTableViews

(

array

$tableviews = null

)

Parameters

ilDclTableView[]

$tableviews

Definition at line 445 of file class.ilDclTable.php.

References getTableViews().

                                                            : void
    {
        if ($tableviews == null) {
            $tableviews = $this->getTableViews();
        }

        $order = 10;
        foreach ($tableviews as $tableview) {
            $tableview->setTableviewOrder($order);
            $tableview->update();
            $order += 10;
        }
    }

Here is the call graph for this function:

updateFields()

ilDclTable::updateFields

(

)

Update fields.

Definition at line 740 of file class.ilDclTable.php.

References getFields().

                                  : void
    {
        foreach ($this->getFields() as $field) {
            $field->doUpdate();
        }
    }

Here is the call graph for this function:

updateOrder()

ilDclTable::updateOrder

(

)

Definition at line 1150 of file class.ilDclTable.php.

References getId().

Referenced by getOrder().

                                 : void
    {
        $result = $this->db->query('SELECT MAX(table_order) AS table_order FROM il_dcl_table WHERE obj_id = ' . $this->db->quote(
            $this->getCollectionObject()->getId(),
            'integer'
        ));
        $this->table_order = $this->db->fetchObject($result)->table_order + 10;
        $this->db->query('UPDATE il_dcl_table SET table_order = ' . $this->db->quote(
            $this->table_order,
            'integer'
        ) . ' WHERE id = ' . $this->db->quote($this->getId(), 'integer'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$add_perm

bool ilDclTable::$add_perm = false

protected

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

Referenced by getAddPerm(), and setAddPerm().

$all_fields

array ilDclTable::$all_fields = null

protected

table fields and std fields combined

Definition at line 74 of file class.ilDclTable.php.

Referenced by getFields().

$db

ilDBInterface ilDclTable::$db

protected

Definition at line 78 of file class.ilDclTable.php.

$default_sort_field

int string ilDclTable::$default_sort_field = 0

protected

ID of the default sorting field.

Can be a DB field (int) or a standard field (string)

Definition at line 54 of file class.ilDclTable.php.

Referenced by cloneStructure(), getDefaultSortField(), and setDefaultSortField().

$default_sort_field_order

string ilDclTable::$default_sort_field_order = 'asc'

protected

Default sort-order (asc|desc)

Definition at line 58 of file class.ilDclTable.php.

Referenced by getDefaultSortFieldOrder(), and setDefaultSortFieldOrder().

$delete_by_owner

bool ilDclTable::$delete_by_owner = false

protected

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

Referenced by getDeleteByOwner(), and setDeleteByOwner().

$delete_perm

bool ilDclTable::$delete_perm = false

protected

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

Referenced by getDeletePerm(), and setDeletePerm().

$description

string ilDclTable::$description = ''

protected

Description for this table displayed above records.

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

Referenced by getDescription(), and setDescription().

$edit_by_owner

bool ilDclTable::$edit_by_owner = false

protected

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

Referenced by getEditByOwner(), and setEditByOwner().

$edit_perm

bool ilDclTable::$edit_perm = false

protected

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

Referenced by getEditPerm(), and setEditPerm().

$export_enabled

bool ilDclTable::$export_enabled = false

protected

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

Referenced by getExportEnabled(), and setExportEnabled().

$fields

array ilDclTable::$fields = []

protected

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

Referenced by getCustomFields(), getRecordFields(), loadCustomFields(), and reloadFields().

$http

ILIAS HTTP Services ilDclTable::$http

protected

Definition at line 75 of file class.ilDclTable.php.

$id

int ilDclTable::$id = 0

protected

Definition at line 21 of file class.ilDclTable.php.

Referenced by _getTableIdByTitle(), getId(), and getPartialRecords().

$import_enabled

bool ilDclTable::$import_enabled = false

protected

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

Referenced by getImportEnabled(), and setImportEnabled().

$is_visible

bool ilDclTable::$is_visible = false

protected

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

Referenced by getIsVisible(), and setIsVisible().

$limit_end

string ilDclTable::$limit_end = null

protected

Definition at line 46 of file class.ilDclTable.php.

Referenced by getLimitEnd(), and setLimitEnd().

$limit_start

string ilDclTable::$limit_start = null

protected

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

Referenced by getLimitStart(), and setLimitStart().

$limited

bool ilDclTable::$limited = false

protected

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

Referenced by getLimited(), and setLimited().

$obj

ilObjDataCollection ilDclTable::$obj = null

protected

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

Referenced by getCollectionObject().

$objId

int ilDclTable::$objId = null

protected

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

Referenced by getObjId().

$public_comments

int ilDclTable::$public_comments = 0

protected

True if users can add comments on each record of this table.

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

Referenced by getPublicCommentsEnabled(), and setPublicCommentsEnabled().

$records

array ilDclTable::$records = []

protected

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

Referenced by getPartialRecords(), getRecords(), and loadRecords().

$refinery

ILIAS Refinery Factory ilDclTable::$refinery

protected

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

$save_confirmation

bool ilDclTable::$save_confirmation = false

protected

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

Referenced by getSaveConfirmation(), and setSaveConfirmation().

$show_invalid

bool ilDclTable::$show_invalid = false

protected

Definition at line 79 of file class.ilDclTable.php.

$stdFields

array ilDclTable::$stdFields = []

protected

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

Referenced by getFieldsForFormula().

$table_order

int ilDclTable::$table_order = 0

protected

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

Referenced by getOrder(), and setOrder().

$title

string ilDclTable::$title = ""

protected

Definition at line 24 of file class.ilDclTable.php.

Referenced by getFieldByTitle(), and getTitle().

$user

ilObjUser ilDclTable::$user

protected

Definition at line 77 of file class.ilDclTable.php.

$view_own_records_perm

int ilDclTable::$view_own_records_perm = 0

protected

True if user can only view his/her own entries in the table.

Definition at line 70 of file class.ilDclTable.php.

Referenced by getViewOwnRecordsPerm().

---

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

• Modules/DataCollection/classes/Table/class.ilDclTable.php