ilObjContentObjectAccess Class Reference

Class ilObjContentObjectAccess. More...

Inheritance diagram for ilObjContentObjectAccess:

Collaboration diagram for ilObjContentObjectAccess:

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...
	_lookupOnline ($a_id)
	check wether learning module is online More...
	_getLastAccessedPage ($a_ref_id, $a_user_id="")
	get last accessed page More...
	_checkGoto ($a_target)
	check whether goto script will succeed More...
	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. 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...
	_getCommands ()
	get commands More...
	_checkGoto ($a_target)
	check whether goto script will succeed More...
	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Static Public Member Functions
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status. More...
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten. More...

Static Public Attributes
static	$online
static	$lo_access

Detailed Description

Class ilObjContentObjectAccess.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 17 of file class.ilObjContentObjectAccess.php.

Member Function Documentation

_checkAccess()

ilObjContentObjectAccess::_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

Reimplemented from ilObjectAccess.

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

        {
                global $ilUser, $lng, $rbacsystem, $ilAccess;
 
                if ($a_user_id == "")
                {
                        $a_user_id = $ilUser->getId();
                }
 
                switch ($a_cmd)
                {
                        case "view":
 
                                if(!ilObjContentObjectAccess::_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;
                                
                        case "continue":                                
                                if(!$rbacsystem->checkAccessOfUser($a_user_id,'write',$a_ref_id))
                                {
                                        if(!ilObjContentObjectAccess::_lookupOnline($a_obj_id))
                                        {
                                                $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                                                return false;
                                        }
                                }
                                
                                // continue is now default and works all the time
                                // see ilLMPresentationGUI::resume()
                                /*
                                if ($ilUser->getId() == ANONYMOUS_USER_ID)
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("lm_no_continue_for_anonym"));
                                        return false;
                                }                                                                                                       
                                if (ilObjContentObjectAccess::_getLastAccessedPage($a_ref_id,$a_user_id) <= 0)
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("not_accessed_yet"));
                                        return false;
                                }                                        
                                */                              
                                break;
                                
                        // for permission query feature
                        case "info":
                                if(!ilObjContentObjectAccess::_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 (!ilObjContentObjectAccess::_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;
        }

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

Here is the call graph for this function:

_checkGoto()

ilObjContentObjectAccess::_checkGoto

(

$a_target

)

check whether goto script will succeed

Reimplemented from ilObjectAccess.

Definition at line 185 of file class.ilObjContentObjectAccess.php.

        {
                global $ilAccess;
                
                $t_arr = explode("_", $a_target);
 
                if (($t_arr[0] != "lm" &&  $t_arr[0] != "dbk" &&  $t_arr[0] != "st"
                        &&  $t_arr[0] != "pg")
                        || ((int) $t_arr[1]) <= 0)
                {
                        return false;
                }
 
                if ($t_arr[0] == "lm" || $t_arr[0] == "dbk")
                {
                        if ($ilAccess->checkAccess("read", "", $t_arr[1]) ||
                                $ilAccess->checkAccess("visible", "", $t_arr[1]))
                        {
                                return true;
                        }
                }
                else
                {
                        if ($t_arr[2] > 0)
                        {
                                $ref_ids = array($t_arr[2]);
                        }
                        else
                        {
                                // determine learning object
                                include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                $lm_id = ilLMObject::_lookupContObjID($t_arr[1]);
                                $ref_ids = ilObject::_getAllReferences($lm_id);
                        }
                        // check read permissions
                        foreach ($ref_ids as $ref_id)
                        {
                                // Permission check
                                if ($ilAccess->checkAccess("read", "", $ref_id))
                                {
                                        return true;
                                }
                        }
 
                }
                return false;
        }

References $ref_id, ilObject\_getAllReferences(), and ilLMObject\_lookupContObjID().

Here is the call graph for this function:

_getLastAccessedPage()

ilObjContentObjectAccess::_getLastAccessedPage	(		$a_ref_id,
			$a_user_id = ""
	)

get last accessed page

Parameters

int	$a_obj_id	content object id
int	$a_user_id	user object id

Definition at line 144 of file class.ilObjContentObjectAccess.php.

        {
                global $ilDB, $ilUser;
                
                if ($a_user_id == "")
                {
                        $a_user_id = $ilUser->getId();
                }
 
                if (isset(self::$lo_access[$a_ref_id]))
                {
                        $acc_rec["obj_id"] = self::$lo_access[$a_ref_id];
                }
                else
                {
                        $q = "SELECT * FROM lo_access WHERE ".
                                "usr_id = ".$ilDB->quote($a_user_id, "integer")." AND ".
                                "lm_id = ".$ilDB->quote($a_ref_id, "integer");
        
                        $acc_set = $ilDB->query($q);
                        $acc_rec = $ilDB->fetchAssoc($acc_set);
                }
                
                if ($acc_rec["obj_id"] > 0)
                {
                        $lm_id = ilObject::_lookupObjId($a_ref_id);
                        $mtree = new ilTree($lm_id);
                        $mtree->setTableNames('lm_tree','lm_data');
                        $mtree->setTreeTablePK("lm_id");
                        if ($mtree->isInTree($acc_rec["obj_id"]))
                        {
                                return $acc_rec["obj_id"];
                        }
                }
                
                return 0;
        }

References $ilDB, $ilUser, and ilObject\_lookupObjId().

Referenced by ilObjDlBookListGUI\initItem(), and ilLMPresentationGUI\resume().

Here is the call graph for this function:

Here is the caller graph for this function:

_isOffline()

static ilObjContentObjectAccess::_isOffline (   $a_obj_id )

static

Type-specific implementation of general status.

Used in ListGUI and Learning Progress

Parameters

int

$a_obj_id

Returns

bool

Reimplemented from ilObjectAccess.

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

        {
                return !self::_lookupOnline($a_obj_id);
        }

References _lookupOnline().

Referenced by ilObjDlBookListGUI\getProperties(), and ilObjLearningModuleListGUI\getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupOnline()

ilObjContentObjectAccess::_lookupOnline

(

$a_id

)

check wether learning module is online

Parameters

int

$a_id

learning object id

Definition at line 121 of file class.ilObjContentObjectAccess.php.

        {
                global $ilDB;
 
                if (isset(self::$online[$a_id]))
                {
                        return self::$online[$a_id];
                }
 
                $q = "SELECT is_online FROM content_object WHERE id = ".$ilDB->quote($a_id, "integer");
                $lm_set = $ilDB->query($q);
                $lm_rec = $ilDB->fetchAssoc($lm_set);
 
                self::$online[$a_id] = ilUtil::yn2tf($lm_rec["is_online"]);
                return ilUtil::yn2tf($lm_rec["is_online"]);
        }

References $ilDB, $lm_set, and ilUtil\yn2tf().

Referenced by _checkAccess(), and _isOffline().

Here is the call graph for this function:

Here is the caller graph for this function:

_preloadData()

ilObjContentObjectAccess::_preloadData	(		$a_obj_ids,
			$a_ref_ids
	)

Preload data.

Parameters

array

$a_obj_ids

array of object ids

Reimplemented from ilObjectAccess.

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

        {
                global $ilDB, $ilUser;
                
                $q = "SELECT id, is_online FROM content_object WHERE ".
                        $ilDB->in("id", $a_obj_ids, false, "integer");
 
                $lm_set = $ilDB->query($q);
                while ($rec = $ilDB->fetchAssoc($lm_set))
                {
                        self::$online[$rec["id"]] = ilUtil::yn2tf($rec["is_online"]);
                }
                
                $q = "SELECT obj_id, lm_id FROM lo_access WHERE ".
                        "usr_id = ".$ilDB->quote($ilUser->getId(), "integer")." AND ".
                        $ilDB->in("lm_id", $a_ref_ids, false, "integer");;
                $set = $ilDB->query($q);
                foreach ($a_ref_ids as $r)
                {
                        self::$lo_access[$r] = 0;
                }
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        self::$lo_access[$rec["lm_id"]] = $rec["obj_id"];
                }
 
        }

References $ilDB, $ilUser, $lm_set, $r, and ilUtil\yn2tf().

Here is the call graph for this function:

Field Documentation

$lo_access

ilObjContentObjectAccess::$lo_access

static

Definition at line 20 of file class.ilObjContentObjectAccess.php.

$online

ilObjContentObjectAccess::$online

static

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

---

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

• Modules/LearningModule/classes/class.ilObjContentObjectAccess.php