Inheritance diagram for ILIAS\Blog\Permission\BlogCmdPermission:

Collaboration diagram for ILIAS\Blog\Permission\BlogCmdPermission:

Public Member Functions
	__construct (protected \ilLanguage $lng, protected PermissionManager $perm_manager, ?\ilGlobalTemplateInterface $tpl=null, protected ?\ilCtrlInterface $ctrl=null, protected ?StandardGUIRequest $request=null, protected ?BlogExercise $blog_exercise=null)

	postingsBelongToBlog (array $posting_ids)

	assignmentBelongsToBlog (int $assignment_id)

	isCommandPermitted (string $cmd, int $node_id, string $entity, string $entity_id="")

	getDefaultCommand ()

	getRequestEntity ()

	getRequestNodeId ()

	isForwardPermitted (string $from_class, string $to_class)

Public Member Functions inherited from ILIAS\Repository\Permission\CmdPermission
	__construct (protected \ilLanguage $lng, protected ?\ilGlobalTemplateInterface $tpl=null, protected ?\ilCtrlInterface $ctrl=null,)

	isRequestCommandPermitted ()

	isRequestMultiCommand ()

	isTableCommandPermitted (string $cmd, string $entity_id)

	isCommandPermittedMulti (string $cmd, int $node_id, string $entity, array $entity_ids)

	getPermittedCommand ()

	getRequestCommand ()

	getDefaultCommand ()

	checkCommand (string $cmd, int $node_id, string $entity, string $entity_id="")

	forwardPermitted (object $from_gui, object $to_gui)

	classImplementsMethodDirectly (string $className, string $method)
	For intermediate solutions that don't implement the concept for all subclasses yet. More...

	isRequestCommandPermitted ()

	getPermittedCommand ()

	getRequestCommand ()

	getRequestEntity ()

	getRequestNodeId ()

	isCommandPermitted (string $cmd, int $node_id, string $entity, string $entity_id="")

	isCommandPermittedMulti (string $cmd, int $node_id, string $entity, array $entity_ids)

	isRequestMultiCommand ()

	checkCommand (string $cmd, int $node_id, string $entity, string $entity_id="")

	isForwardPermitted (string $from_class, string $to_class)

	forwardPermitted (object $from_gui, object $to_gui)

Protected Member Functions
	hasBlogCmdPerm (string $cmd, int $node_id)

	hasPostingCmdPerm (string $cmd, int $node_id, int $posting_id)

	hasBlogAssignmentCmdPerm (string $cmd, int $node_id, int $assignment_id)

Protected Member Functions inherited from ILIAS\Repository\Permission\CmdPermission
	isClass (string $class)

	cmdEntity (string $type, string\|array $id="")

Protected Attributes
const	BLOG = "blog"

const	POSTING = "posting"

const	BLOG_ASSIGNMENT = "blog_assignment"

ilAccessHandler ilWorkspaceAccessHandler	$access

Detailed Description

Definition at line 34 of file BlogCmdPermission.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Blog\Permission\BlogCmdPermission::__construct	(	protected \ilLanguage	$lng,
		protected PermissionManager	$perm_manager,
		?\ilGlobalTemplateInterface	$tpl = `null`,
		protected ?\ilCtrlInterface	$ctrl = `null`,
		protected ?StandardGUIRequest	$request = `null`,
		protected ?BlogExercise	$blog_exercise = `null`
	)

Definition at line 41 of file BlogCmdPermission.php.

      {
        parent::__construct($lng, $tpl, $ctrl);
        $this->access = $perm_manager->getAccessHandler();
    }

References $lng, ILIAS\News\Common\Table\$tpl, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), and ILIAS\Blog\Permission\PermissionManager\getAccessHandler().

Here is the call graph for this function:

Member Function Documentation

◆ assignmentBelongsToBlog()

ILIAS\Blog\Permission\BlogCmdPermission::assignmentBelongsToBlog ( int $assignment_id )

Definition at line 63 of file BlogCmdPermission.php.

                                                               : bool
    {
        if ($this->blog_exercise === null) {
            return false;
        }
 
        foreach ($this->blog_exercise->getAssignmentsOfBlog() as $assignment) {
            if ($assignment["ass_id"] === $assignment_id) {
                return true;
            }
        }
        return false;
    }

◆ getDefaultCommand()

ILIAS\Blog\Permission\BlogCmdPermission::getDefaultCommand ( )

Reimplemented from ILIAS\Repository\Permission\CmdPermission.

Definition at line 166 of file BlogCmdPermission.php.

                                       : string
    {
        if ($this->isClass(\ilObjBlogGUI::class)) {
            return "render";
        }
        return "";
    }

◆ getRequestEntity()

ILIAS\Blog\Permission\BlogCmdPermission::getRequestEntity ( )

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 174 of file BlogCmdPermission.php.

                                      : ?CmdEntity
    {
        if ($this->isClass(\ilObjBlogGUI::class) || $this->isClass(EditingGUI::class)) {
 
            if (in_array($this->ctrl->getCmd(), ["approve", "deactivateAdmin"])) {
                $posting_id = $this->request->getApId();
                return $this->cmdEntity(
                    self::POSTING,
                    (string) $posting_id
                );
            }
            if (in_array($this->ctrl->getCmd(), ["printViewSelection", "printPostings"])) {
                $posting_ids = $this->request->getObjIds();
                if ($posting_ids !== []) {
                    return $this->cmdEntity(self::POSTING, $posting_ids);
                }
            }
            return $this->cmdEntity(
                self::BLOG
            );
        }
        if ($this->isClass(\ilBlogExerciseGUI::class)) {
            return $this->cmdEntity(
                self::BLOG_ASSIGNMENT,
                (string) $this->request->getAssId()
            );
        }
        return null;
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getRequestNodeId()

ILIAS\Blog\Permission\BlogCmdPermission::getRequestNodeId ( )

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 204 of file BlogCmdPermission.php.

                                      : int
    {
        if ($this->access instanceof \ilWorkspaceAccessHandler) {
            return $this->request->getWspId();
        }
        return $this->request->getRefId();
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

◆ hasBlogAssignmentCmdPerm()

ILIAS\Blog\Permission\BlogCmdPermission::hasBlogAssignmentCmdPerm	(	string	$cmd,
		int	$node_id,
		int	$assignment_id
	)

protected

Definition at line 156 of file BlogCmdPermission.php.

                                                                                              : bool
    {
        if (in_array($cmd, ["downloadExcAssFile", "downloadExcSubFile", "finalize"])) {
            return $this->access->checkAccess("read", "", $node_id) &&
                $this->assignmentBelongsToBlog($assignment_id);
        }
 
        return false;
    }

References ILIAS\Repository\access().

Referenced by ILIAS\Blog\Permission\BlogCmdPermission\isCommandPermitted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasBlogCmdPerm()

ILIAS\Blog\Permission\BlogCmdPermission::hasBlogCmdPerm	(	string	$cmd,
		int	$node_id
	)

protected

Definition at line 94 of file BlogCmdPermission.php.

                                                                : bool
    {
        // write permission
        if (in_array($cmd, [
            "edit",
            "createExportFileWithComments",
            "createExportFile",
            "export",
            "contributors",
            "addUserFromAutoComplete",
            "addContributor",
            "confirmRemoveContributor",
            "removeContributor",
            "setContentStyleSheet",
            "exportWithComments"
        ])) {
            return $this->access->checkAccess("write", "", $node_id);
        }
 
        if (in_array($cmd, [
            "createPosting",
        ])) {
            return $this->perm_manager->mayContribute();
        }
 
        // read permission
        if (in_array($cmd, [
            "render", "preview", "addToDesk", "removeFromDesk", "renderFullscreen",
            "setNotification", "printViewSelection", "printPostings"
        ])) {
            return $this->access->checkAccess("read", "", $node_id);
        }
 
        // visible permission
        if (in_array($cmd, [
            "infoScreen"
        ])) {
            return $this->access->checkAccess("visible", "", $node_id);
        }
 
 
        return false;
    }

References ILIAS\Repository\access().

Referenced by ILIAS\Blog\Permission\BlogCmdPermission\isCommandPermitted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPostingCmdPerm()

ILIAS\Blog\Permission\BlogCmdPermission::hasPostingCmdPerm	(	string	$cmd,
		int	$node_id,
		int	$posting_id
	)

protected

Definition at line 138 of file BlogCmdPermission.php.

                                                                                    : bool
    {
        if (in_array($cmd, ["printViewSelection", "printPostings"])) {
            return $this->access->checkAccess("read", "", $node_id) &&
                $this->perm_manager->postingIdMatches($posting_id);
        }
 
        // redact or write permission
        if (in_array($cmd, [
            "approve",
            "deactivateAdmin"
        ])) {
            return $this->perm_manager->canApprove($posting_id);
        }
 
        return false;
    }

References ILIAS\Repository\access().

Referenced by ILIAS\Blog\Permission\BlogCmdPermission\isCommandPermitted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCommandPermitted()

ILIAS\Blog\Permission\BlogCmdPermission::isCommandPermitted	(	string	$cmd,
		int	$node_id,
		string	$entity,
		string	$entity_id = `""`
	)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 77 of file BlogCmdPermission.php.

     : bool {
        switch ($entity) {
            case self::BLOG:
                return $this->hasBlogCmdPerm($cmd, $node_id);
            case self::POSTING:
                return $this->hasPostingCmdPerm($cmd, $node_id, (int) $entity_id);
            case self::BLOG_ASSIGNMENT:
                return $this->hasBlogAssignmentCmdPerm($cmd, $node_id, (int) $entity_id);
        }
        return false;
    }

References ILIAS\Blog\Permission\BlogCmdPermission\BLOG, ILIAS\Blog\Permission\BlogCmdPermission\BLOG_ASSIGNMENT, ILIAS\Blog\Permission\BlogCmdPermission\hasBlogAssignmentCmdPerm(), ILIAS\Blog\Permission\BlogCmdPermission\hasBlogCmdPerm(), ILIAS\Blog\Permission\BlogCmdPermission\hasPostingCmdPerm(), and ILIAS\Blog\Permission\BlogCmdPermission\POSTING.

Here is the call graph for this function:

◆ isForwardPermitted()

ILIAS\Blog\Permission\BlogCmdPermission::isForwardPermitted	(	string	$from_class,
		string	$to_class
	)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 212 of file BlogCmdPermission.php.

     : bool {
        $node_id = $this->getRequestNodeId();
        $posting_id = $this->request->getBlogPage();
        if ($from_class === \ilObjBlogGUI::class) {
 
            // visible or read
            if ($to_class === \ilCommonActionDispatcherGUI::class) {
                return $this->access->checkAccess("visible", "", $node_id) ||
                    $this->access->checkAccess("read", "", $node_id);
            }
 
            // edit permission
            if ($to_class === \ilPermissionGUI::class) {
                return $this->access->checkAccess("edit_permission", "", $node_id);
            }
 
            if ($to_class === EditingGUI::class && in_array($this->ctrl->getCmd(), [
                "approve",
                "deactivateAdmin",
                "printViewSelection",
                "printPostings"
            ])) {
                return $this->isRequestCommandPermitted();
            }
 
            // read posting permission
            if ($to_class === \ilBlogPostingGUI::class) {
                return $this->perm_manager->canReadPosting($posting_id);
            }
 
            // write permission
            if (in_array($to_class, [
                \ilExportGUI::class,
                \ilRepositorySearchGUI::class,
                \ilObjectContentStyleSettingsGUI::class,
                \ilObjNotificationSettingsGUI::class,
                \ilObjectMetaDataGUI::class,
                SettingsGUI::class,
                \ILIAS\Blog\Settings\BlockSettingsGUI::class,
                \ILIAS\Blog\Editing\EditingGUI::class,
                \ILIAS\Blog\Export\ExportGUI::class,
                ContributorGUI::class,
            ])) {
                return $this->access->checkAccess("write", "", $node_id);
            }
 
            // read permission
            // note on ilObjectCopyGUI: This class performs the copy permission checks and
            // can act on multiple source ids
            if (in_array($to_class, [
                \ilObjectCopyGUI::class,
                \ILIAS\Blog\Presentation\PresentationGUI::class
            ])) {
                return $this->access->checkAccess("read", "", $node_id);
            }
 
            if ($to_class === \ilBlogExerciseGUI::class) {
                $assignment_id = $this->request?->getAssId() ?? 0;
                return $assignment_id === 0
                    ? $this->access->checkAccess("read", "", $node_id)
                    : $this->isRequestCommandPermitted();
            }
 
            // visible
            if ($to_class === \ilInfoScreenGUI::class) {
                return $this->access->checkAccess("visible", "", $node_id);
            }
        }
        return false;
    }

References ILIAS\Repository\access(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ postingsBelongToBlog()

ILIAS\Blog\Permission\BlogCmdPermission::postingsBelongToBlog ( array $posting_ids )

Definition at line 53 of file BlogCmdPermission.php.

                                                            : bool
    {
        foreach ($posting_ids as $posting_id) {
            if (!$this->perm_manager->postingIdMatches($posting_id)) {
                return false;
            }
        }
        return true;
    }

Field Documentation

◆ $access

ilAccessHandler ilWorkspaceAccessHandler ILIAS\Blog\Permission\BlogCmdPermission::$access

protected

Definition at line 39 of file BlogCmdPermission.php.

◆ BLOG

const ILIAS\Blog\Permission\BlogCmdPermission::BLOG = "blog"

protected

Definition at line 36 of file BlogCmdPermission.php.

Referenced by ILIAS\Blog\Permission\BlogCmdPermission\isCommandPermitted().

◆ BLOG_ASSIGNMENT

const ILIAS\Blog\Permission\BlogCmdPermission::BLOG_ASSIGNMENT = "blog_assignment"

protected

Definition at line 38 of file BlogCmdPermission.php.

Referenced by ILIAS\Blog\Permission\BlogCmdPermission\isCommandPermitted().

◆ POSTING

const ILIAS\Blog\Permission\BlogCmdPermission::POSTING = "posting"

protected

Definition at line 37 of file BlogCmdPermission.php.

Referenced by ILIAS\Blog\Permission\BlogCmdPermission\isCommandPermitted().

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

components/ILIAS/Blog/Permission/BlogCmdPermission.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignmentBelongsToBlog()

◆ getDefaultCommand()

◆ getRequestEntity()

◆ getRequestNodeId()

◆ hasBlogAssignmentCmdPerm()

◆ hasBlogCmdPerm()

◆ hasPostingCmdPerm()

◆ isCommandPermitted()

◆ isForwardPermitted()

◆ postingsBelongToBlog()

Field Documentation

◆ $access

◆ BLOG

◆ BLOG_ASSIGNMENT

◆ POSTING