ILIAS\LegalDocuments\Provide Class Reference

Inheritance diagram for ILIAS\LegalDocuments\Provide:

Collaboration diagram for ILIAS\LegalDocuments\Provide:

Public Member Functions
	__construct (private readonly string $id, private readonly Internal $internal, private readonly Container $container, private readonly string $document_key='document')
	withdrawal ()
	publicPage ()
	document ()
	history ()
	allowEditing ()
	publicApi ()
	id ()

Private Member Functions
	error (string $message)

Detailed Description

Definition at line 31 of file Provide.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\Provide::__construct	(	private readonly string	$id,
		private readonly Internal	$internal,
		private readonly Container	$container,
		private readonly string	$document_key = 'document'
	)

Definition at line 33 of file Provide.php.

      {
    }

Member Function Documentation

allowEditing()

ILIAS\LegalDocuments\Provide::allowEditing

(

)

Definition at line 67 of file Provide.php.

References $container, and $id.

Referenced by ILIAS\LegalDocuments\Config\legalDocuments().

                                  : self
    {
        return new self($this->id, $this->internal, $this->container, 'writable-document');
    }

Here is the caller graph for this function:

document()

ILIAS\LegalDocuments\Provide::document

(

)

Definition at line 57 of file Provide.php.

References ILIAS\LegalDocuments\Provide\error().

Referenced by ILIAS\DataProtection\Consumer\showMatchingDocument(), and ILIAS\LegalDocuments\Provide\ProvideHistory\table().

                              : ProvideDocument
    {
        return $this->internal->get($this->document_key, $this->id) ?? $this->error('No documents defined for: ' . $this->id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

error()

ILIAS\LegalDocuments\Provide::error ( string  $message )

private

Definition at line 82 of file Provide.php.

Referenced by ILIAS\LegalDocuments\Provide\document(), and ILIAS\LegalDocuments\Provide\history().

                                           : void
    {
        throw new Exception($message);
    }

Here is the caller graph for this function:

history()

ILIAS\LegalDocuments\Provide::history

(

)

Definition at line 62 of file Provide.php.

References ILIAS\LegalDocuments\Provide\error().

                             : ProvideHistory
    {
        return $this->internal->get('history', $this->id) ?? $this->error('No history defined for: ' . $this->id);
    }

Here is the call graph for this function:

id()

ILIAS\LegalDocuments\Provide::id

(

)

Definition at line 77 of file Provide.php.

References $id.

                        : string
    {
        return $this->id;
    }

publicApi()

ILIAS\LegalDocuments\Provide::publicApi

(

)

Definition at line 72 of file Provide.php.

                               : ?PublicApi
    {
        return $this->internal->get('public-api', $this->id);
    }

publicPage()

ILIAS\LegalDocuments\Provide::publicPage

(

)

Definition at line 49 of file Provide.php.

References null.

                                : ProvidePublicPage
    {
        if (null === $this->internal->get('public-page', $this->id)) {
            throw new Exception('No agreement defined for: ' . $this->id);
        }
        return new ProvidePublicPage($this->id, $this->container->ctrl());
    }

withdrawal()

ILIAS\LegalDocuments\Provide::withdrawal

(

)

Definition at line 41 of file Provide.php.

References null.

                                : ProvideWithdrawal
    {
        if (null === $this->internal->get('withdraw', $this->id)) {
            throw new Exception('No withdrawal process defined for: ' . $this->id);
        }
        return new ProvideWithdrawal($this->id, $this->container->ctrl(), $this->container['ilAuthSession']);
    }

---

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

• components/ILIAS/LegalDocuments/classes/Provide.php