ilObjMediaCastAccess Class Reference

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

Inheritance diagram for ilObjMediaCastAccess:

Collaboration diagram for ilObjMediaCastAccess:

Public Member Functions
	__construct ()
	_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 ()
static	_checkGoto (string $target)
static	_lookupOnline (int $a_id)
static	_lookupPublicFiles (int $a_id)
static	_lookupDiskUsage (int $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 (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...

Protected Attributes
ilObjUser	$user
ilLanguage	$lng
ilRbacSystem	$rbacsystem
ilAccessHandler	$access

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

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilObjMediaCastAccess::__construct

(

)

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\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	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = null
	)

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

References $access, $lng, $rbacsystem, $user, $user_id, _lookupOnline(), ilRbacSystem\checkAccessOfUser(), ilAccessInfo\IL_NO_OBJECT_ACCESS, ilAccessInfo\IL_STATUS_MESSAGE, and ilLanguage\txt().

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

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

        switch ($cmd) {
            case "listItems":

                if (!ilObjMediaCastAccess::_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 (!ilObjMediaCastAccess::_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 (self::_isOffline($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 ilObjMediaCastAccess::_checkGoto ( string  $target )

static

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

References $DIC.

                                                     : bool
    {
        global $DIC;

        $ilAccess = $DIC->access();

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

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

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

_getCommands()

static ilObjMediaCastAccess::_getCommands ( )

static

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

Referenced by ilObjMediaCastListGUI\init().

                                         : array
    {
        $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 ( int  $a_id )

static

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

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

References ilObjMediaObject\_getDirectory(), and ilFileUtils\dirsize().

                                                      : int
    {
        $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 += ilFileUtils::dirsize(ilObjMediaObject::_getDirectory($mobId));
        }
        return $size;
    }

Here is the call graph for this function:

_lookupOnline()

static ilObjMediaCastAccess::_lookupOnline ( int  $a_id )

static

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

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

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), _checkAccess(), and ILIAS\Style\Content\Filter\FilterManager\legacyOnlineFilter().

                                                   : bool
    {
        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 (bool) ($mc_rec["is_online"] ?? false);
    }

Here is the caller graph for this function:

_lookupPublicFiles()

static ilObjMediaCastAccess::_lookupPublicFiles ( int  $a_id )

static

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

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

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

                                                        : bool
    {
        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 (bool) $mc_rec["public_files"];
    }

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilObjMediaCastAccess::$access

protected

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

Referenced by _checkAccess().

$lng

ilLanguage ilObjMediaCastAccess::$lng

protected

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

Referenced by _checkAccess().

$rbacsystem

ilRbacSystem ilObjMediaCastAccess::$rbacsystem

protected

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

Referenced by _checkAccess().

$user

ilObjUser ilObjMediaCastAccess::$user

protected

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

Referenced by _checkAccess().

---

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

• components/ILIAS/MediaCast/classes/class.ilObjMediaCastAccess.php