ilObjDataCollectionAccess Class Reference

Class ilObjDataCollectionAccess. More...

Inheritance diagram for ilObjDataCollectionAccess:

Collaboration diagram for ilObjDataCollectionAccess:

Public Member Functions
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
Public Member Functions inherited from ilObjectAccess
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id)
	check condition More...

Static Public Member Functions
static	_getCommands ()
	get commands More...
static	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	_lookupOnline ($a_id)
	Check wether datacollection is online. More...
static	checkAccessForDataCollectionId ($data_collection_id)
static	checkActionForObjId ($action, $obj_id)
static	hasWriteAccess ($ref, $user_id=0)
static	hasEditAccess ($ref, $user_id=0)
	Has permission to view and edit all entries event when he is not the owner. More...
static	hasAddRecordAccess ($ref, $user_id=0)
static	hasReadAccess ($ref, $user_id=0)
static	hasAccessToTableView ($tableview, $user_id=0)
	This only checks access to the tableview - if the full access check is required, use hasAccessTo($ref_id, $table_id, $tableview_id) More...
static	hasAccessToFields ($ref_id, $table_id)
static	hasAccessToEditTable ($ref_id, $table_id)
static	hasAccessToField ($ref_id, $table_id, $field_id)
static	hasPermissionToAddRecord ($ref_id, $table_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten. More...
static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Static Protected Member Functions
static	isTableInDataCollection ($table, $ref_id)
static	hasAccessToTable ($table_id)
	returns true if either the table is visible for all users, or no tables are visible and this is the table with the lowest order (getFirstVisibleTableId()) More...

Detailed Description

Class ilObjDataCollectionAccess.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

Id

class.ilObjDataCollectionAccess.php 15678 2008-01-06 20:40:55Z akill

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

Member Function Documentation

_checkAccess()

ilObjDataCollectionAccess::_checkAccess	(		$a_cmd,
			$a_permission,
			$a_ref_id,
			$a_obj_id,
			$a_user_id = ""
	)

checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess)

Parameters

string	$a_cmd	command (not permission!)
string	$a_permission	permission
int	$a_ref_id	reference id
int	$a_obj_id	object id
int	$a_user_id	user id (if not provided, current user is taken)

Returns

boolean true, if everything is ok

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

References $DIC, $ilUser, $lng, _lookupOnline(), IL_NO_OBJECT_ACCESS, and IL_STATUS_MESSAGE.

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

        if ($a_user_id == "") {
            $a_user_id = $ilUser->getId();
        }
        switch ($a_cmd) {
            case "view":

                if (!ilObjDataCollectionAccess::_lookupOnline($a_obj_id)
                    && !$rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id)
                ) {
                    $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));

                    return false;
                }
                break;

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

                    return false;
                }
                break;
        }

        return true;
    }

Here is the call graph for this function:

_checkGoto()

static ilObjDataCollectionAccess::_checkGoto (   $a_target )

static

check whether goto script will succeed

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

References $DIC.

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

        $t_arr = explode("_", $a_target);

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

        if ($ilAccess->checkAccess("read", "", $t_arr[1])) {
            return true;
        }

        return false;
    }

_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 31 of file class.ilObjDataCollectionAccess.php.

References array.

Referenced by ilObjDataCollectionListGUI\init().

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

        return $commands;
    }

Here is the caller graph for this function:

_lookupOnline()

static ilObjDataCollectionAccess::_lookupOnline (   $a_id )

static

Check wether datacollection is online.

Parameters

int

$a_id

wiki id

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

References $DIC, and $ilDB.

Referenced by _checkAccess(), and ilObjDataCollectionListGUI\getProperties().

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

        $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 $dcl_rec["is_online"];
    }

Here is the caller graph for this function:

checkAccessForDataCollectionId()

static ilObjDataCollectionAccess::checkAccessForDataCollectionId (   $data_collection_id )

static

Parameters

$data_collection_id

use checkActionForId instead

Returns

bool

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

References $DIC, and ilObject2\_getAllReferences().

    {
        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 (   $action,   $obj_id  )

static

Parameters

$action
$obj_id

Returns

bool

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

References $action, $DIC, and ilObject2\_getAllReferences().

Referenced by ilDclTableEditGUI\save().

    {
        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 (   $ref_id,   $table_id  )

static

Parameters

$ref_id
$table_id

Returns

bool

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

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

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

Here is the caller graph for this function:

hasAccessToField()

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

static

Parameters

$ref_id
$table_id
$field_id

Returns

bool

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

References $table, and ilDclCache\getTableCache().

Referenced by ilDclFieldEditGUI\checkAccess().

    {
        $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 (   $ref_id,   $table_id  )

static

Parameters

$ref_id
$table_id

Returns

bool

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

References ilDclCache\getTableCache().

Referenced by ilDclFieldEditGUI\checkAccess(), ilDclRecordListGUI\executeCommand(), and ilDclFieldListTableGUI\fillRow().

    {
        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 (   $table_id )

staticprotected

returns true if either the table is visible for all users, or no tables are visible and this is the table with the lowest order (getFirstVisibleTableId())

Parameters

$table_id

Returns

bool

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

References $table, and ilDclCache\getTableCache().

    {
        $table = ilDclCache::getTableCache($table_id);
        return $table->getIsVisible() || ($table_id == $table->getCollectionObject()->getFirstVisibleTableId());
    }

Here is the call graph for this function:

hasAccessToTableView()

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

static

This only checks access to the tableview - if the full access check is required, use hasAccessTo($ref_id, $table_id, $tableview_id)

Parameters

integer | ilDclTableView	$tableview	can be object or id
int	$user_id

Returns

bool

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

References $DIC, and $ilUser.

Referenced by ilDclTable\getVisibleTableViews().

    {
        global $DIC;
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];
        if (!$tableview) {
            return false;
        }
        

        if (is_numeric($tableview)) {
            $tableview = ilDclTableView::find($tableview);
        }

        $assigned_roles = $rbacreview->assignedRoles($user_id ? $user_id : $ilUser->getId());
        $allowed_roles = $tableview->getRoles();

        return !empty(array_intersect($assigned_roles, $allowed_roles));
    }

Here is the caller graph for this function:

hasAddRecordAccess()

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

static

Parameters

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

Returns

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

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

References $DIC.

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

    {
        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 (   $ref,   $user_id = 0  )

static

Has permission to view and edit all entries event when he is not the owner.

Parameters

	$ref
int	$user_id

Returns

mixed

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

References $DIC.

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

    {
        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 (   $ref_id,   $table_id  )

static

Parameters

int

$ref_id

Returns

bool

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

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

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

    {
        $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 (   $ref,   $user_id = 0  )

static

Parameters

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

Returns

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

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

References $DIC.

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

    {
        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 (   $ref,   $user_id = 0  )

static

Parameters

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

Returns

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

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

References $DIC.

Referenced by ilDclTable\_hasFieldByTitle(), ilObjDataCollection\_hasWriteAccess(), ilDclRecordEditGUI\cancelSave(), ilDclTableListGUI\checkAccess(), ilDclTableEditGUI\checkAccess(), ilDclDetailedViewGUI\doExtReplace(), ilObjDataCollection\doUpdate(), ilDclRecordListGUI\getAvailableTables(), ilDclTable\getVisibleTableViews(), hasPermissionToAddRecord(), ilDclTable\hasPermissionToDeleteRecord(), ilDclTable\hasPermissionToDeleteRecords(), ilDclTable\hasPermissionToEditRecord(), ilDclTable\hasPermissionToViewRecord(), ilDclRecordEditGUI\initForm(), and ilDclRecordEditGUI\save().

    {
        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 (   $table,   $ref_id  )

staticprotected

Parameters

ilDclTable	$table
	$ref_id

Returns

bool

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

References $table, and ilObject2\_getAllReferences().

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

• Modules/DataCollection/classes/class.ilObjDataCollectionAccess.php