ilObjMediaCastAccess Class Reference

Class ilObjMediaCastAccess. More...

Inheritance diagram for ilObjMediaCastAccess:

Collaboration diagram for ilObjMediaCastAccess:

Public Member Functions
	__construct ()
	Constructor. More...
	_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...
	canBeDelivered (ilWACPath $ilWACPath)
	Parameters ilWACPath $ilWACPath Returns bool 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 media cast is online. More...
static	_lookupPublicFiles ($a_id)
	Check wether files should be public. More...
static	_lookupDiskUsage ($a_id)
	Returns the number of bytes used on the harddisk by the file object with the specified object id. More...
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 if object type does not support centralized offline handling. More...
static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Protected Attributes
	$user
	$lng
	$rbacsystem
	$access

Detailed Description

Class ilObjMediaCastAccess.

Author

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

Version

Id

class.ilObjMediaCastAccess.php 12772 2006-12-07 09:34:01Z akill

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

Constructor & Destructor Documentation

__construct()

ilObjMediaCastAccess::__construct

(

)

Constructor.

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

References $DIC, and user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->access = $DIC->access();
    }

Here is the call graph for this function:

Member Function Documentation

_checkAccess()

ilObjMediaCastAccess::_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 89 of file class.ilObjMediaCastAccess.php.

References $access, $ilUser, $lng, $rbacsystem, $user, _lookupOnline(), IL_NO_OBJECT_ACCESS, and IL_STATUS_MESSAGE.

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $rbacsystem = $this->rbacsystem;
        $ilAccess = $this->access;

        if ($a_user_id == "") {
            $a_user_id = $ilUser->getId();
        }

        switch ($a_cmd) {
            case "listItems":

                if (!ilObjMediaCastAccess::_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 (!ilObjMediaCastAccess::_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 (!ilObjMediaCastAccess::_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 ilObjMediaCastAccess::_checkGoto (   $a_target )

static

check whether goto script will succeed

Definition at line 137 of file class.ilObjMediaCastAccess.php.

References $DIC.

    {
        global $DIC;

        $ilAccess = $DIC->access();
        
        $t_arr = explode("_", $a_target);

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

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

_getCommands()

static ilObjMediaCastAccess::_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 65 of file class.ilObjMediaCastAccess.php.

Referenced by ilObjMediaCastListGUI\init().

    {
        $commands = array(
            array("permission" => "read", "cmd" => "showContent", "lang_var" => "show",
                "default" => true),
            array("permission" => "write", "cmd" => "listItems", "lang_var" => "edit_content"),
            array("permission" => "write", "cmd" => "editSettings", "lang_var" => "settings")
        );
        
        return $commands;
    }

Here is the caller graph for this function:

_lookupDiskUsage()

static ilObjMediaCastAccess::_lookupDiskUsage (   $a_id )

static

Returns the number of bytes used on the harddisk by the file object with the specified object id.

Parameters

int	object id of a file object.

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

References $size, ilObjMediaObject\_getDirectory(), and ilUtil\dirsize().

Referenced by ilObjMediaCast\getDiskUsage().

    {
        require_once('Modules/MediaCast/classes/class.ilObjMediaCast.php');
        require_once("./Services/News/classes/class.ilNewsItem.php");
        require_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
        $obj = new ilObjMediaCast($a_id, false);
        $obj->read();
        $items = $obj->getItemsArray();
        $size = 0;
        foreach ($items as $item) {
            $news_item = new ilNewsItem($item["id"]);
            $news_item->read();
            $mobId = $news_item->getMobId();
            $size += ilUtil::dirsize(ilObjMediaObject::_getDirectory($mobId));
        }
        return $size;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupOnline()

static ilObjMediaCastAccess::_lookupOnline (   $a_id )

static

Check wether media cast is online.

Parameters

int

$a_id

media cast id

Definition at line 160 of file class.ilObjMediaCastAccess.php.

References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), _checkAccess(), and ilObjMediaCastListGUI\getProperties().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT * FROM il_media_cast_data WHERE id = " . $ilDB->quote($a_id);
        $mc_set = $ilDB->query($q);
        $mc_rec = $mc_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);

        return $mc_rec["is_online"];
    }

Here is the caller graph for this function:

_lookupPublicFiles()

static ilObjMediaCastAccess::_lookupPublicFiles (   $a_id )

static

Check wether files should be public.

Parameters

int

$a_id

media cast id

Definition at line 178 of file class.ilObjMediaCastAccess.php.

References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilObjectFeedWriter\__construct(), and ilObjMediaObjectAccess\checkAccessMob().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT * FROM il_media_cast_data WHERE id = " . $ilDB->quote($a_id);
        $mc_set = $ilDB->query($q);
        $mc_rec = $mc_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);

        return $mc_rec["public_files"];
    }

Here is the caller graph for this function:

Field Documentation

$access

ilObjMediaCastAccess::$access

protected

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

Referenced by _checkAccess().

$lng

ilObjMediaCastAccess::$lng

protected

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

Referenced by _checkAccess().

$rbacsystem

ilObjMediaCastAccess::$rbacsystem

protected

Definition at line 31 of file class.ilObjMediaCastAccess.php.

Referenced by _checkAccess().

$user

ilObjMediaCastAccess::$user

protected

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

Referenced by _checkAccess().

---

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

• Modules/MediaCast/classes/class.ilObjMediaCastAccess.php