ilMobStakeholder Class Reference

Inheritance diagram for ilMobStakeholder:

Collaboration diagram for ilMobStakeholder:

Public Member Functions
	getId ()
	getOwnerOfNewResources ()
	canBeAccessedByCurrentUser (ResourceIdentification $identification)
	resourceHasBeenDeleted (ResourceIdentification $identification)
	getLocationURIForResourceUsage (ResourceIdentification $identification)
Public Member Functions inherited from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder
	__construct (?int $user_id_of_owner=null)
	setOwner (int $user_id_of_owner)
	getFullyQualifiedClassName ()
	isResourceInUse (ResourceIdentification $identification)
	canBeAccessedByCurrentUser (ResourceIdentification $identification)
	resourceHasBeenDeleted (ResourceIdentification $identification)
	getOwnerOfResource (ResourceIdentification $identification)
	getConsumerNameForPresentation ()
	getLocationURIForResourceUsage (ResourceIdentification $identification)
Public Member Functions inherited from ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder
	__construct ()
	Constructor must not have any parameters. More...
	getId ()
	getConsumerNameForPresentation ()
	getFullyQualifiedClassName ()
	canBeAccessedByCurrentUser (ResourceIdentification $identification)
	isResourceInUse (ResourceIdentification $identification)
	resourceHasBeenDeleted (ResourceIdentification $identification)
	getOwnerOfResource (ResourceIdentification $identification)
	getOwnerOfNewResources ()
	getLocationURIForResourceUsage (ResourceIdentification $identification)

Protected Member Functions
	checkAccessMobUsage (array $usage, int $oid)
	checkAccessObject (int $obj_id, string $obj_type='')
	Check access rights for an object by its object id. More...
	checkAccessTestQuestion (int $obj_id, int $usage_id=0)
	Check access rights for a test question This checks also tests with random selection of questions. More...
	checkAccessGlossaryTerm (int $obj_id, int $page_id)
	Check access rights for glossary terms This checks also learning modules linking the term. More...
	checkAccessPortfolioPage (int $obj_id, int $page_id)
	Check access rights for portfolio pages. More...
	checkAccessBlogPage (int $obj_id)
	Check access rights for blog pages. More...
	checkAccessLearningObjectivePage (int $obj_id, int $page_id)

Protected Attributes
ilAccessHandler	$access
ilDBInterface	$database = null
Protected Attributes inherited from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder
int	$default_owner
int	$current_user

Private Member Functions
	resolveObjectId (ResourceIdentification $identification)
	initDB ()

Detailed Description

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

Member Function Documentation

canBeAccessedByCurrentUser()

ilMobStakeholder::canBeAccessedByCurrentUser

(

ResourceIdentification

$identification

)

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 37 of file class.ilMobStakeholder.php.

                                                                                      : bool
    {
        $mob_id = $this->resolveObjectId($identification);
        if ($mob_id === null) {
            return true;
        }
 
        foreach (\ilObjMediaObject::lookupUsages($mob_id) as $usage) {
            $oid = ilObjMediaObject::getParentObjectIdForUsage($usage, true);
            // for content snippets we must get their usages and check them
            switch ($usage["type"]) {
                case "auth:pg":
                    // Mobs on the Loginpage should always be delivered
                    return true;
                case "mep:pg":
                    $usages2 = ilMediaPoolPage::lookupUsages($usage["id"]);
                    foreach ($usages2 as $usage2) {
                        $oid2 = ilObjMediaObject::getParentObjectIdForUsage($usage2, true);
                        if ($this->checkAccessMobUsage($usage2, $oid2)) {
                            return true;
                        }
                    }
                    break;
 
                case "clip":
                    if ($usage["id"] == $this->current_user) {
                        return true;
                    }
                    break;
 
                default:
                    if ($oid !== null && $this->checkAccessMobUsage($usage, $oid)) {
                        return true;
                    }
 
                    if ($oid === null) {
                        /*
                        $this->logger->error(
                            sprintf(
                                "Could not determine parent obj_id for usage: %s",
                                json_encode($usage, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT)
                            )
                        );*/
                    }
                    break;
            }
        }
 
        return false;
    }

References checkAccessMobUsage(), ilObjMediaObject\getParentObjectIdForUsage(), ilMediaPoolPage\lookupUsages(), ilObjMediaObject\lookupUsages(), and resolveObjectId().

Here is the call graph for this function:

checkAccessBlogPage()

ilMobStakeholder::checkAccessBlogPage ( int  $obj_id )

protected

Check access rights for blog pages.

Parameters

int

$obj_id

blog page id

Definition at line 326 of file class.ilMobStakeholder.php.

     : bool {
        $tree = new ilWorkspaceTree(0);
        $node_id = $tree->lookupNodeId($obj_id);
        if (!$node_id) {
            return $this->checkAccessObject($obj_id);
        } else {
            $access_handler = new ilWorkspaceAccessHandler($tree);
            if ($access_handler->checkAccessOfUser($tree, $this->current_user, "read", "view", $node_id, "blog")) {
                return true;
            }
        }
 
        return false;
    }

Referenced by checkAccessMobUsage().

Here is the caller graph for this function:

checkAccessGlossaryTerm()

ilMobStakeholder::checkAccessGlossaryTerm ( int  $obj_id, int  $page_id  )

protected

Check access rights for glossary terms This checks also learning modules linking the term.

Parameters

int	$obj_id	object id (glossary)
int	$page_id	page id (definition)

Returns

bool access given (true/false)

Definition at line 260 of file class.ilMobStakeholder.php.

     : bool {
        // give access if glossary is readable
        if ($this->checkAccessObject($obj_id)) {
            return true;
        }
 
        $term_id = $page_id;
 
        $sources = ilInternalLink::_getSourcesOfTarget('git', $term_id, 0);
 
        if ($sources) {
            foreach ($sources as $src) {
                switch ($src['type']) {
                    // Give access if term is linked by a learning module with read access.
                    // The term including media is shown by the learning module presentation!
                    case 'lm:pg':
                        $src_obj_id = ilLMObject::_lookupContObjID($src['id']);
                        if ($this->checkAccessObject($src_obj_id, 'lm')) {
                            return true;
                        }
                        break;
 
                        // Don't yet give access if the term is linked by another glossary
                        // The link will lead to the origin glossary which is already checked
                        /*
                        case 'gdf:pg':
                            $src_term_id = ilGlossaryDefinition::_lookupTermId($src['id']);
                            $src_obj_id = ilGlossaryTerm::_lookGlossaryID($src_term_id);
                            if ($this->checkAccessObject($src_obj_id, 'glo'))
                            {
                                return true;
                            }
                            break;
                        */
                }
            }
        }
        return false;
    }

Referenced by checkAccessMobUsage().

Here is the caller graph for this function:

checkAccessLearningObjectivePage()

ilMobStakeholder::checkAccessLearningObjectivePage ( int  $obj_id, int  $page_id  )

protected

Definition at line 344 of file class.ilMobStakeholder.php.

     : bool {
        $crs_obj_id = ilCourseObjective::_lookupContainerIdByObjectiveId($page_id);
 
        return $this->checkAccessObject($crs_obj_id, 'crs');
    }

Referenced by checkAccessMobUsage().

Here is the caller graph for this function:

checkAccessMobUsage()

ilMobStakeholder::checkAccessMobUsage ( array  $usage, int  $oid  )

protected

Definition at line 88 of file class.ilMobStakeholder.php.

     : bool {
        $user_id = $this->current_user;
 
        switch ($usage['type']) {
            case 'lm:pg':
                if ($this->checkAccessObject($oid, 'lm')) {
                    return true;
                }
                break;
 
            case 'news':
                // media objects in news (media casts)
                if ($this->checkAccessObject($oid)) {
                    return true;
                } elseif (ilObjMediaCastAccess::_lookupPublicFiles($oid) && ilNewsItem::_lookupVisibility($usage["id"]) == NEWS_PUBLIC) {
                    return true;
                }
                break;
 
            case 'frm~:html':
            case 'exca~:html':
                // $oid = userid
                //                              foreach ($this->check_users as $user_id) {
                if (ilObject::_lookupType($oid) === 'usr' && $oid == $user_id) {
                    return true;
                }
                //                              }
                break;
 
            case 'frm~d:html':
                $draft_id = $usage['id'];
 
                $oDraft = ilForumPostDraft::newInstanceByDraftId($draft_id);
                if ($user_id == $oDraft->getPostAuthorId()) {
                    return true;
                }
                break;
            case 'frm~h:html':
                $history_id = $usage['id'];
                $oHistoryDraft = new ilForumDraftsHistory($history_id);
                $oDraft = ilForumPostDraft::newInstanceByDraftId($oHistoryDraft->getDraftId());
                if ($user_id == $oDraft->getPostAuthorId()) {
                    return true;
                }
                break;
            case 'qpl:pg':
            case 'qpl:html':
                // test questions
                if ($this->checkAccessTestQuestion($oid, $usage['id'])) {
                    return true;
                }
                break;
 
            case 'term:pg':
                // special check for glossary terms
                if ($this->checkAccessGlossaryTerm($oid, $usage['id'])) {
                    return true;
                }
                break;
 
            case 'sahs:pg':
                // check for scorm pages
                if ($this->checkAccessObject($oid, 'sahs')) {
                    return true;
                }
                break;
 
            case 'prtf:pg':
                // special check for portfolio pages
                if ($this->checkAccessPortfolioPage($oid, $usage['id'])) {
                    return true;
                }
                break;
 
            case 'blp:pg':
                // special check for blog pages
                if ($this->checkAccessBlogPage($oid)) {
                    return true;
                }
                break;
 
            case 'lobj:pg':
                // special check for learning objective pages
                if ($this->checkAccessLearningObjectivePage($oid, $usage['id'])) {
                    return true;
                }
                break;
 
            case 'impr:pg':
                return (ilImprint::isActive() || $this->checkAccessObject(SYSTEM_FOLDER_ID, 'adm'));
 
            case 'cstr:pg':
            default:
                // standard object check
                if ($this->checkAccessObject($oid)) {
                    return true;
                }
                break;
        }
 
        return false;
    }

References $user_id, ilObjMediaCastAccess\_lookupPublicFiles(), ilObject\_lookupType(), ilNewsItem\_lookupVisibility(), checkAccessBlogPage(), checkAccessGlossaryTerm(), checkAccessLearningObjectivePage(), checkAccessObject(), checkAccessPortfolioPage(), checkAccessTestQuestion(), ilImprint\isActive(), ilForumPostDraft\newInstanceByDraftId(), NEWS_PUBLIC, and SYSTEM_FOLDER_ID.

Referenced by canBeAccessedByCurrentUser().

Here is the call graph for this function:

Here is the caller graph for this function:

checkAccessObject()

ilMobStakeholder::checkAccessObject ( int  $obj_id, string  $obj_type = ''  )

protected

Check access rights for an object by its object id.

Definition at line 197 of file class.ilMobStakeholder.php.

     : bool {
        global $DIC;
 
        $ilAccess = $DIC->access();
        $user_id = $this->current_user;
 
        if (!$obj_type) {
            $obj_type = ilObject::_lookupType($obj_id);
        }
        $ref_ids = ilObject::_getAllReferences($obj_id);
 
        foreach ($ref_ids as $ref_id) {
            //                  foreach ($this->check_users as $user_id) {
            if ($ilAccess->checkAccessOfUser($user_id, "read", "view", $ref_id, $obj_type, $obj_id)) {
                return true;
            }
            //                  }
        }
 
        return false;
    }

References ilObject\_lookupType().

Referenced by checkAccessMobUsage().

Here is the call graph for this function:

Here is the caller graph for this function:

checkAccessPortfolioPage()

ilMobStakeholder::checkAccessPortfolioPage ( int  $obj_id, int  $page_id  )

protected

Check access rights for portfolio pages.

Parameters

int	$obj_id	object id (glossary)
int	$page_id	page id (definition)

Definition at line 309 of file class.ilMobStakeholder.php.

     : bool {
        $access_handler = new ilPortfolioAccessHandler();
        if ($access_handler->checkAccessOfUser($this->current_user, "read", "view", $obj_id, "prtf")) {
            return true;
        }
 
        return false;
    }

Referenced by checkAccessMobUsage().

Here is the caller graph for this function:

checkAccessTestQuestion()

ilMobStakeholder::checkAccessTestQuestion ( int  $obj_id, int  $usage_id = 0  )

protected

Check access rights for a test question This checks also tests with random selection of questions.

Parameters

int

$obj_id

object id (question pool or test)

Definition at line 228 of file class.ilMobStakeholder.php.

     : bool {
        // give access if direct usage is readable
        if ($this->checkAccessObject($obj_id)) {
            return true;
        }
 
        $obj_type = ilObject::_lookupType($obj_id);
        if ($obj_type == 'qpl') {
            // give access if question pool is used by readable test
            // for random selection of questions
            $tests = ilObjTestAccess::_getRandomTestsForQuestionPool($obj_id);
            foreach ($tests as $test_id) {
                if ($this->checkAccessObject($test_id, 'tst')) {
                    return true;
                }
            }
        }
 
        return false;
    }

Referenced by checkAccessMobUsage().

Here is the caller graph for this function:

getId()

ilMobStakeholder::getId

(

)

Returns

string not longer than 64 characters

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

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

                           : string
    {
        return 'mob';
    }

getLocationURIForResourceUsage()

ilMobStakeholder::getLocationURIForResourceUsage

(

ResourceIdentification

$identification

)

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 360 of file class.ilMobStakeholder.php.

                                                                                          : ?string
    {
        $this->initDB();
        $object_id = $this->resolveObjectId($identification);
        if ($object_id !== null) {
            $references = ilObject::_getAllReferences($object_id);
            $ref_id = array_shift($references);
 
            return ilLink::_getLink($ref_id);
        }
        return null;
    }

References $ref_id, and ilObject\_getAllReferences().

Here is the call graph for this function:

getOwnerOfNewResources()

ilMobStakeholder::getOwnerOfNewResources

(

)

Implements ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder.

Definition at line 32 of file class.ilMobStakeholder.php.

                                            : int
    {
        return $this->default_owner;
    }

References ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder\$default_owner.

initDB()

ilMobStakeholder::initDB ( )

private

Definition at line 386 of file class.ilMobStakeholder.php.

                             : void
    {
        global $DIC;
        if ($this->database === null) {
            $this->database = $DIC->database();
        }
    }

References $DIC, and ILIAS\Repository\database().

Here is the call graph for this function:

resolveObjectId()

ilMobStakeholder::resolveObjectId ( ResourceIdentification  $identification )

private

Definition at line 373 of file class.ilMobStakeholder.php.

                                                                            : ?int
    {
        $this->initDB();
        $r = $this->database->queryF(
            "SELECT id FROM mob_data WHERE rid = %s;",
            ['text'],
            [$identification->serialize()]
        );
        $d = $this->database->fetchObject($r);
 
        return (isset($d->id) ? (int) $d->id : null);
    }

References Vendor\Package\$d, ILIAS\Repository\database(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Referenced by canBeAccessedByCurrentUser().

Here is the call graph for this function:

Here is the caller graph for this function:

resourceHasBeenDeleted()

ilMobStakeholder::resourceHasBeenDeleted

(

ResourceIdentification

$identification

)

Returns

bool true: if the Stakeholder could handle the deletion; false: if the Stakeholder could not handle the deletion of the resource.

Reimplemented from ILIAS\ResourceStorage\Stakeholder\AbstractResourceStakeholder.

Definition at line 353 of file class.ilMobStakeholder.php.

                                                                                  : bool
    {
        // at this place we could handle de deletion of a resource. not needed for instruction files IMO.
 
        return true;
    }

Field Documentation

$access

ilAccessHandler ilMobStakeholder::$access

protected

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

$database

ilDBInterface ilMobStakeholder::$database = null

protected

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

---

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

• components/ILIAS/MediaObjects/IRSS/class.ilMobStakeholder.php