ILIAS\Repository\Permission\CmdPermission Class Reference

Inheritance diagram for ILIAS\Repository\Permission\CmdPermission:

Collaboration diagram for ILIAS\Repository\Permission\CmdPermission:

Public Member Functions
	__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...
Public Member Functions inherited from ILIAS\Repository\Permission\CmdPermissionInterface
	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
	isClass (string $class)
	cmdEntity (string $type, string|array $id="")

Detailed Description

Definition at line 23 of file CmdPermission.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Repository\Permission\CmdPermission::__construct	(	protected \ilLanguage	$lng,
		protected ?\ilGlobalTemplateInterface	$tpl = null,
		protected ?\ilCtrlInterface	$ctrl = null
	)

Definition at line 25 of file CmdPermission.php.

      {
    }

Member Function Documentation

checkCommand()

ILIAS\Repository\Permission\CmdPermission::checkCommand	(	string	$cmd,
		int	$node_id,
		string	$entity,
		string	$entity_id = ""
	)

Exceptions

ILIAS\Repository\Permission\ilNoCmdPermissionException

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 116 of file CmdPermission.php.

                                                                                                   : void
    {
        if (!$this->isCommandPermitted($cmd, $node_id, $entity, $entity_id)) {
            throw new \ILIAS\Repository\Permission\ilNoCmdPermissionException("No permission to execute command $cmd on $entity $entity_id");
        }
    }

classImplementsMethodDirectly()

ILIAS\Repository\Permission\CmdPermission::classImplementsMethodDirectly	(	string	$className,
		string	$method
	)

For intermediate solutions that don't implement the concept for all subclasses yet.

Definition at line 154 of file CmdPermission.php.

                                                                                    : bool
    {
        try {
            $class = new \ReflectionClass($className);
        } catch (\Exception $e) {
            return false;
        }
 
        return $class->hasMethod($method)
            && $class->getMethod($method)->getDeclaringClass()->getName() === $class->getName();
    }

References Vendor\Package\$e.

cmdEntity()

ILIAS\Repository\Permission\CmdPermission::cmdEntity ( string  $type, string|array  $id = ""  )

protected

Definition at line 123 of file CmdPermission.php.

     : CmdEntity {
        return new CmdEntity(
            $type,
            $id
        );
    }

forwardPermitted()

ILIAS\Repository\Permission\CmdPermission::forwardPermitted	(	object	$from_gui,
		object	$to_gui
	)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 133 of file CmdPermission.php.

     : mixed {
        if (is_null($this->ctrl)) {
            return null;
        }
        if ($this->isForwardPermitted(get_class($from_gui), get_class($to_gui))) {
            return $this->ctrl->forwardCommand($to_gui);
        }
        if ($this->access->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->setParameterByClass("ilRepositoryGUI", "ref_id", ROOT_FOLDER_ID);
            $this->ctrl->redirectByClass("ilRepositoryGUI");
        }
        throw new \ilPermissionException($this->lng->txt("permission_denied"));
    }

getDefaultCommand()

ILIAS\Repository\Permission\CmdPermission::getDefaultCommand

(

)

Reimplemented in ILIAS\Blog\Permission\BlogCmdPermission, and ILIAS\Category\Permission\CategoryCmdPermission.

Definition at line 107 of file CmdPermission.php.

                                       : string
    {
        return "";
    }

getPermittedCommand()

ILIAS\Repository\Permission\CmdPermission::getPermittedCommand

(

)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 85 of file CmdPermission.php.

                                         : string
    {
        if ($this->isRequestCommandPermitted()) {
            return $this->getRequestCommand();
        }
        return "";
    }

getRequestCommand()

ILIAS\Repository\Permission\CmdPermission::getRequestCommand

(

)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 93 of file CmdPermission.php.

                                       : string
    {
        return $this->ctrl->getCmd($this->getDefaultCommand());
    }

References ILIAS\Repository\ctrl().

Referenced by ILIAS\Repository\Permission\CmdPermission\isRequestCommandPermitted().

Here is the call graph for this function:

Here is the caller graph for this function:

isClass()

ILIAS\Repository\Permission\CmdPermission::isClass ( string  $class )

protected

Definition at line 98 of file CmdPermission.php.

                                             : bool
    {
        if (is_null($this->ctrl)) {
            return false;
        }
        $cmd_class = $this->ctrl->getCmdClass();
        return $cmd_class === strtolower($class);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

isCommandPermittedMulti()

ILIAS\Repository\Permission\CmdPermission::isCommandPermittedMulti	(	string	$cmd,
		int	$node_id,
		string	$entity,
		array	$entity_ids
	)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 72 of file CmdPermission.php.

     : bool {
        return array_all(
            $entity_ids,
            fn($entity_id) => $this->isCommandPermitted($cmd, $node_id, $entity, $entity_id)
        );
    }

Referenced by ILIAS\Repository\Permission\CmdPermission\isRequestCommandPermitted().

Here is the caller graph for this function:

isRequestCommandPermitted()

ILIAS\Repository\Permission\CmdPermission::isRequestCommandPermitted

(

)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 32 of file CmdPermission.php.

                                               : bool
    {
        if (is_null($this->ctrl)) {
            return false;
        }
        if (!$this->isRequestMultiCommand()) {
            return $this->isCommandPermitted(
                $this->getRequestCommand(),
                $this->getRequestNodeId(),
                (string) $this?->getRequestEntity()->getType(),
                (string) $this?->getRequestEntity()->getId()
            );
        } else {
            return $this->isCommandPermittedMulti(
                $this->getRequestCommand(),
                $this->getRequestNodeId(),
                (string) $this?->getRequestEntity()->getType(),
                (array) $this?->getRequestEntity()->getId()
            );
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Survey\Mode\getId(), ILIAS\Repository\Permission\CmdPermission\getRequestCommand(), ILIAS\Repository\Permission\CmdPermissionInterface\getRequestEntity(), ILIAS\Repository\Permission\CmdPermissionInterface\getRequestNodeId(), ILIAS\Repository\Permission\CmdPermissionInterface\isCommandPermitted(), ILIAS\Repository\Permission\CmdPermission\isCommandPermittedMulti(), and ILIAS\Repository\Permission\CmdPermission\isRequestMultiCommand().

Here is the call graph for this function:

isRequestMultiCommand()

ILIAS\Repository\Permission\CmdPermission::isRequestMultiCommand

(

)

Implements ILIAS\Repository\Permission\CmdPermissionInterface.

Definition at line 54 of file CmdPermission.php.

                                           : bool
    {
        return is_array($this?->getRequestEntity()->getId());
    }

References ILIAS\Survey\Mode\getId(), and ILIAS\Repository\Permission\CmdPermissionInterface\getRequestEntity().

Referenced by ILIAS\Repository\Permission\CmdPermission\isRequestCommandPermitted().

Here is the call graph for this function:

Here is the caller graph for this function:

isTableCommandPermitted()

ILIAS\Repository\Permission\CmdPermission::isTableCommandPermitted	(	string	$cmd,
		string	$entity_id
	)

Definition at line 59 of file CmdPermission.php.

                                                                           : bool
    {
        if (is_null($this->ctrl)) {
            return false;
        }
        return $this->isCommandPermitted(
            $cmd,
            $this->getRequestNodeId(),
            (string) $this?->getRequestEntity()->getType(),
            $entity_id
        );
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\Permission\CmdPermissionInterface\getRequestEntity(), ILIAS\Repository\Permission\CmdPermissionInterface\getRequestNodeId(), and ILIAS\Repository\Permission\CmdPermissionInterface\isCommandPermitted().

Here is the call graph for this function:

---

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

• components/ILIAS/Repository/Service/Permission/CmdPermission.php