ILIAS\File\Capabilities\Context Class Reference

Inheritance diagram for ILIAS\File\Capabilities\Context:

Collaboration diagram for ILIAS\File\Capabilities\Context:

Public Member Functions
	__construct (private int $object_id, private int $calling_id, private int $context)
	getObjectId ()
	getCallingId ()
	getContext ()
	getNode ()
	withCallingId (int $calling_id)
	withObjectId (int $object_id)
	__toString ()

Data Fields
const	CONTEXT_REPO = 1
const	CONTEXT_WORKSPACE = 2
const	CONTEXT_SEARCH = 6

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 26 of file Context.php.

Constructor & Destructor Documentation

__construct()

ILIAS\File\Capabilities\Context::__construct	(	private int	$object_id,
		private int	$calling_id,
		private int	$context
	)

Definition at line 32 of file Context.php.

      {
        // $context mut be one of the constants
        if ($context !== self::CONTEXT_REPO && $context !== self::CONTEXT_WORKSPACE && $context !== self::CONTEXT_SEARCH) {
            throw new \InvalidArgumentException('Invalid context');
        }
    }

Member Function Documentation

__toString()

ILIAS\File\Capabilities\Context::__toString

(

)

Definition at line 77 of file Context.php.

References ILIAS\File\Capabilities\Context\getCallingId().

                                : string
    {
        return (string) $this->getCallingId();
    }

Here is the call graph for this function:

getCallingId()

ILIAS\File\Capabilities\Context::getCallingId

(

)

Definition at line 48 of file Context.php.

Referenced by ILIAS\File\Capabilities\Context\__toString(), ILIAS\File\Capabilities\Context\getNode(), and ILIAS\File\Capabilities\Check\BaseCheck\hasPermission().

                                  : int
    {
        return $this->calling_id;
    }

Here is the caller graph for this function:

getContext()

ILIAS\File\Capabilities\Context::getContext

(

)

Definition at line 53 of file Context.php.

References $context.

Referenced by ILIAS\File\Capabilities\Check\BaseCheck\baseClass(), ILIAS\File\Capabilities\Context\getNode(), ILIAS\File\Capabilities\Check\BaseCheck\hasPermission(), ILIAS\File\Capabilities\Check\EditContent\maybeUnlock(), ILIAS\File\Capabilities\Check\ViewContent\maybeUnlock(), and ILIAS\File\Capabilities\Check\Unzip\maybeUnlock().

                                : int
    {
        return $this->context;
    }

Here is the caller graph for this function:

getNode()

ILIAS\File\Capabilities\Context::getNode

(

)

Definition at line 58 of file Context.php.

References ILIAS\File\Capabilities\Context\getCallingId(), and ILIAS\File\Capabilities\Context\getContext().

                             : string
    {
        return $this->getContext() . '_' . $this->getCallingId();
    }

Here is the call graph for this function:

getObjectId()

ILIAS\File\Capabilities\Context::getObjectId

(

)

Definition at line 43 of file Context.php.

                                 : int
    {
        return $this->object_id;
    }

withCallingId()

ILIAS\File\Capabilities\Context::withCallingId

(

int

$calling_id

)

Definition at line 63 of file Context.php.

                                                  : self
    {
        $clone = clone $this;
        $clone->calling_id = $calling_id;
        return $clone;
    }

withObjectId()

ILIAS\File\Capabilities\Context::withObjectId

(

int

$object_id

)

Definition at line 70 of file Context.php.

                                                : self
    {
        $clone = clone $this;
        $clone->object_id = $object_id;
        return $clone;
    }

Field Documentation

CONTEXT_REPO

const ILIAS\File\Capabilities\Context::CONTEXT_REPO = 1

Definition at line 28 of file Context.php.

Referenced by ILIAS\File\Capabilities\Check\EditContent\maybeUnlock(), and ILIAS\File\Capabilities\Check\ViewContent\maybeUnlock().

CONTEXT_SEARCH

const ILIAS\File\Capabilities\Context::CONTEXT_SEARCH = 6

Definition at line 30 of file Context.php.

Referenced by ILIAS\File\Capabilities\Check\Unzip\maybeUnlock().

CONTEXT_WORKSPACE

const ILIAS\File\Capabilities\Context::CONTEXT_WORKSPACE = 2

Definition at line 29 of file Context.php.

Referenced by ILIAS\File\Capabilities\Check\BaseCheck\baseClass(), ILIAS\File\Capabilities\Check\BaseCheck\hasPermission(), and ILIAS\File\Capabilities\Check\EditContent\maybeUnlock().

---

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

• components/ILIAS/File/classes/Capabilities/Context.php