ilSecureTokenSrcBuilder Class Reference

Inheritance diagram for ilSecureTokenSrcBuilder:

Collaboration diagram for ilSecureTokenSrcBuilder:

Public Member Functions
	__construct (private FileDeliveryServices $file_delivery)
	getRevisionURL (Revision $revision, bool $signed=true, float $valid_for_at_least_minutes=60.0, ?string $filename=null)
	getRevisionURLWithoutIsolation (Revision $revision, float $valid_for_at_least_minutes=60.0, ?string $filename=null)
	getFlavourURLs (Flavour $flavour, bool $signed=true)
	getRevisionURL (Revision $revision, bool $signed=true, float $valid_for_at_least_minutes=60.0, ?string $filename=null)
	getRevisionURLWithoutIsolation (Revision $revision, float $valid_for_at_least_minutes=60.0, ?string $filename=null)
	Signed URL delivered from the ILIAS domain instead of the content domain of User Content Isolation. More...
	getFlavourURLs (Flavour $flavour, bool $signed=true)

Private Attributes
InlineSrcBuilder	$inline

Detailed Description

Author

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

Definition at line 30 of file class.ilSecureTokenSrcBuilder.php.

Constructor & Destructor Documentation

__construct()

ilSecureTokenSrcBuilder::__construct

(

private FileDeliveryServices

$file_delivery

)

Definition at line 34 of file class.ilSecureTokenSrcBuilder.php.

      {
        $this->inline = new InlineSrcBuilder($file_delivery);
    }

Member Function Documentation

getFlavourURLs()

ilSecureTokenSrcBuilder::getFlavourURLs	(	Flavour	$flavour,
		bool	$signed = true
	)

Exceptions

RuntimeException if signing is not possible or failed, but was requested with $signed = true

Implements ILIAS\ResourceStorage\Consumer\SrcBuilder.

Definition at line 75 of file class.ilSecureTokenSrcBuilder.php.

                                                                         : \Generator
    {
        try {
            global $DIC;
 
            $filename = $DIC
                ->resourceStorage()
                ->manage()
                ->getResource($flavour->getResourceId())
                ->getSpecificRevision($flavour->getRevision())
                ?->getInformation()
                ->getTitle() ?? '';
 
            $frindly_name = preg_replace(
                '/[^a-zA-Z0-9-_]/',
                '',
                strtolower($flavour->getDefinition()->getInternalName())
            );
        } catch (Throwable) {
            $filename = '';
            $frindly_name = 'fl';
        }
 
 
        foreach ($flavour->getStreamResolvers() as $i => $stream_resolver) {
            $stream = $stream_resolver->getStream();
            if ($stream_resolver->isInMemory() || $stream->getMetadata()['uri'] === 'php://memory') {
                // must deliver as data uri
                yield $this->inline->buildDataURLFromStream($stream);
            } else {
 
                yield (string) $this->file_delivery->buildTokenURL(
                    $stream,
                    $frindly_name . '_' . $i . '_' . $filename,
                    Disposition::INLINE,
                    $GLOBALS['ilUser']->getId() ?? 0,
                    1
                );
            }
        }
    }

References $DIC, $filename, $GLOBALS, ILIAS\ResourceStorage\Flavour\Flavour\getDefinition(), ILIAS\Survey\Mode\getId(), ILIAS\ResourceStorage\Flavour\Flavour\getResourceId(), ILIAS\ResourceStorage\Flavour\Flavour\getRevision(), and ILIAS\ResourceStorage\Flavour\Flavour\getStreamResolvers().

Here is the call graph for this function:

getRevisionURL()

ilSecureTokenSrcBuilder::getRevisionURL	(	Revision	$revision,
		bool	$signed = true,
		float	$valid_for_at_least_minutes = 60.0,
		?string	$filename = null
	)

Parameters

string | null

$filename

Exceptions

RuntimeException if signing is not possible or failed, but was requested with $signed = true

Implements ILIAS\ResourceStorage\Consumer\SrcBuilder.

Definition at line 40 of file class.ilSecureTokenSrcBuilder.php.

     : string {
        // get stream from revision
        $stream = $revision->maybeStreamResolver()?->getStream();
 
        return (string) $this->file_delivery->buildTokenURL(
            $stream,
            $filename ?? $revision->getTitle(),
            Disposition::INLINE,
            $GLOBALS['ilUser']->getId() ?? 0,
            (int) (ceil($valid_for_at_least_minutes / 60))
        );
    }

getRevisionURLWithoutIsolation()

ilSecureTokenSrcBuilder::getRevisionURLWithoutIsolation	(	Revision	$revision,
		float	$valid_for_at_least_minutes = 60.0,
		?string	$filename = null
	)

Deprecated:

see {

See also

SrcBuilder::getRevisionURLWithoutIsolation()}

Implements ILIAS\ResourceStorage\Consumer\SrcBuilder.

Definition at line 61 of file class.ilSecureTokenSrcBuilder.php.

     : string {
        return (string) $this->file_delivery->buildTokenURLWithoutIsolation(
            $revision->maybeStreamResolver()?->getStream(),
            $filename ?? $revision->getTitle(),
            Disposition::INLINE,
            $GLOBALS['ilUser']->getId() ?? 0,
            (int) (ceil($valid_for_at_least_minutes / 60))
        );
    }

Field Documentation

$inline

InlineSrcBuilder ilSecureTokenSrcBuilder::$inline

private

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

---

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

• components/ILIAS/FileDelivery/classes/class.ilSecureTokenSrcBuilder.php