ilObjDataCollectionAccess Class Reference

Inheritance diagram for ilObjDataCollectionAccess:

Collaboration diagram for ilObjDataCollectionAccess:

Public Member Functions
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
	get commands this method returns an array of all possible commands/permission combinations example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), ); More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_lookupOnline (int $a_id)
	Check wether datacollection is online. More...
static	checkAccessForDataCollectionId (int $data_collection_id)
static	checkActionForObjId (string $action, int $obj_id)
static	hasWriteAccess (int $ref, ?int $user_id=0)
static	hasEditAccess (int $ref, ?int $user_id=0)
static	hasAddRecordAccess (int $ref, ?int $user_id=0)
static	hasReadAccess (int $ref, ?int $user_id=0)
static	hasAccessToTableView (ilDclTableView $tableview, ?int $user_id=0)
static	hasAccessToFields (int $ref_id, int $table_id)
static	hasAccessToEditTable (int $ref_id, int $table_id)
static	hasAccessToField (int $ref_id, int $table_id, int $field_id)
static	hasPermissionToAddRecord (int $ref_id, int $table_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Static Protected Member Functions
static	isTableInDataCollection (ilDclTable $table, int $ref_id)
static	hasAccessToTable (int $table_id, int $ref_id)

Detailed Description

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

Member Function Documentation

_checkAccess()

ilObjDataCollectionAccess::_checkAccess	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = null
	)

Definition at line 80 of file class.ilObjDataCollectionAccess.php.

References $DIC, $lng, $user_id, _lookupOnline(), ilAccessInfo\IL_NO_OBJECT_ACCESS, and ilAccessInfo\IL_STATUS_MESSAGE.

                                                                                                                 : bool
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilAccess = $DIC['ilAccess'];

        if (is_null($user_id) === true) {
            $user_id = $ilUser->getId();
        }

        switch ($cmd) {
            case "view":

                if (!ilObjDataCollectionAccess::_lookupOnline($obj_id)
                    && !$rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id)
                ) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));

                    return false;
                }
                break;

                // for permission query feature
            case "infoScreen":
                if (!ilObjDataCollectionAccess::_lookupOnline($obj_id)) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                } else {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_STATUS_MESSAGE, $lng->txt("online"));
                }
                break;
        }
        switch ($permission) {
            case "read":
            case "visible":
                if (!ilObjDataCollectionAccess::_lookupOnline($obj_id)
                    && (!$rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id))
                ) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));

                    return false;
                }
                break;
        }

        return true;
    }

Here is the call graph for this function:

_checkGoto()

static ilObjDataCollectionAccess::_checkGoto ( string  $target )

static

check whether goto script will succeed

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

References $DIC, $ref_id, and ILIAS\Repository\int().

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

        $t_arr = explode("_", $target);
        $ref_id = (int) $t_arr[1];

        if ($t_arr[0] != "dcl" || $ref_id <= 0) {
            return false;
        }

        if ($ilAccess->checkAccess("read", "", $ref_id) ||
            $ilAccess->checkAccess("visible", "", $ref_id)) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

_getCommands()

static ilObjDataCollectionAccess::_getCommands ( )

static

get commands this method returns an array of all possible commands/permission combinations example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );

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

Referenced by ilObjDataCollectionListGUI\init().

                                         : array
    {
        $commands = [
            ["permission" => "read", "cmd" => "render", "lang_var" => "show", "default" => true],
            ["permission" => "write", "cmd" => "listRecords", "lang_var" => "edit_content"],
            ["permission" => "write", "cmd" => "edit", "lang_var" => "settings"],
        ];

        return $commands;
    }

Here is the caller graph for this function:

_lookupOnline()

static ilObjDataCollectionAccess::_lookupOnline ( int  $a_id )

static

Check wether datacollection is online.

Parameters

int

$a_id

wiki id

Definition at line 133 of file class.ilObjDataCollectionAccess.php.

References $DIC, $ilDB, and $q.

Referenced by _checkAccess(), ilObjDataCollectionListGUI\getProperties(), and ILIAS\UI\Component\Legacy\Content\Filter\FilterManager\legacyOnlineFilter().

                                                   : bool
    {
        global $DIC;
        $ilDB = $DIC->database();

        $q = "SELECT * FROM il_dcl_data WHERE id = " . $ilDB->quote($a_id, "integer");
        $dcl_set = $ilDB->query($q);
        $dcl_rec = $ilDB->fetchAssoc($dcl_set);

        return !is_null($dcl_rec) && $dcl_rec["is_online"];
    }

Here is the caller graph for this function:

checkAccessForDataCollectionId()

static ilObjDataCollectionAccess::checkAccessForDataCollectionId ( int  $data_collection_id )

static

Parameters

$data_collection_id

use checkActionForId instead

Returns

bool

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

References $DIC, and ilObject\_getAllReferences().

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

        $perm = false;
        $references = ilObject2::_getAllReferences($data_collection_id);

        if ($ilAccess->checkAccess("add_entry", "", array_shift($references))) {
            $perm = true;
        }

        return $perm;
    }

Here is the call graph for this function:

checkActionForObjId()

static ilObjDataCollectionAccess::checkActionForObjId ( string  $action, int  $obj_id  )

static

Definition at line 169 of file class.ilObjDataCollectionAccess.php.

References $DIC, $ref_id, and ilObject\_getAllReferences().

Referenced by ilDclTableEditGUI\save().

                                                                           : bool
    {
        foreach (ilObject2::_getAllReferences($obj_id) as $ref_id) {
            if (self::checkActionForRefId($action, $ref_id)) {
                return true;
            }
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasAccessToEditTable()

static ilObjDataCollectionAccess::hasAccessToEditTable ( int  $ref_id, int  $table_id  )

static

Definition at line 296 of file class.ilObjDataCollectionAccess.php.

Referenced by ilDclTableViewGUI\checkAccess(), ilDclFieldListGUI\checkAccess(), ilDclTableEditGUI\checkAccess(), and ilDclTableViewEditGUI\checkAccess().

                                                                           : bool
    {
        return self::hasAccessToFields($ref_id, $table_id);
    }

Here is the caller graph for this function:

hasAccessToField()

static ilObjDataCollectionAccess::hasAccessToField ( int  $ref_id, int  $table_id, int  $field_id  )

static

Definition at line 301 of file class.ilObjDataCollectionAccess.php.

References ilDclCache\getTableCache().

Referenced by ilDclFieldEditGUI\checkAccess().

                                                                                      : bool
    {
        $table = ilDclCache::getTableCache($table_id);

        return in_array($field_id, $table->getFieldIds()) && self::hasAccessToFields($ref_id, $table_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasAccessToFields()

static ilObjDataCollectionAccess::hasAccessToFields ( int  $ref_id, int  $table_id  )

static

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

References ilDclCache\getTableCache().

Referenced by ilDclFieldEditGUI\checkAccess(), ilDclFieldListTableGUI\fillRowFromObject(), and ilDclRecordListGUI\listRecords().

                                                                        : bool
    {
        return self::isTableInDataCollection(ilDclCache::getTableCache($table_id), $ref_id)
            && (self::hasWriteAccess($ref_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasAccessToTable()

static ilObjDataCollectionAccess::hasAccessToTable ( int  $table_id, int  $ref_id  )

staticprotected

Definition at line 264 of file class.ilObjDataCollectionAccess.php.

References ilDclCache\getTableCache().

                                                                          : bool
    {
        $table = ilDclCache::getTableCache($table_id);
        return self::hasWriteAccess($ref_id) || $table->getIsVisible();
    }

Here is the call graph for this function:

hasAccessToTableView()

static ilObjDataCollectionAccess::hasAccessToTableView ( ilDclTableView  $tableview, ?int  $user_id = 0  )

static

Definition at line 252 of file class.ilObjDataCollectionAccess.php.

References $DIC, $user_id, ilDclTableView\getRoleLimitation(), and ilDclTableView\getRoles().

Referenced by ilDclTable\getVisibleTableViews().

                                                                                             : bool
    {
        if ($tableview->getRoleLimitation()) {
            global $DIC;
            $assigned_roles = $DIC->rbac()->review()->assignedRoles($user_id ?: $DIC->user()->getId());
            $allowed_roles = $tableview->getRoles();

            return array_intersect($assigned_roles, $allowed_roles) !== [];
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasAddRecordAccess()

static ilObjDataCollectionAccess::hasAddRecordAccess ( int  $ref, ?int  $user_id = 0  )

static

Parameters

$ref	int the reference id of the datacollection object to check.

Returns

bool whether or not the current user has admin/write access to the referenced datacollection

Definition at line 224 of file class.ilObjDataCollectionAccess.php.

References $DIC, and $user_id.

Referenced by ilDclRecordEditGUI\getRecord(), hasPermissionToAddRecord(), ilDclTable\hasPermissionToDeleteRecord(), ilDclTable\hasPermissionToDeleteRecords(), and ilDclTable\hasPermissionToEditRecord().

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

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("add_entry", "", $ref);
    }

Here is the caller graph for this function:

hasEditAccess()

static ilObjDataCollectionAccess::hasEditAccess ( int  $ref, ?int  $user_id = 0  )

static

Definition at line 208 of file class.ilObjDataCollectionAccess.php.

References $DIC, and $user_id.

Referenced by ilDclRecordEditGUI\cancelSave(), ilDclTable\getPartialRecords(), ilDclTable\hasPermissionToEditRecord(), and ilDclTable\hasPermissionToViewRecord().

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

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("edit_content", "", $ref);
    }

Here is the caller graph for this function:

hasPermissionToAddRecord()

static ilObjDataCollectionAccess::hasPermissionToAddRecord ( int  $ref_id, int  $table_id  )

static

Definition at line 308 of file class.ilObjDataCollectionAccess.php.

References ilDclCache\getTableCache(), hasAddRecordAccess(), and hasWriteAccess().

Referenced by ilDclReferenceFieldRepresentation\getInputField(), ilDclRecordListGUI\importExcel(), ilDclRecordListGUI\listRecords(), and ilDclRecordEditGUI\save().

                                                                               : bool
    {
        $table = ilDclCache::getTableCache($table_id);
        if (!self::isTableInDataCollection($table, $ref_id)) {
            return false;
        }

        return ilObjDataCollectionAccess::hasWriteAccess($ref_id)
            || (ilObjDataCollectionAccess::hasAddRecordAccess($ref_id) && $table->getAddPerm() && $table->checkLimit());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasReadAccess()

static ilObjDataCollectionAccess::hasReadAccess ( int  $ref, ?int  $user_id = 0  )

static

Parameters

$ref	int the reference id of the datacollection object to check.

Returns

bool whether or not the current user has read access to the referenced datacollection

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

References $DIC, and $user_id.

Referenced by ilSoapDataCollectionAdministration\exportDataCollectionContent(), and ilDclTable\hasPermissionToViewRecord().

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

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("read", "", $ref);
    }

Here is the caller graph for this function:

hasWriteAccess()

static ilObjDataCollectionAccess::hasWriteAccess ( int  $ref, ?int  $user_id = 0  )

static

Parameters

$ref	int the reference id of the datacollection object to check.

Returns

bool whether or not the current user has admin/write access to the referenced datacollection

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

References $DIC, and $user_id.

Referenced by ilDclRecordEditGUI\cancelSave(), ilDclTableListGUI\checkAccess(), ilDclTableEditGUI\checkAccess(), ilDclRecordListGUI\createSwitchers(), ilDclDetailedViewGUI\doExtReplace(), ilDclTable\getPartialRecords(), ilDclTable\getVisibleTableViews(), hasPermissionToAddRecord(), ilDclTable\hasPermissionToDeleteRecord(), ilDclTable\hasPermissionToDeleteRecords(), ilDclTable\hasPermissionToEditRecord(), ilDclTable\hasPermissionToViewRecord(), ilDclRecordEditGUI\initForm(), ilDclRecordEditGUI\save(), and ilObjDataCollectionGUI\setTableId().

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

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("write", "", $ref);
    }

Here is the caller graph for this function:

isTableInDataCollection()

static ilObjDataCollectionAccess::isTableInDataCollection ( ilDclTable  $table, int  $ref_id  )

staticprotected

Definition at line 67 of file class.ilObjDataCollectionAccess.php.

References ilObject\_getAllReferences(), ilDclTable\getObjId(), and null.

                                                                                     : bool
    {
        if ($table->getObjId() !== null) {
            foreach (ilObjDataCollection::_getAllReferences($table->getObjId()) as $reference) {
                if ($reference == $ref_id) {
                    return true;
                }
            }
        }

        return false;
    }

Here is the call graph for this function:

---

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

• components/ILIAS/DataCollection/classes/class.ilObjDataCollectionAccess.php